Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.

KeyguardControllerState

public class KeyguardControllerState
extends Object

java.lang.Object
↳	com.android.tradefed.util.KeyguardControllerState

A container for the keyguard states. Inspired from ActivityManagerState.java.

Summary

Public methods
`static KeyguardControllerState`	`create( dump)` Creates and populate a `KeyguardControllerState` based on a dumpsys output from the KeyguardController.
`boolean`	`isKeyguardGoingAway()` Returns True if the keyguard is going away, false otherwise.
`boolean`	`isKeyguardOccluded()` Returns True if the keyguard is occluded, false otherwise.
`boolean`	`isKeyguardShowing()` Returns True if the keyguard is showing, false otherwise.

Public methods

create

public static KeyguardControllerState create ( dump)

Creates and populate a KeyguardControllerState based on a dumpsys output from the KeyguardController.

Parameters
`dump`	: output from the dumpsys activity activities

Returns
`KeyguardControllerState`	The `KeyguardControllerState` representing the output or null if invalid output is provided.

isKeyguardGoingAway

public boolean isKeyguardGoingAway ()

Returns True if the keyguard is going away, false otherwise.

Returns
`boolean`

isKeyguardOccluded

public boolean isKeyguardOccluded ()

Returns True if the keyguard is occluded, false otherwise.

Returns
`boolean`

isKeyguardShowing

public boolean isKeyguardShowing ()

Returns True if the keyguard is showing, false otherwise.

Returns
`boolean`