Added in API level 8

Summary: Constants | Ctors | Methods | Inherited Methods

DeviceAdminReceiver

Kotlin |Java

public class DeviceAdminReceiver
extends BroadcastReceiver

java.lang.Object
↳	android.content.BroadcastReceiver
	↳	android.app.admin.DeviceAdminReceiver

Base class for implementing a device administration component. This class provides a convenience for interpreting the raw intent actions that are sent by the system.

The callback methods, like the base BroadcastReceiver.onReceive() method, happen on the main thread of the process. Thus long running operations must be done on another thread. Note that because a receiver is done once returning from its receive function, such long-running operations should probably be done in a Service.

When publishing your DeviceAdmin subclass as a receiver, it must handle ACTION_DEVICE_ADMIN_ENABLED and require the Manifest.permission.BIND_DEVICE_ADMIN permission. A typical manifest entry would look like:

<receiver android:name=".app.DeviceAdminSample$DeviceAdminSampleReceiver"
        android:label="@string/sample_device_admin"
        android:description="@string/sample_device_admin_description"
        android:permission="android.permission.BIND_DEVICE_ADMIN">
    <meta-data android:name="android.app.device_admin"
               android:resource="@xml/device_admin_sample" />
    <intent-filter>
        <action android:name="android.app.action.DEVICE_ADMIN_ENABLED" />
    </intent-filter>
</receiver>
<receiver android:name=".app.DeviceAdminSample$DeviceAdminSampleReceiver2"
    android:label="@string/sample_device_admin2"
    android:description="@string/sample_device_admin_description2"
    android:permission="android.permission.BIND_DEVICE_ADMIN">
    <meta-data android:name="android.app.device_admin"
        android:resource="@xml/device_admin_sample" />
    <intent-filter>
        <action android:name="android.app.action.DEVICE_ADMIN_ENABLED" />
    </intent-filter>
</receiver>

The meta-data referenced here provides addition information specific to the device administrator, as parsed by the DeviceAdminInfo class. A typical file would be:

<device-admin xmlns:android="http://schemas.android.com/apk/res/android">
    <uses-policies>
        <limit-password />
        <watch-login />
        <reset-password />
        <force-lock />
        <wipe-data />
        <expire-password />
        <encrypted-storage />
        <disable-camera />
        <disable-keyguard-features />
    </uses-policies>
</device-admin>

Developer Guides

For more information about device administration, read the Device Administration developer guide.

Summary

Constants
`String`	`ACTION_CHOOSE_PRIVATE_KEY_ALIAS` Broadcast action: notify that some app is attempting to choose a KeyChain key.
`String`	`ACTION_DEVICE_ADMIN_DISABLED` Action sent to a device administrator when the user has disabled it.
`String`	`ACTION_DEVICE_ADMIN_DISABLE_REQUESTED` Action sent to a device administrator when the user has requested to disable it, but before this has actually been done.
`String`	`ACTION_DEVICE_ADMIN_ENABLED` This is the primary action that a device administrator must implement to be allowed to manage a device.
`String`	`ACTION_LOCK_TASK_ENTERING` Action sent to a device administrator to notify that the device is entering lock task mode.
`String`	`ACTION_LOCK_TASK_EXITING` Action sent to a device administrator to notify that the device is exiting lock task mode.
`String`	`ACTION_NETWORK_LOGS_AVAILABLE` Broadcast action: notify that a new batch of network logs is ready to be collected.
`String`	`ACTION_PASSWORD_CHANGED` Action sent to a device administrator when the user has changed the password of their device or profile challenge.
`String`	`ACTION_PASSWORD_EXPIRING` Action periodically sent to a device administrator when the device or profile challenge password is expiring.
`String`	`ACTION_PASSWORD_FAILED` Action sent to a device administrator when the user has entered an incorrect device or profile challenge password.
`String`	`ACTION_PASSWORD_SUCCEEDED` Action sent to a device administrator when the user has successfully entered their device or profile challenge password, after failing one or more times.
`String`	`ACTION_PROFILE_PROVISIONING_COMPLETE` Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile or managed device has completed successfully.
`String`	`ACTION_SECURITY_LOGS_AVAILABLE` Broadcast action: notify that a new batch of security logs is ready to be collected.
`int`	`BUGREPORT_FAILURE_FAILED_COMPLETING` Bugreport completion process failed.
`int`	`BUGREPORT_FAILURE_FILE_NO_LONGER_AVAILABLE` Bugreport has been created, but is no longer available for collection.
`String`	`DEVICE_ADMIN_META_DATA` Name under which a DevicePolicy component publishes information about itself.
`String`	`EXTRA_DISABLE_WARNING` A CharSequence that can be shown to the user informing them of the impact of disabling your admin.
`String`	`EXTRA_LOCK_TASK_PACKAGE` A string containing the name of the package entering lock task mode.
`String`	`EXTRA_TRANSFER_OWNERSHIP_ADMIN_EXTRAS_BUNDLE` A `Parcelable` extra of type `PersistableBundle` that allows a mobile device management application to pass data to the management application instance after owner transfer.

Public constructors
`DeviceAdminReceiver()`

