java.lang.Object | |
↳ | android.app.admin.DevicePolicyManager |
Public interface for managing policies enforced on a device. Most clients
of this class must have published a DeviceAdminReceiver
that the user
has currently enabled.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | ACTION_ADD_DEVICE_ADMIN | Activity action: ask the user to add a new device administrator to the system. | |||||||||
String | ACTION_SET_NEW_PASSWORD | Activity action: have the user enter a new password. | |||||||||
String | EXTRA_ADD_EXPLANATION | An optional CharSequence providing additional explanation for why the admin is being added. | |||||||||
String | EXTRA_DEVICE_ADMIN | The ComponentName of the administrator component. | |||||||||
int | PASSWORD_QUALITY_ALPHABETIC | Constant for setPasswordQuality(ComponentName, int) : the user must have entered a
password containing at least alphabetic (or other symbol) characters. |
|||||||||
int | PASSWORD_QUALITY_ALPHANUMERIC | Constant for setPasswordQuality(ComponentName, int) : the user must have entered a
password containing at least both> numeric and
alphabetic (or other symbol) characters. |
|||||||||
int | PASSWORD_QUALITY_NUMERIC | Constant for setPasswordQuality(ComponentName, int) : the user must have entered a
password containing at least numeric characters. |
|||||||||
int | PASSWORD_QUALITY_SOMETHING | Constant for setPasswordQuality(ComponentName, int) : the policy requires some kind
of password, but doesn't care what it is. |
|||||||||
int | PASSWORD_QUALITY_UNSPECIFIED | Constant for setPasswordQuality(ComponentName, int) : the policy has no requirements
for the password. |
|||||||||
int | RESET_PASSWORD_REQUIRE_ENTRY | Flag for resetPassword(String, int) : don't allow other admins to change
the password again until the user has entered it. |
|||||||||
int | WIPE_EXTERNAL_STORAGE | Flag for wipeData(int) : also erase the device's external
storage. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Return a list of all currently active device administrator's component
names.
| |||||||||||
Retrieve the number of times the user has failed at entering a
password since that last successful password entry.
| |||||||||||
Retrieve the current maximum number of login attempts that are allowed
before the device wipes itself, for all admins
or a particular one.
| |||||||||||
Retrieve the current maximum time to unlock for all admins
or a particular one.
| |||||||||||
Return the maximum password length that the device supports for a
particular password quality.
| |||||||||||
Retrieve the current minimum password length for all admins
or a particular one.
| |||||||||||
Retrieve the current minimum password quality for all admins
or a particular one.
| |||||||||||
Determine whether the current password the user has set is sufficient
to meet the policy requirements (quality, minimum length) that have been
requested.
| |||||||||||
Return true if the given administrator component is currently
active (enabled) in the system.
| |||||||||||
Make the device lock immediately, as if the lock screen timeout has
expired at the point of this call.
| |||||||||||
Remove a current administration component.
| |||||||||||
Force a new device unlock password (the password needed to access the
entire device, not for individual accounts) on the user.
| |||||||||||
Setting this to a value greater than zero enables a built-in policy
that will perform a device wipe after too many incorrect
device-unlock passwords have been entered.
| |||||||||||
Called by an application that is administering the device to set the
maximum time for user activity until the device will lock.
| |||||||||||
Called by an application that is administering the device to set the
minimum allowed password length.
| |||||||||||
Called by an application that is administering the device to set the
password restrictions it is imposing.
| |||||||||||
Ask the user date be wiped.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Activity action: ask the user to add a new device administrator to the system.
The desired policy is the ComponentName of the policy in the
EXTRA_DEVICE_ADMIN
extra field. This will invoke a UI to
bring the user through adding the device administrator to the system (or
allowing them to reject it).
You can optionally include the EXTRA_ADD_EXPLANATION
field to provide the user with additional explanation (in addition
to your component's description) about what is being added.
Activity action: have the user enter a new password. This activity
should be launched after using setPasswordQuality(ComponentName, int)
or setPasswordMinimumLength(ComponentName, int)
to have the
user enter a new password that meets the current requirements. You can
use isActivePasswordSufficient()
to determine whether you need
to have the user select a new password in order to meet the current
constraints. Upon being resumed from this activity,
you can check the new password characteristics to see if they are
sufficient.
An optional CharSequence providing additional explanation for why the admin is being added.
The ComponentName of the administrator component.
Constant for setPasswordQuality(ComponentName, int)
: the user must have entered a
password containing at least alphabetic (or other symbol) characters.
Note that quality constants are ordered so that higher values are more
restrictive.
Constant for setPasswordQuality(ComponentName, int)
: the user must have entered a
password containing at least both> numeric and
alphabetic (or other symbol) characters. Note that quality constants are
ordered so that higher values are more restrictive.
Constant for setPasswordQuality(ComponentName, int)
: the user must have entered a
password containing at least numeric characters. Note that quality
constants are ordered so that higher values are more restrictive.
Constant for setPasswordQuality(ComponentName, int)
: the policy requires some kind
of password, but doesn't care what it is. Note that quality constants
are ordered so that higher values are more restrictive.
Constant for setPasswordQuality(ComponentName, int)
: the policy has no requirements
for the password. Note that quality constants are ordered so that higher
values are more restrictive.
Flag for resetPassword(String, int)
: don't allow other admins to change
the password again until the user has entered it.
Flag for wipeData(int)
: also erase the device's external
storage.
Return a list of all currently active device administrator's component names. Note that if there are no administrators than null may be returned.
Retrieve the number of times the user has failed at entering a password since that last successful password entry.
The calling device admin must have requested
USES_POLICY_WATCH_LOGIN
to be able to call
this method; if it has not, a security exception will be thrown.
Retrieve the current maximum number of login attempts that are allowed before the device wipes itself, for all admins or a particular one.
admin | The name of the admin component to check, or null to aggregate all admins. |
---|
Retrieve the current maximum time to unlock for all admins or a particular one.
admin | The name of the admin component to check, or null to aggregate all admins. |
---|
Return the maximum password length that the device supports for a particular password quality.
quality | The quality being interrogated. |
---|
Retrieve the current minimum password length for all admins or a particular one.
admin | The name of the admin component to check, or null to aggregate all admins. |
---|
Retrieve the current minimum password quality for all admins or a particular one.
admin | The name of the admin component to check, or null to aggregate all admins. |
---|
Determine whether the current password the user has set is sufficient to meet the policy requirements (quality, minimum length) that have been requested.
The calling device admin must have requested
USES_POLICY_LIMIT_PASSWORD
to be able to call
this method; if it has not, a security exception will be thrown.
Return true if the given administrator component is currently active (enabled) in the system.
Make the device lock immediately, as if the lock screen timeout has expired at the point of this call.
The calling device admin must have requested
USES_POLICY_FORCE_LOCK
to be able to call
this method; if it has not, a security exception will be thrown.
Remove a current administration component. This can only be called by the application that owns the administration component; if you try to remove someone else's component, a security exception will be thrown.
Force a new device unlock password (the password needed to access the
entire device, not for individual accounts) on the user. This takes
effect immediately.
The given password must be sufficient for the
current password quality and length constraints as returned by
getPasswordQuality(ComponentName)
and
getPasswordMinimumLength(ComponentName)
; if it does not meet
these constraints, then it will be rejected and false returned. Note
that the password may be a stronger quality (containing alphanumeric
characters when the requested quality is only numeric), in which case
the currently active quality will be increased to match.
The calling device admin must have requested
USES_POLICY_RESET_PASSWORD
to be able to call
this method; if it has not, a security exception will be thrown.
password | The new password for the user. |
---|---|
flags | May be 0 or RESET_PASSWORD_REQUIRE_ENTRY . |
Setting this to a value greater than zero enables a built-in policy
that will perform a device wipe after too many incorrect
device-unlock passwords have been entered. This built-in policy combines
watching for failed passwords and wiping the device, and requires
that you request both USES_POLICY_WATCH_LOGIN
and
USES_POLICY_WIPE_DATA
}.
To implement any other policy (e.g. wiping data for a particular
application only, erasing or revoking credentials, or reporting the
failure to a server), you should implement
onPasswordFailed(Context, android.content.Intent)
instead. Do not use this API, because if the maximum count is reached,
the device will be wiped immediately, and your callback will not be invoked.
admin | Which DeviceAdminReceiver this request is associated with. |
---|---|
num | The number of failed password attempts at which point the device will wipe its data. |
Called by an application that is administering the device to set the maximum time for user activity until the device will lock. This limits the length that the user can set. It takes effect immediately.
The calling device admin must have requested
USES_POLICY_FORCE_LOCK
to be able to call
this method; if it has not, a security exception will be thrown.
admin | Which DeviceAdminReceiver this request is associated with. |
---|---|
timeMs | The new desired maximum time to lock in milliseconds. A value of 0 means there is no restriction. |
Called by an application that is administering the device to set the
minimum allowed password length. After setting this, the user
will not be able to enter a new password that is not at least as
restrictive as what has been set. Note that the current password
will remain until the user has set a new one, so the change does not
take place immediately. To prompt the user for a new password, use
ACTION_SET_NEW_PASSWORD
after setting this value. This
constraint is only imposed if the administrator has also requested either
PASSWORD_QUALITY_NUMERIC
, PASSWORD_QUALITY_ALPHABETIC
,
or PASSWORD_QUALITY_ALPHANUMERIC
with setPasswordQuality(ComponentName, int)
.
The calling device admin must have requested
USES_POLICY_LIMIT_PASSWORD
to be able to call
this method; if it has not, a security exception will be thrown.
admin | Which DeviceAdminReceiver this request is associated with. |
---|---|
length | The new desired minimum password length. A value of 0 means there is no restriction. |
Called by an application that is administering the device to set the
password restrictions it is imposing. After setting this, the user
will not be able to enter a new password that is not at least as
restrictive as what has been set. Note that the current password
will remain until the user has set a new one, so the change does not
take place immediately. To prompt the user for a new password, use
ACTION_SET_NEW_PASSWORD
after setting this value.
Quality constants are ordered so that higher values are more restrictive; thus the highest requested quality constant (between the policy set here, the user's preference, and any other considerations) is the one that is in effect.
The calling device admin must have requested
USES_POLICY_LIMIT_PASSWORD
to be able to call
this method; if it has not, a security exception will be thrown.
admin | Which DeviceAdminReceiver this request is associated with. |
---|---|
quality | The new desired quality. One of
PASSWORD_QUALITY_UNSPECIFIED , PASSWORD_QUALITY_SOMETHING ,
PASSWORD_QUALITY_NUMERIC , PASSWORD_QUALITY_ALPHABETIC ,
or PASSWORD_QUALITY_ALPHANUMERIC .
|
Ask the user date be wiped. This will cause the device to reboot, erasing all user data while next booting up. External storage such as SD cards will not be erased.
The calling device admin must have requested
USES_POLICY_WIPE_DATA
to be able to call
this method; if it has not, a security exception will be thrown.
flags | Bit mask of additional options: currently must be 0. |
---|