@ohos.screenLock (Screen Lock)

The screenlock module is a system module in OpenHarmony. It provides APIs for screen lock applications to subscribe to screen lock status changes as well as callbacks for them to receive the results. It also provides APIs for third-party applications to unlock the screen, obtain the screen locked status, and check whether a lock screen password has been set.

NOTE

The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import screenlock from '@ohos.screenLock';

EventType⁹⁺

Defines the system event type.

System capability: SystemCapability.MiscServices.ScreenLock

System API: This is a system API.

Event Type	Description
beginWakeUp	Wakeup starts.
endWakeUp	Wakeup ends.
beginScreenOn	Screen turn-on starts.
endScreenOn	Screen turn-on ends.
beginScreenOff	Screen turn-off starts.
endScreenOff	Screen turn-off ends.
unlockScreen	The screen is unlocked.
lockScreen	The screen is locked.
beginExitAnimation	Exit animation starts.
beginSleep	The device enters sleep mode.
endSleep	The device exits sleep mode.
changeUser	The user is switched.
screenlockEnabled	Screen lock is enabled.
serviceRestart	The screen lock service is restarted.

SystemEvent⁹⁺

Defines the structure of the system event callback.

System capability: SystemCapability.MiscServices.ScreenLock

System API: This is a system API.

Name	Type	Mandatory	Description
eventType	EventType	Yes	System event type.
params	string	Yes	System event parameters.

screenlock.isLocked⁹⁺

isLocked(): boolean

Checks whether the screen is locked.

System capability: SystemCapability.MiscServices.ScreenLock

System API: This is a system API.

Return value

Type	Description
boolean	Returns true if the screen is locked; returns false otherwise.

Example

let isLocked = screenlock.isLocked();

screenlock.unlock⁹⁺

unlock(callback: AsyncCallback<boolean>): void

Unlocks the screen. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.ScreenLock

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true means that the screen is unlocked successfully, and false means the opposite.

Example

screenlock.unlock((err, data) => {      
    if (err) {
        console.error(`Failed to unlock the screen, because: ${err.message}`);
        return;    
    }
    console.info(`unlock the screen successfully. result: ${data}`);
});

screenlock.unlock⁹⁺

unlock(): Promise<boolean>

Unlocks the screen. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.ScreenLock

System API: This is a system API.

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the screen is unlocked successfully, and false means the opposite.

Example

screenlock.unlock().then((data) => {
    console.info(`unlock the screen successfully. result: ${data}`);
}).catch((err) => {
    console.error(`Failed to unlock the screen, because: ${err.message}`);
});

screenlock.lock⁹⁺

lock(callback: AsyncCallback<boolean>): void

Locks the screen. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.ScreenLock

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true means that the screen is locked successfully, and false means the opposite.

Example

screenlock.lock((err, data) => {      
    if (err) {
        console.error(`Failed to lock the screen, because: ${err.message}`);
        return;    
    }
    console.info(`lock the screen successfully. result: ${data}`);
});

screenlock.lock⁹⁺

lock(): Promise<boolean>

Locks the screen. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.ScreenLock

System API: This is a system API.

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the screen is locked successfully, and false means the opposite.

Example

screenlock.lock().then((data) => {
    console.info(`lock the screen successfully. result: ${data}`);
}).catch((err) => {
    console.error(`Failed to lock the screen, because: ${err.message}`);
});

screenlock.onSystemEvent⁹⁺

onSystemEvent(callback: Callback<SystemEvent>): boolean

Registers a callback for system events related to screen locking. This API can be called only by system screen lock applications.

System capability: SystemCapability.MiscServices.ScreenLock

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	Callback<SystemEvent>	Yes	Callback for system events related to screen locking.

Return value

Type	Description
boolean	Returns true if the callback is registered successfully; returns false otherwise.

Example

try {
    let isSuccess = screenlock.onSystemEvent((event) => {
        console.log(`Register the system event which related to screenlock successfully. eventType: ${event.eventType}`)
    });
} catch (err) {
    console.error(`Failed to register the system event which related to screenlock, because: ${err.message}`)
}

screenlock.sendScreenLockEvent⁹⁺

sendScreenLockEvent(event: String, parameter: number, callback: AsyncCallback<boolean>): void

Sends an event to the screen lock service. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MiscServices.ScreenLock

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
event	String	Yes	Event type. - "unlockScreenResult": Screen unlock result. - "lockScreenResult": Screen lock result. - "screenDrawDone": Screen drawing is complete.
parameter	number	Yes	Result. - 0: The operation is successful. For example, the screen is locked or unlocked successfully. - 1, the operation fails. For example, screen locking or unlocking fails. - 2: The operation is canceled. For example, screen locking or unlocking is canceled.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true means that the event is sent successfully, and false means the opposite.

Example

screenlock.sendScreenLockEvent('unlockScreenResult', 0, (err, result) => {
    if (err) {
        console.error(`Failed to send screenlock event, because: ${err.message}`);
        return;
    }
    console.info(`Send screenlock event successfully. result: ${result}`);
});

screenlock.sendScreenLockEvent⁹⁺

sendScreenLockEvent(event: String, parameter: number): Promise<boolean>

Sends an event to the screen lock service. This API uses a promise to return the result.

