Stay organized with collections
Save and categorize content based on your preferences.
KeyguardManager.KeyguardLock
public
class
KeyguardManager.KeyguardLock
extends Object
This class was deprecated
in API level 15.
Use R.attr.showWhenLocked or Activity.setShowWhenLocked(boolean) instead. This allows you to seamlessly
occlude and unocclude the keyguard as your application moves in and out of the foreground
and does not require that any special permissions be requested.
Handle returned by KeyguardManager.newKeyguardLock that allows
you to temporarily disable / reenable the keyguard (lock screen).
Summary
Inherited methods |
|---|
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.
|
|
Public methods
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# KeyguardManager.KeyguardLock\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nDeprecated in [API level\n15](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nKeyguardManager.KeyguardLock\n============================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/app/KeyguardManager.KeyguardLock \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\n\n\nclass\nKeyguardManager.KeyguardLock\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|------------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.app.KeyguardManager.KeyguardLock |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\n\n**This class was deprecated\nin API level 15.** \n\nUse [R.attr.showWhenLocked](/reference/android/R.attr#showWhenLocked) or [Activity.setShowWhenLocked(boolean)](/reference/android/app/Activity#setShowWhenLocked(boolean)) instead. This allows you to seamlessly\nocclude and unocclude the keyguard as your application moves in and out of the foreground\nand does not require that any special permissions be requested.\n\nHandle returned by [KeyguardManager.newKeyguardLock](/reference/android/app/KeyguardManager#newKeyguardLock(java.lang.String)) that allows\nyou to temporarily disable / reenable the keyguard (lock screen).\n\nSummary\n-------\n\n| ### Public methods ||\n|---------|-------------------------------------------------------------------------------------------------------------------------------------|\n| ` void` | ` `[disableKeyguard](/reference/android/app/KeyguardManager.KeyguardLock#disableKeyguard())`() ` Disable the keyguard from showing. |\n| ` void` | ` `[reenableKeyguard](/reference/android/app/KeyguardManager.KeyguardLock#reenableKeyguard())`() ` Reenable the keyguard. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/reference/java/lang/Object#wait(long,%20int))`(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](/reference/java/lang/Object#wait(long))`(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](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic methods\n--------------\n\n### disableKeyguard\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic void disableKeyguard ()\n```\n\nDisable the keyguard from showing. If the keyguard is currently\nshowing, hide it. The keyguard will be prevented from showing again\nuntil [reenableKeyguard()](/reference/android/app/KeyguardManager.KeyguardLock#reenableKeyguard()) is called.\n\n\nThis only works if the keyguard is not secure.\n\n\nA good place to call this is from [Activity.onResume()](/reference/android/app/Activity#onResume())\n\n\u003cbr /\u003e\n\n\nRequires [Manifest.permission.DISABLE_KEYGUARD](/reference/android/Manifest.permission#DISABLE_KEYGUARD)\n\n\u003cbr /\u003e\n\n**See also:**\n\n- [KeyguardManager.isKeyguardSecure()](/reference/android/app/KeyguardManager#isKeyguardSecure())\n- [reenableKeyguard()](/reference/android/app/KeyguardManager.KeyguardLock#reenableKeyguard()) \n\n### reenableKeyguard\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic void reenableKeyguard ()\n```\n\nReenable the keyguard. The keyguard will reappear if the previous\ncall to [disableKeyguard()](/reference/android/app/KeyguardManager.KeyguardLock#disableKeyguard()) caused it to be hidden.\n\nA good place to call this is from [Activity.onPause()](/reference/android/app/Activity#onPause())\n\n\u003cbr /\u003e\n\n\nRequires [Manifest.permission.DISABLE_KEYGUARD](/reference/android/Manifest.permission#DISABLE_KEYGUARD)\n\n\u003cbr /\u003e\n\n**See also:**\n\n- [disableKeyguard()](/reference/android/app/KeyguardManager.KeyguardLock#disableKeyguard())"]]
