addKeyguardLockedStateListener

public void addKeyguardLockedStateListener (Executor executor, 
                KeyguardManager.KeyguardLockedStateListener listener)

Registers a listener to execute when the keyguard visibility changes.

Requires Manifest.permission.SUBSCRIBE_TO_KEYGUARD_LOCKED_STATE

createConfirmDeviceCredentialIntent

public Intent createConfirmDeviceCredentialIntent (CharSequence title, 
                CharSequence description)

This method was deprecated in API level 29.
see BiometricPrompt.Builder#setDeviceCredentialAllowed(boolean)

Get an intent to prompt the user to confirm credentials (pin, pattern, password or biometrics if enrolled) for the current user of the device. The caller is expected to launch this activity using Activity.startActivityForResult(Intent, int) and check for Activity.RESULT_OK if the user successfully completes the challenge.

Requires the PackageManager#FEATURE_SECURE_LOCK_SCREEN feature which can be detected using PackageManager.hasSystemFeature(String).

exitKeyguardSecurely

public void exitKeyguardSecurely (KeyguardManager.OnKeyguardExitResult callback)

This method was deprecated in API level 15.
Use LayoutParams#FLAG_DISMISS_KEYGUARD and/or LayoutParams#FLAG_SHOW_WHEN_LOCKED instead; this allows you to seamlessly hide the keyguard as your application moves in and out of the foreground and does not require that any special permissions be requested.

Exit the keyguard securely. The use case for this api is that, after disabling the keyguard, your app, which was granted permission to disable the keyguard and show a limited amount of information deemed safe without the user getting past the keyguard, needs to navigate to something that is not safe to view without getting past the keyguard.

This will, if the keyguard is secure, bring up the unlock screen of the keyguard.

Requires Manifest.permission.DISABLE_KEYGUARD

inKeyguardRestrictedInputMode

public boolean inKeyguardRestrictedInputMode ()

This method was deprecated in API level 28.
Use isKeyguardLocked() instead.

If keyguard screen is showing or in restricted key input mode (i.e. in keyguard password emergency screen). When in such mode, certain keys, such as the Home key and the right soft keys, don't work.

isDeviceLocked

public boolean isDeviceLocked ()

Returns whether the device is currently locked and requires a PIN, pattern or password to unlock.

isDeviceSecure

public boolean isDeviceSecure ()

Returns whether the device is secured with a PIN, pattern or password.

See also isKeyguardSecure() which treats SIM locked states as secure.

isKeyguardLocked

public boolean isKeyguardLocked ()

Return whether the keyguard is currently locked.

isKeyguardSecure

public boolean isKeyguardSecure ()

Return whether the keyguard is secured by a PIN, pattern or password or a SIM card is currently locked.

See also isDeviceSecure() which ignores SIM locked states.

newKeyguardLock

public KeyguardManager.KeyguardLock newKeyguardLock (String tag)

This method was deprecated in API level 15.
Use LayoutParams#FLAG_DISMISS_KEYGUARD and/or LayoutParams#FLAG_SHOW_WHEN_LOCKED instead; this allows you to seamlessly hide the keyguard as your application moves in and out of the foreground and does not require that any special permissions be requested.

Enables you to lock or unlock the keyguard. Get an instance of this class by calling Context.getSystemService(). This class is wrapped by KeyguardManager.

removeKeyguardLockedStateListener

public void removeKeyguardLockedStateListener (KeyguardManager.KeyguardLockedStateListener listener)

Unregisters a listener that executes when the keyguard visibility changes.
Requires Manifest.permission.SUBSCRIBE_TO_KEYGUARD_LOCKED_STATE

requestDismissKeyguard

public void requestDismissKeyguard (Activity activity, 
                KeyguardManager.KeyguardDismissCallback callback)

If the device is currently locked (see isKeyguardLocked(), requests the Keyguard to be dismissed.

If the Keyguard is not secure or the device is currently in a trusted state, calling this method will immediately dismiss the Keyguard without any user interaction.

If the Keyguard is secure and the device is not in a trusted state, this will bring up the UI so the user can enter their credentials.

If the value set for the Activity attr R.attr.turnScreenOn is true, the screen will turn on when the keyguard is dismissed.