Public methods
`DevicePolicyManager`	`getManager(Context context)` Retrieve the DevicePolicyManager interface for this administrator to work with the system.
`ComponentName`	`getWho(Context context)` Retrieve the ComponentName describing who this device administrator is, for use in `DevicePolicyManager` APIs that require the administrator to identify itself.
`void`	`onBugreportFailed(Context context, Intent intent, int failureCode)` Called when the bugreport collection flow has failed.
`void`	`onBugreportShared(Context context, Intent intent, String bugreportHash)` Called when the bugreport has been shared with the device administrator app.
`void`	`onBugreportSharingDeclined(Context context, Intent intent)` Called when sharing a bugreport has been cancelled by the user of the device.
`String`	`onChoosePrivateKeyAlias(Context context, Intent intent, int uid, Uri uri, String alias)` Allows this receiver to select the alias for a private key and certificate pair for authentication.
`void`	`onComplianceAcknowledgementRequired(Context context, Intent intent)` Called to notify a profile owner of an organization-owned device that it needs to acknowledge device compliance to allow the user to turn the profile off if needed according to the maximum profile time off policy.
`CharSequence`	`onDisableRequested(Context context, Intent intent)` Called when the user has asked to disable the administrator, as a result of receiving `ACTION_DEVICE_ADMIN_DISABLE_REQUESTED`, giving you a chance to present a warning message to them.
`void`	`onDisabled(Context context, Intent intent)` Called prior to the administrator being disabled, as a result of receiving `ACTION_DEVICE_ADMIN_DISABLED`.
`void`	`onEnabled(Context context, Intent intent)` Called after the administrator is first enabled, as a result of receiving `ACTION_DEVICE_ADMIN_ENABLED`.
`void`	`onLockTaskModeEntering(Context context, Intent intent, String pkg)` Called when a device is entering lock task mode.
`void`	`onLockTaskModeExiting(Context context, Intent intent)` Called when a device is exiting lock task mode.
`void`	`onNetworkLogsAvailable(Context context, Intent intent, long batchToken, int networkLogsCount)` Called each time a new batch of network logs can be retrieved.
`void`	`onOperationSafetyStateChanged(Context context, int reason, boolean isSafe)` Called to notify the state of operations that can be unsafe to execute has changed.
`void`	`onPasswordChanged(Context context, Intent intent, UserHandle user)` Called after the user has changed their device or profile challenge password, as a result of receiving `ACTION_PASSWORD_CHANGED`.
`void`	`onPasswordChanged(Context context, Intent intent)` This method was deprecated in API level 26. From `Build.VERSION_CODES.O`, use `onPasswordChanged(android.content.Context, android.content.Intent, android.os.UserHandle)` instead.
`void`	`onPasswordExpiring(Context context, Intent intent)` This method was deprecated in API level 26. From `Build.VERSION_CODES.O`, use `onPasswordExpiring(android.content.Context, android.content.Intent, android.os.UserHandle)` instead.
`void`	`onPasswordExpiring(Context context, Intent intent, UserHandle user)` Called periodically when the device or profile challenge password is about to expire or has expired.
`void`	`onPasswordFailed(Context context, Intent intent, UserHandle user)` Called after the user has failed at entering their device or profile challenge password, as a result of receiving `ACTION_PASSWORD_FAILED`.
`void`	`onPasswordFailed(Context context, Intent intent)` This method was deprecated in API level 26. From `Build.VERSION_CODES.O`, use `onPasswordFailed(android.content.Context, android.content.Intent, android.os.UserHandle)` instead.
`void`	`onPasswordSucceeded(Context context, Intent intent)` This method was deprecated in API level 26. From `Build.VERSION_CODES.O`, use `onPasswordSucceeded(android.content.Context, android.content.Intent, android.os.UserHandle)` instead.
`void`	`onPasswordSucceeded(Context context, Intent intent, UserHandle user)` Called after the user has succeeded at entering their device or profile challenge password, as a result of receiving `ACTION_PASSWORD_SUCCEEDED`.
`void`	`onProfileProvisioningComplete(Context context, Intent intent)` Called when provisioning of a managed profile or managed device has completed successfully.
`void`	`onReadyForUserInitialization(Context context, Intent intent)` This method was deprecated in API level 24. Do not use
`void`	`onReceive(Context context, Intent intent)` Intercept standard device administrator broadcasts.
`void`	`onSecurityLogsAvailable(Context context, Intent intent)` Called when a new batch of security logs can be retrieved.
`void`	`onSystemUpdatePending(Context context, Intent intent, long receivedTime)` Called when the information about a pending system update is available.
`void`	`onTransferAffiliatedProfileOwnershipComplete(Context context, UserHandle user)` Called on the device owner when the ownership of one of its affiliated profiles is transferred.
`void`	`onTransferOwnershipComplete(Context context, PersistableBundle bundle)` Called on the newly assigned owner (either device owner or profile owner) when the ownership transfer has completed successfully.
`void`	`onUserAdded(Context context, Intent intent, UserHandle addedUser)` Called when a user or profile is created.
`void`	`onUserRemoved(Context context, Intent intent, UserHandle removedUser)` Called when a user or profile is removed.
`void`	`onUserStarted(Context context, Intent intent, UserHandle startedUser)` Called when a user or profile is started.
`void`	`onUserStopped(Context context, Intent intent, UserHandle stoppedUser)` Called when a user or profile is stopped.
`void`	`onUserSwitched(Context context, Intent intent, UserHandle switchedUser)` Called when a user or profile is switched to.

Inherited methods

From class


        
          android.content.BroadcastReceiver