System capability: SystemCapability.MiscServices.ScreenLock

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
event	String	Yes	Event type. - "unlockScreenResult": Screen unlock result. - "lockScreenResult": Screen lock result. - "screenDrawDone": Screen drawing is complete.
parameter	number	Yes	Result. - 0: The operation is successful. For example, the screen is locked or unlocked successfully. - 1, the operation fails. For example, screen locking or unlocking fails. - 2: The operation is canceled. For example, screen locking or unlocking is canceled.

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the event is sent successfully, and false means the opposite.

Example

screenlock.sendScreenLockEvent('unlockScreenResult', 0).then((result) => {
    console.info(`Send screenlock event successfully. result: ${result}`);
}).catch((err) => {
    console.error(`Failed to send screenlock event, because: ${err.message}`);
});

screenlock.isScreenLocked^(deprecated)

isScreenLocked(callback: AsyncCallback<boolean>): void

Checks whether the screen is locked. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9.

System capability: SystemCapability.MiscServices.ScreenLock

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true means that the screen is locked, and false means the opposite.

Example

screenlock.isScreenLocked((err, data)=>{      
    if (err) {
        console.error(`Failed to obtain whether the screen is locked, because: ${err.message}`);
        return;    
    }
    console.info(`Obtain whether the screen is locked successfully. result: ${data}`);
});

screenlock.isScreenLocked^(deprecated)

isScreenLocked(): Promise<boolean>

Checks whether the screen is locked. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9.

System capability: SystemCapability.MiscServices.ScreenLock

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the screen is locked, and false means the opposite.

Example

screenlock.isScreenLocked().then((data) => {
    console.info(`Obtain whether the screen is locked successfully. result: ${data}`);
}).catch((err) => {
    console.error(`Failed to obtain whether the screen is locked, because: ${err.message}`);
});

screenlock.isSecureMode^(deprecated)

isSecureMode(callback: AsyncCallback<boolean>): void

Checks whether the device is in secure mode. When the device is in secure mode, its screen requires a password, unlock pattern, or other user credentials to unlock. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9.

System capability: SystemCapability.MiscServices.ScreenLock

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true means that the device is in secure mode, and false means the opposite.

Example

screenlock.isSecureMode((err, data)=>{
    if (err) {
        console.error(`Failed to obtain whether the device is in secure mode, because: ${err.message}`);
        return;
    }
    console.info(`Obtain whether the device is in secure mode successfully. result: ${data}`);
});

screenlock.isSecureMode^(deprecated)

isSecureMode(): Promise<boolean>

Checks whether the device is in secure mode. When the device is in secure mode, its screen requires a password, unlock pattern, or other user credentials to unlock. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9.

System capability: SystemCapability.MiscServices.ScreenLock

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that the device is in secure mode, and false means the opposite.

Example

screenlock.isSecureMode().then((data) => {
    console.info(`Obtain whether the device is in secure mode successfully. result: ${data}`);
}).catch((err) => {
    console.error(`Failed to obtain whether the device is in secure mode, because: ${err.message}`);
});

screenlock.unlockScreen^(deprecated)

unlockScreen(callback: AsyncCallback<void>): void

Unlocks the screen. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9.

System capability: SystemCapability.MiscServices.ScreenLock

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the screen is unlocked successfully, err is undefined; otherwise, err is an error object.

Example

screenlock.unlockScreen((err) => {      
    if (err) {
        console.error(`Failed to unlock the screen, because: ${err.message}`);
        return;    
    }
    console.info('unlock the screen successfully.');
});

screenlock.unlockScreen^(deprecated)

unlockScreen(): Promise<void>

Unlocks the screen. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9.

System capability: SystemCapability.MiscServices.ScreenLock

Return value

Type	Description
Promise<void>	Promise that returns no value.

Example

screenlock.unlockScreen().then(() => {
    console.info('unlock the screen successfully.');
}).catch((err) => {
    console.error(`Failed to unlock the screen, because: ${err.message}`);
});

@ohos.screenLock (Screen Lock)

Modules to Import

EventType9+

SystemEvent9+

screenlock.isLocked9+

screenlock.unlock9+

screenlock.unlock9+

screenlock.lock9+

screenlock.lock9+

screenlock.onSystemEvent9+

screenlock.sendScreenLockEvent9+

screenlock.sendScreenLockEvent9+

screenlock.isScreenLocked(deprecated)

screenlock.isScreenLocked(deprecated)

screenlock.isSecureMode(deprecated)

screenlock.isSecureMode(deprecated)

screenlock.unlockScreen(deprecated)

screenlock.unlockScreen(deprecated)

EventType⁹⁺

SystemEvent⁹⁺

screenlock.isLocked⁹⁺

screenlock.unlock⁹⁺

screenlock.unlock⁹⁺

screenlock.lock⁹⁺

screenlock.lock⁹⁺

screenlock.onSystemEvent⁹⁺

screenlock.sendScreenLockEvent⁹⁺

screenlock.sendScreenLockEvent⁹⁺

screenlock.isScreenLocked^(deprecated)

screenlock.isScreenLocked^(deprecated)

screenlock.isSecureMode^(deprecated)

screenlock.isSecureMode^(deprecated)

screenlock.unlockScreen^(deprecated)

screenlock.unlockScreen^(deprecated)