@ohos.screenLock (锁屏管理)(系统接口)

锁屏管理服务是OpenHarmony中的系统服务，为锁屏应用提供注册亮屏、灭屏、开启屏幕、结束休眠、退出动画、请求解锁结果监听，并提供回调结果给锁屏应用。锁屏管理服务向三方应用提供请求解锁、查询锁屏状态、查询是否设置锁屏密码的能力。

说明：

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

当前页面仅包含本模块的系统接口，其他公开接口参见@ohos.screenLock (锁屏管理)。

导入模块

import screenLock from '@ohos.screenLock';

EventType⁹⁺

定义系统事件类型。

系统能力： SystemCapability.MiscServices.ScreenLock

系统接口：此接口为系统接口。

SystemEvent⁹⁺

定义系统事件回调参数结构。

系统能力： SystemCapability.MiscServices.ScreenLock

系统接口：此接口为系统接口

screenLock.isLocked⁹⁺

isLocked(): boolean

判断屏幕是否锁屏。

系统能力： SystemCapability.MiscServices.ScreenLock

系统接口：此接口为系统接口

返回值：

示例：

let isLocked = screenLock.isLocked();

screenLock.unlock⁹⁺

unlock(callback: AsyncCallback<boolean>): void

解锁屏幕。使用callback异步回调。

系统能力： SystemCapability.MiscServices.ScreenLock

系统接口：此接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见锁屏服务错误码。

示例：

import { BusinessError } from '@ohos.base';

screenLock.unlock((err: BusinessError, data: Boolean) => {
  if (err) {
    console.error(`Failed to unlock the screen, Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in unlocking the screen. result: ${data}`);
});

说明：

在 api11 中 增加错误码13200003 illegal use 。

screenLock.unlock⁹⁺

unlock(): Promise<boolean>

解锁屏幕。使用Promise异步回调。

系统能力： SystemCapability.MiscServices.ScreenLock

系统接口：此接口为系统接口

返回值：

错误码：

以下错误码的详细介绍请参见锁屏服务错误码。

示例：

import { BusinessError } from '@ohos.base';

screenLock.unlock().then((data: Boolean) => {
  console.info(`Succeeded in unlocking the screen. result: ${data}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to unlock the screen, Code: ${err.code}, message: ${err.message}`);
});

说明：

在 api11 中 增加错误码13200003 illegal use 。

screenLock.lock⁹⁺

lock(callback: AsyncCallback<boolean>): void

锁定屏幕。使用callback异步回调。

系统能力： SystemCapability.MiscServices.ScreenLock

需要权限： ohos.permission.ACCESS_SCREEN_LOCK_INNER

系统接口：此接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见锁屏服务错误码。

示例：

import { BusinessError } from '@ohos.base';

screenLock.lock((err: BusinessError, data: Boolean) => {
  if (err) {
    console.error(`Failed to lock the screen, Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in locking the screen. result: ${data}`);
});

screenLock.lock⁹⁺

lock(): Promise<boolean>

锁定屏幕。使用Promise异步回调。

系统能力： SystemCapability.MiscServices.ScreenLock

需要权限： ohos.permission.ACCESS_SCREEN_LOCK_INNER

系统接口：此接口为系统接口

返回值：

错误码：

以下错误码的详细介绍请参见锁屏服务错误码。

示例：

import { BusinessError } from '@ohos.base';

screenLock.lock().then((data: Boolean) => {
  console.info(`Succeeded in locking the screen. result: ${data}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to lock the screen, Code: ${err.code}, message: ${err.message}`);
});

screenLock.onSystemEvent⁹⁺

onSystemEvent(callback: Callback<SystemEvent>): boolean

注册锁屏相关的系统事件，仅支持锁屏应用使用。

系统能力： SystemCapability.MiscServices.ScreenLock

需要权限： ohos.permission.ACCESS_SCREEN_LOCK_INNER

系统接口：此接口为系统接口

参数：

返回值：

错误码：

以下错误码的详细介绍请参见锁屏服务错误码。

示例：

try {
  let isSuccess = screenLock.onSystemEvent((event: screenLock.SystemEvent) => {
    console.log(`Succeeded in Registering the system event which related to screenlock. eventType: ${event.eventType}`)
  });
} catch (err) {
  let error = err as BusinessError;
  console.error(`Failed to register the system event which related to screenlock, Code: ${error.code}, message: ${error.message}`)
}

screenLock.sendScreenLockEvent⁹⁺

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

应用发送事件到锁屏服务，仅支持锁屏应用使用。使用callback异步回调。

系统能力： SystemCapability.MiscServices.ScreenLock

需要权限： ohos.permission.ACCESS_SCREEN_LOCK_INNER

系统接口：此接口为系统接口

参数：

错误码：

以下错误码的详细介绍请参见锁屏服务错误码。

示例：

import { BusinessError } from '@ohos.base';

screenLock.sendScreenLockEvent('unlockScreenResult', 0, (err: BusinessError, result: Boolean) => {
  if (err) {
    console.error(`Failed to send screenlock event, Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in Sending screenlock event. result: ${result}`);
});

screenLock.sendScreenLockEvent⁹⁺

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

应用发送事件到锁屏服务，仅支持锁屏应用使用。使用Promise异步回调。

系统能力： SystemCapability.MiscServices.ScreenLock

需要权限： ohos.permission.ACCESS_SCREEN_LOCK_INNER

系统接口：此接口为系统接口

参数：

返回值：

错误码：

以下错误码的详细介绍请参见锁屏服务错误码。

示例：

import { BusinessError } from '@ohos.base';

screenLock.sendScreenLockEvent('unlockScreenResult', 0).then((result: Boolean) => {
  console.info(`Succeeded in Sending screenlock event. result: ${result}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to send screenlock event, Code: ${err.code}, message: ${err.message}`);
});