`final void`	`abortBroadcast()` Sets the flag indicating that this receiver should abort the current broadcast; only works with broadcasts sent through `Context.sendOrderedBroadcast`.
`final void`	`clearAbortBroadcast()` Clears the flag indicating that this receiver should abort the current broadcast.
`final boolean`	`getAbortBroadcast()` Returns the flag indicating whether or not this receiver should abort the current broadcast.
`final boolean`	`getDebugUnregister()` Return the last value given to `setDebugUnregister(boolean)`.
`final int`	`getResultCode()` Retrieve the current result code, as set by the previous receiver.
`final String`	`getResultData()` Retrieve the current result data, as set by the previous receiver.
`final Bundle`	`getResultExtras(boolean makeMap)` Retrieve the current result extra data, as set by the previous receiver.
`String`	`getSentFromPackage()` Returns the package name of the app that initially sent this broadcast.
`int`	`getSentFromUid()` Returns the uid of the app that initially sent this broadcast.
`final BroadcastReceiver.PendingResult`	`goAsync()` This can be called by an application in `onReceive(Context, Intent)` to allow it to keep the broadcast active after returning from that function.
`final boolean`	`isInitialStickyBroadcast()` Returns true if the receiver is currently processing the initial value of a sticky broadcast -- that is, the value that was last broadcast and is currently held in the sticky cache, so this is not directly the result of a broadcast right now.
`final boolean`	`isOrderedBroadcast()` Returns true if the receiver is currently processing an ordered broadcast.
`abstract void`	`onReceive(Context context, Intent intent)` This method is called when the BroadcastReceiver is receiving an Intent broadcast.
`IBinder`	`peekService(Context myContext, Intent service)` Provide a binder to an already-bound service.
`final void`	`setDebugUnregister(boolean debug)` Control inclusion of debugging help for mismatched calls to `Context.registerReceiver()`.
`final void`	`setOrderedHint(boolean isOrdered)` For internal use, sets the hint about whether this BroadcastReceiver is running in ordered mode.
`final void`	`setResult(int code, String data, Bundle extras)` Change all of the result data returned from this broadcasts; only works with broadcasts sent through `Context.sendOrderedBroadcast`.
`final void`	`setResultCode(int code)` Change the current result code of this broadcast; only works with broadcasts sent through `Context.sendOrderedBroadcast`.
`final void`	`setResultData(String data)` Change the current result data of this broadcast; only works with broadcasts sent through `Context.sendOrderedBroadcast`.
`final void`	`setResultExtras(Bundle extras)` Change the current result extras of this broadcast; only works with broadcasts sent through `Context.sendOrderedBroadcast`.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

ACTION_CHOOSE_PRIVATE_KEY_ALIAS

Added in API level 29

public static final String ACTION_CHOOSE_PRIVATE_KEY_ALIAS

Broadcast action: notify that some app is attempting to choose a KeyChain key.

See also:

Constant Value: "android.app.action.CHOOSE_PRIVATE_KEY_ALIAS"

ACTION_DEVICE_ADMIN_DISABLED

Added in API level 8

public static final String ACTION_DEVICE_ADMIN_DISABLED

Action sent to a device administrator when the user has disabled it. Upon return, the application no longer has access to the protected device policy manager APIs. You will generally handle this in DeviceAdminReceiver#onDisabled(Context, Intent). Note that this action will be sent the receiver regardless of whether it is explicitly listed in its intent filter.

Constant Value: "android.app.action.DEVICE_ADMIN_DISABLED"

ACTION_DEVICE_ADMIN_DISABLE_REQUESTED

Added in API level 8

public static final String ACTION_DEVICE_ADMIN_DISABLE_REQUESTED

Action sent to a device administrator when the user has requested to disable it, but before this has actually been done. This gives you a chance to supply a message to the user about the impact of disabling your admin, by setting the extra field EXTRA_DISABLE_WARNING in the result Intent. If not set, no warning will be displayed. If set, the given text will be shown to the user before they disable your admin.

Constant Value: "android.app.action.DEVICE_ADMIN_DISABLE_REQUESTED"

ACTION_DEVICE_ADMIN_ENABLED

Added in API level 8

public static final String ACTION_DEVICE_ADMIN_ENABLED

This is the primary action that a device administrator must implement to be allowed to manage a device. This will be set to the receiver when the user enables it for administration. You will generally handle this in DeviceAdminReceiver#onEnabled(Context, Intent). To be supported, the receiver must also require the Manifest.permission.BIND_DEVICE_ADMIN permission so that other applications can not abuse it.

Constant Value: "android.app.action.DEVICE_ADMIN_ENABLED"

ACTION_LOCK_TASK_ENTERING

Added in API level 21

public static final String ACTION_LOCK_TASK_ENTERING

Action sent to a device administrator to notify that the device is entering lock task mode. The extra EXTRA_LOCK_TASK_PACKAGE will describe the package using lock task mode.

The calling device admin must be the device owner or profile owner to receive this broadcast.

See also:

DevicePolicyManager.isLockTaskPermitted(String)

Constant Value: "android.app.action.LOCK_TASK_ENTERING"

ACTION_LOCK_TASK_EXITING

Added in API level 21

public static final String ACTION_LOCK_TASK_EXITING

Action sent to a device administrator to notify that the device is exiting lock task mode.

The calling device admin must be the device owner or profile owner to receive this broadcast.

See also:

