@ohos.screenLock (锁屏管理)

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

说明：

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

导入模块

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}`);
  });

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}`);
  });

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}`);
  });

screenLock.isScreenLocked^(deprecated)

isScreenLocked(callback: AsyncCallback<boolean>): void

判断屏幕是否锁屏。使用callback异步回调。

说明：

从API version 7开始支持，从API version 9开始废弃。

系统能力： SystemCapability.MiscServices.ScreenLock

参数：

示例：

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

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

screenLock.isScreenLocked^(deprecated)

isScreenLocked(): Promise<boolean>

判断屏幕是否锁屏。使用Promise异步回调。

说明：

从API version 7开始支持，从API version 9开始废弃。

系统能力： SystemCapability.MiscServices.ScreenLock

返回值：

示例：

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

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

screenLock.isSecureMode^(deprecated)

isSecureMode(callback: AsyncCallback<boolean>): void

判断当前设备的屏幕锁定是否安全（安全屏幕锁定意味着解锁屏幕需要密码、图案或其他用户身份识别）。使用callback异步回调。

说明：

从API version 7开始支持，从API version 9开始废弃。

系统能力： SystemCapability.MiscServices.ScreenLock

参数：

示例：

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

  screenLock.isSecureMode((err: BusinessError, data: Boolean)=>{
    if (err) {
      console.error(`Failed to obtain whether the device is in secure mode, Code: ${err.code}, message: ${err.message}`);
      return;
    }
    console.info(`Succeeded in Obtaining whether the device is in secure mode. result: ${data}`);
  });

screenLock.isSecureMode^(deprecated)

isSecureMode(): Promise<boolean>

判断当前设备的屏幕锁定是否安全（安全屏幕锁定意味着解锁屏幕需要密码、图案或其他用户身份识别）。使用Promise异步回调。

说明：

从API version 7开始支持，从API version 9开始废弃。

系统能力： SystemCapability.MiscServices.ScreenLock

返回值：

示例：

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

  screenLock.isSecureMode().then((data: Boolean) => {
    console.info(`Succeeded in Obtaining whether the device is in secure mode. result: ${data}`);
  }).catch((err: BusinessError) => {
    console.error(`Failed to obtain whether the device is in secure mode, Code: ${err.code}, message: ${err.message}`);
  });

screenLock.unlockScreen^(deprecated)

unlockScreen(callback: AsyncCallback<void>): void

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

说明：

从API version 7开始支持，从API version 9开始废弃。

系统能力： SystemCapability.MiscServices.ScreenLock

参数：

示例：

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

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

screenLock.unlockScreen^(deprecated)

unlockScreen(): Promise<void>

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

说明：

从API version 7开始支持，从API version 9开始废弃。

系统能力： SystemCapability.MiscServices.ScreenLock

返回值：

示例：

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

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

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)