DevicePolicyManager.isLockTaskPermitted(String)

Constant Value: "android.app.action.LOCK_TASK_EXITING"

ACTION_NETWORK_LOGS_AVAILABLE

Added in API level 29

public static final String ACTION_NETWORK_LOGS_AVAILABLE

Broadcast action: notify that a new batch of network logs is ready to be collected.

See also:

Constant Value: "android.app.action.NETWORK_LOGS_AVAILABLE"

ACTION_PASSWORD_CHANGED

Added in API level 8

public static final String ACTION_PASSWORD_CHANGED

Action sent to a device administrator when the user has changed the password of their device or profile challenge. You can at this point check the characteristics of the new password with DevicePolicyManager.isActivePasswordSufficient(). You will generally handle this in DeviceAdminReceiver#onPasswordChanged(Context, Intent, UserHandle).

The calling device admin must have requested DeviceAdminInfo#USES_POLICY_LIMIT_PASSWORD to receive this broadcast.

Constant Value: "android.app.action.ACTION_PASSWORD_CHANGED"

ACTION_PASSWORD_EXPIRING

Added in API level 11

public static final String ACTION_PASSWORD_EXPIRING

Action periodically sent to a device administrator when the device or profile challenge password is expiring. You will generally handle this in DeviceAdminReceiver#onPasswordExpiring(Context, Intent, UserHandle).

The calling device admin must have requested DeviceAdminInfo#USES_POLICY_EXPIRE_PASSWORD to receive this broadcast.

Constant Value: "android.app.action.ACTION_PASSWORD_EXPIRING"

ACTION_PASSWORD_FAILED

Added in API level 8

public static final String ACTION_PASSWORD_FAILED

Action sent to a device administrator when the user has entered an incorrect device or profile challenge password. You can at this point check the number of failed password attempts there have been with DevicePolicyManager.getCurrentFailedPasswordAttempts(). You will generally handle this in DeviceAdminReceiver#onPasswordFailed(Context, Intent, UserHandle).

The calling device admin must have requested DeviceAdminInfo#USES_POLICY_WATCH_LOGIN to receive this broadcast.

Constant Value: "android.app.action.ACTION_PASSWORD_FAILED"

ACTION_PASSWORD_SUCCEEDED

Added in API level 8

public static final String ACTION_PASSWORD_SUCCEEDED

Action sent to a device administrator when the user has successfully entered their device or profile challenge password, after failing one or more times. You will generally handle this in DeviceAdminReceiver#onPasswordSucceeded(Context, Intent, UserHandle).

The calling device admin must have requested DeviceAdminInfo#USES_POLICY_WATCH_LOGIN to receive this broadcast.

Constant Value: "android.app.action.ACTION_PASSWORD_SUCCEEDED"

ACTION_PROFILE_PROVISIONING_COMPLETE

Added in API level 21

public static final String ACTION_PROFILE_PROVISIONING_COMPLETE

Broadcast Action: This broadcast is sent to indicate that provisioning of a managed profile or managed device has completed successfully.

The broadcast is limited to the profile that will be managed by the application that requested provisioning. In the device owner case the profile is the primary user. The broadcast will also be limited to the DeviceAdminReceiver component specified in the original intent or NFC bump that started the provisioning process (see DevicePolicyManager.ACTION_PROVISION_MANAGED_PROFILE).

A device admin application which listens to this intent can find out if the device was provisioned for the device owner or profile owner case by calling respectively DevicePolicyManager.isDeviceOwnerApp(String) and DevicePolicyManager.isProfileOwnerApp(String). You will generally handle this in DeviceAdminReceiver#onProfileProvisioningComplete.

The intent for this action may include the following extras:

DevicePolicyManager#EXTRA_PROVISIONING_ADMIN_EXTRAS_BUNDLE
See also:
- DevicePolicyManager.ACTION_PROVISIONING_SUCCESSFUL
Constant Value: "android.app.action.PROFILE_PROVISIONING_COMPLETE"

ACTION_SECURITY_LOGS_AVAILABLE

Added in API level 31

public static final String ACTION_SECURITY_LOGS_AVAILABLE

Broadcast action: notify that a new batch of security logs is ready to be collected.

Constant Value: "android.app.action.SECURITY_LOGS_AVAILABLE"

BUGREPORT_FAILURE_FAILED_COMPLETING

Added in API level 24

public static final int BUGREPORT_FAILURE_FAILED_COMPLETING

Bugreport completion process failed.

If this error code is received, the requesting of bugreport can be retried.

See also:

DevicePolicyManager.requestBugreport(ComponentName)

Constant Value: 0 (0x00000000)

BUGREPORT_FAILURE_FILE_NO_LONGER_AVAILABLE

Added in API level 24

public static final int BUGREPORT_FAILURE_FILE_NO_LONGER_AVAILABLE

Bugreport has been created, but is no longer available for collection.

This error likely occurs because the user of the device hasn't consented to share the bugreport for a long period after its creation.

If this error code is received, the requesting of bugreport can be retried.

See also:

DevicePolicyManager.requestBugreport(ComponentName)

Constant Value: 1 (0x00000001)

DEVICE_ADMIN_META_DATA

Added in API level 8

public static final String DEVICE_ADMIN_META_DATA

Name under which a DevicePolicy component publishes information about itself. This meta-data must reference an XML resource containing a device-admin tag.

Constant Value: "android.app.device_admin"

EXTRA_DISABLE_WARNING

Added in API level 8

public static final String EXTRA_DISABLE_WARNING

A CharSequence that can be shown to the user informing them of the impact of disabling your admin.

See also:

ACTION_DEVICE_ADMIN_DISABLE_REQUESTED

Constant Value: "android.app.extra.DISABLE_WARNING"

EXTRA_LOCK_TASK_PACKAGE

Added in API level 21

public static final String EXTRA_LOCK_TASK_PACKAGE

A string containing the name of the package entering lock task mode.

See also:

ACTION_LOCK_TASK_ENTERING

Constant Value: "android.app.extra.LOCK_TASK_PACKAGE"

EXTRA_TRANSFER_OWNERSHIP_ADMIN_EXTRAS_BUNDLE

Added in API level 28

public static final String EXTRA_TRANSFER_OWNERSHIP_ADMIN_EXTRAS_BUNDLE

A Parcelable extra of type PersistableBundle that allows a mobile device management application to pass data to the management application instance after owner transfer.

If the transfer is successful, the new owner receives the data in DeviceAdminReceiver#onTransferOwnershipComplete(Context, PersistableBundle). The bundle is not changed during the ownership transfer.

See also:

DevicePolicyManager.transferOwnership(ComponentName, ComponentName, PersistableBundle)

Constant Value: "android.app.extra.TRANSFER_OWNERSHIP_ADMIN_EXTRAS_BUNDLE"

Public constructors

DeviceAdminReceiver

public DeviceAdminReceiver ()

Public methods

getManager

Added in API level 8

public DevicePolicyManager getManager (Context context)

Retrieve the DevicePolicyManager interface for this administrator to work with the system.

Parameters
`context`	`Context`: This value cannot be `null`.

Returns
`DevicePolicyManager`	This value cannot be `null`.

getWho

Added in API level 8

public ComponentName getWho (Context context)

Retrieve the ComponentName describing who this device administrator is, for use in DevicePolicyManager APIs that require the administrator to identify itself.

Parameters
`context`	`Context`: This value cannot be `null`.

Returns
`ComponentName`	This value cannot be `null`.

onBugreportFailed

Added in API level 24

public void onBugreportFailed (Context context, 
                Intent intent, 
                int failureCode)

Called when the bugreport collection flow has failed.

This callback is only applicable to device owners.

Parameters
`context`	`Context`: The running context as per `onReceive(Context, Intent)`. This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. This value cannot be `null`.
`failureCode`	`int`: int containing failure code. One of `BUGREPORT_FAILURE_FAILED_COMPLETING` or `BUGREPORT_FAILURE_FILE_NO_LONGER_AVAILABLE` Value is `BUGREPORT_FAILURE_FAILED_COMPLETING`, or `BUGREPORT_FAILURE_FILE_NO_LONGER_AVAILABLE`

See also:

DevicePolicyManager.requestBugreport(ComponentName)

onBugreportShared

Added in API level 24

public void onBugreportShared (Context context, 
                Intent intent, 
                String bugreportHash)

Called when the bugreport has been shared with the device administrator app.

This callback is only applicable to device owners.

Parameters
`context`	`Context`: The running context as per `onReceive(Context, Intent)`. This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. Contains the URI of the bugreport file (with MIME type "application/vnd.android.bugreport"), that can be accessed by calling `Intent#getData()` This value cannot be `null`.
`bugreportHash`	`String`: SHA-256 hash of the bugreport file. This value cannot be `null`.

See also:

DevicePolicyManager.requestBugreport(ComponentName)

onBugreportSharingDeclined

Added in API level 24

public void onBugreportSharingDeclined (Context context, 
                Intent intent)

Called when sharing a bugreport has been cancelled by the user of the device.

This callback is only applicable to device owners.

Parameters
`context`	`Context`: The running context as per `onReceive(Context, Intent)`. This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. This value cannot be `null`.

See also:

DevicePolicyManager.requestBugreport(ComponentName)

onChoosePrivateKeyAlias

Added in API level 23

public String onChoosePrivateKeyAlias (Context context, 
                Intent intent, 
                int uid, 
                Uri uri, 
                String alias)

Allows this receiver to select the alias for a private key and certificate pair for authentication. If this method returns null, the default Activity will be shown that lets the user pick a private key and certificate pair. If this method returns KeyChain#KEY_ALIAS_SELECTION_DENIED, the default Activity will not be shown and the user will not be allowed to pick anything. And the app, that called KeyChain#choosePrivateKeyAlias, will receive null back.

Parameters
`context`	`Context`: The running context as per `onReceive(Context, Intent)`. This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. This value cannot be `null`.
`uid`	`int`: The uid of the app asking for the private key and certificate pair.
`uri`	`Uri`: The URI to authenticate, may be null.
`alias`	`String`: The alias preselected by the client, or null.

Returns
`String`	The private key alias to return and grant access to.

See also:

KeyChain.choosePrivateKeyAlias(Activity, KeyChainAliasCallback, String, Principal, Uri, String)

onComplianceAcknowledgementRequired

Added in API level 31

public void onComplianceAcknowledgementRequired (Context context, 
                Intent intent)

Called to notify a profile owner of an organization-owned device that it needs to acknowledge device compliance to allow the user to turn the profile off if needed according to the maximum profile time off policy. Default implementation acknowledges compliance immediately. DPC may prefer to override this implementation to delay acknowledgement until a successful policy sync. Until compliance is acknowledged the user is still free to turn the profile off, but the timer won't be reset, so personal apps will be suspended sooner. This callback is delivered using a foreground broadcast and should be handled quickly.

Parameters
`context`	`Context`: the running context as per `onReceive(Context, Intent)` This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. This value cannot be `null`.

See also:

onDisableRequested

Added in API level 8

public CharSequence onDisableRequested (Context context, 
                Intent intent)

Called when the user has asked to disable the administrator, as a result of receiving ACTION_DEVICE_ADMIN_DISABLE_REQUESTED, giving you a chance to present a warning message to them. The message is returned as the result; if null is returned (the default implementation), no message will be displayed.

Parameters
`context`	`Context`: The running context as per `onReceive(Context, Intent)`. This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. This value cannot be `null`.

Returns
`CharSequence`	Return the warning message to display to the user before being disabled; if null is returned, no message is displayed.

onDisabled

Added in API level 8

public void onDisabled (Context context, 
                Intent intent)

Called prior to the administrator being disabled, as a result of receiving ACTION_DEVICE_ADMIN_DISABLED. Upon return, you can no longer use the protected parts of the DevicePolicyManager API.

Parameters
`context`	`Context`: The running context as per `onReceive(Context, Intent)`. This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. This value cannot be `null`.

onEnabled

Added in API level 8

public void onEnabled (Context context, 
                Intent intent)

Called after the administrator is first enabled, as a result of receiving ACTION_DEVICE_ADMIN_ENABLED. At this point you can use DevicePolicyManager to set your desired policies.

If the admin is activated by a device owner, then the intent may contain private extras that are relevant to user setup.

Parameters
`context`	`Context`: The running context as per `onReceive(Context, Intent)`. This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. This value cannot be `null`.

See also:

DevicePolicyManager.createAndManageUser(ComponentName, String, ComponentName, PersistableBundle, int)

onLockTaskModeEntering

Added in API level 21

public void onLockTaskModeEntering (Context context, 
                Intent intent, 
                String pkg)

Called when a device is entering lock task mode.

Parameters
`context`	`Context`: The running context as per `onReceive(Context, Intent)`. This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. This value cannot be `null`.
`pkg`	`String`: The authorized package using lock task mode. This value cannot be `null`.

onLockTaskModeExiting

Added in API level 21

public void onLockTaskModeExiting (Context context, 
                Intent intent)

Called when a device is exiting lock task mode.

Parameters
`context`	`Context`: The running context as per `onReceive(Context, Intent)`. This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. This value cannot be `null`.

onNetworkLogsAvailable

Added in API level 26

public void onNetworkLogsAvailable (Context context, 
                Intent intent, 
                long batchToken, 
                int networkLogsCount)

Called each time a new batch of network logs can be retrieved. This callback method will only ever be called when network logging is enabled. The logs can only be retrieved while network logging is enabled.

If a secondary user or profile is created, this callback won't be received until all users become affiliated again (even if network logging is enabled). It will also no longer be possible to retrieve the network logs batch with the most recent batchToken provided by this callback. See DevicePolicyManager#setAffiliationIds.

This callback is only applicable to device owners and profile owners.

This callback is triggered by a foreground broadcast and the app should ensure that any long-running work is not executed synchronously inside the callback.

Parameters
`context`	`Context`: The running context as per `onReceive(Context, Intent)`. This value cannot be `null`.
`intent`	`Intent`: The received intent as per `onReceive(Context, Intent)`. This value cannot be `null`.
`batchToken`	`long`: The token representing the current batch of network logs.
`networkLogsCount`	`int`: The total count of events in the current batch of network logs. Value is 1 or greater

See also:

DevicePolicyManager.retrieveNetworkLogs(ComponentName, long)

onOperationSafetyStateChanged

Added in API level 31

public void onOperationSafetyStateChanged (Context context, 
                int reason, 
                boolean isSafe)

Called to notify the state of operations that can be unsafe to execute has changed.

Note:/b> notice that the operation safety state might change between the time this callback is received and the operation's method on DevicePolicyManager is called, so calls to the latter could still throw a UnsafeStateException even when this method is called with isSafe as true

Parameters

context Context: the running context as per onReceive(Context, Intent) This value cannot be null.

reason int: the reason an operation could be unsafe. Value is android.app.admin.DevicePolicyManager.OPERATION_SAFETY_REASON_NONE, or DevicePolicyManager.OPERATION_SAFETY_REASON_DRIVING_DISTRACTION

isSafe boolean: whether the operation is safe to be executed.

onPasswordChanged

Added in API level 26

public void onPasswordChanged (Context context, Intent intent, UserHandle user)

Called after the user has changed their device or profile challenge password, as a result of receiving ACTION_PASSWORD_CHANGED. At this point you can use DevicePolicyManager#getPasswordQuality(android.content.ComponentName) to retrieve the active password characteristics.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

user UserHandle: The user or profile for whom the password changed. To see whether this user is the current profile or a parent user, check for equality with Process#myUserHandle. This value cannot be null.

onPasswordChanged

Added in API level 8
Deprecated in API level 26

public void onPasswordChanged (Context context, Intent intent)

This method was deprecated in API level 26.
From Build.VERSION_CODES.O, use onPasswordChanged(android.content.Context, android.content.Intent, android.os.UserHandle) instead.

Called after the user has changed their device or profile challenge password, as a result of receiving ACTION_PASSWORD_CHANGED. At this point you can use DevicePolicyManager#getPasswordQuality(android.content.ComponentName) to retrieve the active password characteristics.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

onPasswordExpiring

Added in API level 11
Deprecated in API level 26

public void onPasswordExpiring (Context context, Intent intent)

This method was deprecated in API level 26.
From Build.VERSION_CODES.O, use onPasswordExpiring(android.content.Context, android.content.Intent, android.os.UserHandle) instead.

Called periodically when the device or profile challenge password is about to expire or has expired. It will typically be called at these times: on device boot, once per day before the password expires, and at the time when the password expires.
If the password is not updated by the user, this method will continue to be called once per day until the password is changed or the device admin disables password expiration.
The admin will typically post a notification requesting the user to change their password in response to this call. The actual password expiration time can be obtained by calling DevicePolicyManager#getPasswordExpiration(ComponentName)
The admin should be sure to take down any notifications it posted in response to this call when it receives DeviceAdminReceiver#onPasswordChanged(Context, Intent).

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

onPasswordExpiring

Added in API level 26

public void onPasswordExpiring (Context context, Intent intent, UserHandle user)

Called periodically when the device or profile challenge password is about to expire or has expired. It will typically be called at these times: on device boot, once per day before the password expires, and at the time when the password expires.
If the password is not updated by the user, this method will continue to be called once per day until the password is changed or the device admin disables password expiration.
The admin will typically post a notification requesting the user to change their password in response to this call. The actual password expiration time can be obtained by calling DevicePolicyManager#getPasswordExpiration(ComponentName)
The admin should be sure to take down any notifications it posted in response to this call when it receives DeviceAdminReceiver#onPasswordChanged(Context, Intent, UserHandle).

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

user UserHandle: The user or profile for whom the password is expiring. To see whether this user is the current profile or a parent user, check for equality with Process#myUserHandle. This value cannot be null.

onPasswordFailed

Added in API level 26

public void onPasswordFailed (Context context, Intent intent, UserHandle user)

Called after the user has failed at entering their device or profile challenge password, as a result of receiving ACTION_PASSWORD_FAILED. At this point you can use DevicePolicyManager#getCurrentFailedPasswordAttempts() to retrieve the number of failed password attempts.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

user UserHandle: The user or profile for whom the password check failed. To see whether this user is the current profile or a parent user, check for equality with Process#myUserHandle. This value cannot be null.

onPasswordFailed

Added in API level 8
Deprecated in API level 26

public void onPasswordFailed (Context context, Intent intent)

This method was deprecated in API level 26.
From Build.VERSION_CODES.O, use onPasswordFailed(android.content.Context, android.content.Intent, android.os.UserHandle) instead.

Called after the user has failed at entering their device or profile challenge password, as a result of receiving ACTION_PASSWORD_FAILED. At this point you can use DevicePolicyManager#getCurrentFailedPasswordAttempts() to retrieve the number of failed password attempts.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

onPasswordSucceeded

Added in API level 8
Deprecated in API level 26

public void onPasswordSucceeded (Context context, Intent intent)

This method was deprecated in API level 26.
From Build.VERSION_CODES.O, use onPasswordSucceeded(android.content.Context, android.content.Intent, android.os.UserHandle) instead.

Called after the user has succeeded at entering their device or profile challenge password, as a result of receiving ACTION_PASSWORD_SUCCEEDED. This will only be received the first time they succeed after having previously failed.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

onPasswordSucceeded

Added in API level 26

public void onPasswordSucceeded (Context context, Intent intent, UserHandle user)

Called after the user has succeeded at entering their device or profile challenge password, as a result of receiving ACTION_PASSWORD_SUCCEEDED. This will only be received the first time they succeed after having previously failed.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

user UserHandle: The user of profile for whom the password check succeeded. To see whether this user is the current profile or a parent user, check for equality with Process#myUserHandle. This value cannot be null.

onProfileProvisioningComplete

Added in API level 21

public void onProfileProvisioningComplete (Context context, Intent intent)

Called when provisioning of a managed profile or managed device has completed successfully.
As a prerequisite for the execution of this callback the DeviceAdminReceiver has to declare an intent filter for ACTION_PROFILE_PROVISIONING_COMPLETE. Its component must also be specified in the DevicePolicyManager#EXTRA_DEVICE_ADMIN of the DevicePolicyManager#ACTION_PROVISION_MANAGED_PROFILE intent that started the managed provisioning.
When provisioning of a managed profile is complete, the managed profile is hidden until the profile owner calls DevicePolicyManager#setProfileEnabled(ComponentName admin). Typically a profile owner will enable the profile when it has finished any additional setup such as adding an account by using the AccountManager and calling APIs to bring the profile into the desired state.
Note that provisioning completes without waiting for any server interactions, so the profile owner needs to wait for data to be available if required (e.g. Android device IDs or other data that is set as a result of server interactions).
From version Build.VERSION_CODES.O, when managed provisioning has completed, along with this callback the activity intent DevicePolicyManager#ACTION_PROVISIONING_SUCCESSFUL will also be sent to the same application.
The Intent may include any of the extras specified for ACTION_PROFILE_PROVISIONING_COMPLETE.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

onReadyForUserInitialization

Added in API level 23
Deprecated in API level 24

public void onReadyForUserInitialization (Context context, Intent intent)

This method was deprecated in API level 24.
Do not use

Called during provisioning of a managed device to allow the device initializer to perform user setup steps.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

onReceive

Added in API level 8

public void onReceive (Context context, Intent intent)

Intercept standard device administrator broadcasts. Implementations should not override this method; it is better to implement the convenience callbacks for each action.

Parameters

context Context: This value cannot be null.

intent Intent: This value cannot be null.

onSecurityLogsAvailable

Added in API level 24

public void onSecurityLogsAvailable (Context context, Intent intent)

Called when a new batch of security logs can be retrieved.
If a secondary user or profile is created, this callback won't be received until all users become affiliated again (even if security logging is enabled). See DevicePolicyManager#setAffiliationIds
This callback will be re-triggered if the logs are not retrieved.
This callback is only applicable to device owners and profile owners of organization-owned managed profiles.
This callback is triggered by a foreground broadcast and the app should ensure that any long-running work is not executed synchronously inside the callback.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

See also:

DevicePolicyManager.retrieveSecurityLogs(ComponentName)

onSystemUpdatePending

Added in API level 23

public void onSystemUpdatePending (Context context, Intent intent, long receivedTime)

Called when the information about a pending system update is available.
Allows the receiver to be notified when information about a pending system update is available from the system update service. The same pending system update can trigger multiple calls to this method, so it is necessary to examine the incoming parameters for details about the update.
This callback is only applicable to device owners and profile owners.
To get further information about a pending system update (for example, whether or not the update is a security patch), the device owner or profile owner can call DevicePolicyManager#getPendingSystemUpdate.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

receivedTime long: The time as given by System#currentTimeMillis() indicating when the current pending update was first available. -1 if no pending update is available.

See also:

DevicePolicyManager.getPendingSystemUpdate(ComponentName)

onTransferAffiliatedProfileOwnershipComplete

Added in API level 28

public void onTransferAffiliatedProfileOwnershipComplete (Context context, UserHandle user)

Called on the device owner when the ownership of one of its affiliated profiles is transferred.
This can be used when transferring both device and profile ownership when using work profile on a fully managed device. The process would look like this:

Transfer profile ownership

The device owner gets notified with this callback

Transfer device ownership

Both profile and device ownerships have been transferred

Parameters

context Context: the running context as per onReceive(Context, Intent) This value cannot be null.

user UserHandle: the UserHandle of the affiliated user This value cannot be null.

See also:

DevicePolicyManager.transferOwnership(ComponentName, ComponentName, PersistableBundle)

onTransferOwnershipComplete

Added in API level 28

public void onTransferOwnershipComplete (Context context, PersistableBundle bundle)

Called on the newly assigned owner (either device owner or profile owner) when the ownership transfer has completed successfully.
The bundle parameter allows the original owner to pass data to the new one.

Parameters

context Context: the running context as per onReceive(Context, Intent) This value cannot be null.

bundle PersistableBundle: the data to be passed to the new owner This value may be null.

onUserAdded

Added in API level 26

public void onUserAdded (Context context, Intent intent, UserHandle addedUser)

Called when a user or profile is created.
This callback is only applicable to device owners.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

addedUser UserHandle: The UserHandle of the user that has just been added. This value cannot be null.

onUserRemoved

Added in API level 26

public void onUserRemoved (Context context, Intent intent, UserHandle removedUser)

Called when a user or profile is removed.
This callback is only applicable to device owners.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

removedUser UserHandle: The UserHandle of the user that has just been removed. This value cannot be null.

onUserStarted

Added in API level 28

public void onUserStarted (Context context, Intent intent, UserHandle startedUser)

Called when a user or profile is started.
This callback is only applicable to device owners.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

startedUser UserHandle: The UserHandle of the user that has just been started. This value cannot be null.

onUserStopped

Added in API level 28

public void onUserStopped (Context context, Intent intent, UserHandle stoppedUser)

Called when a user or profile is stopped.
This callback is only applicable to device owners.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

stoppedUser UserHandle: The UserHandle of the user that has just been stopped. This value cannot be null.

onUserSwitched

Added in API level 28

public void onUserSwitched (Context context, Intent intent, UserHandle switchedUser)

Called when a user or profile is switched to.
This callback is only applicable to device owners.

Parameters

context Context: The running context as per onReceive(Context, Intent). This value cannot be null.

intent Intent: The received intent as per onReceive(Context, Intent). This value cannot be null.

switchedUser UserHandle: The UserHandle of the user that has just been switched to. This value cannot be null.

Parameters
`context`	`Context`: the running context as per `onReceive(Context, Intent)` This value cannot be `null`.
`reason`	`int`: the reason an operation could be unsafe. Value is android.app.admin.DevicePolicyManager.OPERATION_SAFETY_REASON_NONE, or `DevicePolicyManager.OPERATION_SAFETY_REASON_DRIVING_DISTRACTION`
`isSafe`	`boolean`: whether the operation is safe to be executed.

Parameters
`context`	`Context`: the running context as per `onReceive(Context, Intent)` This value cannot be `null`.
`user`	`UserHandle`: the `UserHandle` of the affiliated user This value cannot be `null`.

Parameters
`context`	`Context`: the running context as per `onReceive(Context, Intent)` This value cannot be `null`.
`bundle`	`PersistableBundle`: the data to be passed to the new owner This value may be `null`.