锁屏管理

2024-01-23 17:26 更新

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

说明

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

导入模块

  1. import screenLock from '@ohos.screenLock';

screenLock.isScreenLocked(deprecated)

isScreenLocked(callback: AsyncCallback<boolean>): void

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

说明

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

系统能力: SystemCapability.MiscServices.ScreenLock

参数:

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

回调函数。返回true表示屏幕已锁屏;返回false表示屏幕未锁屏。

示例:

  1. screenLock.isScreenLocked((err, data)=>{
  2. if (err) {
  3. console.error(`Failed to obtain whether the screen is locked, because: ${err.message}`);
  4. return;
  5. }
  6. console.info(`Obtain whether the screen is locked successfully. result: ${data}`);
  7. });

screenLock.isScreenLocked(deprecated)

isScreenLocked(): Promise<boolean>

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

说明

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

系统能力: SystemCapability.MiscServices.ScreenLock

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示屏幕已锁屏;返回false表示屏幕未锁屏。

示例:

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

screenLock.isSecureMode(deprecated)

isSecureMode(callback: AsyncCallback<boolean>): void

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

说明

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

系统能力: SystemCapability.MiscServices.ScreenLock

参数:

参数名

类型

必填

说明

callback

AsyncCallback<boolean>

回调函数。返回true表示当前设备的屏幕锁定安全;返回false表示当前设备的屏幕锁定不安全。

示例:

  1. screenLock.isSecureMode((err, data)=>{
  2. if (err) {
  3. console.error(`Failed to obtain whether the device is in secure mode, because: ${err.message}`);
  4. return;
  5. }
  6. console.info(`Obtain whether the device is in secure mode successfully. result: ${data}`);
  7. });

screenLock.isSecureMode(deprecated)

isSecureMode(): Promise<boolean>

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

说明

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

系统能力: SystemCapability.MiscServices.ScreenLock

返回值:

类型

说明

Promise<boolean>

Promise对象。返回true表示当前设备的屏幕锁定安全;返回false表示当前设备的屏幕锁定不安全。

示例:

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

screenLock.unlockScreen(deprecated)

unlockScreen(callback: AsyncCallback<void>): void

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

说明

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

系统能力: SystemCapability.MiscServices.ScreenLock

参数:

参数名

类型

必填

说明

callback

AsyncCallback<void>

回调函数。解锁屏幕成功,err为undefined,否则为错误对象。

示例:

  1. screenLock.unlockScreen((err) => {
  2. if (err) {
  3. console.error(`Failed to unlock the screen, Code: ${err.code}, message: ${err.message}`);
  4. return;
  5. }
  6. console.info('unlock the screen successfully.');
  7. });

screenLock.unlockScreen(deprecated)

unlockScreen(): Promise<void>

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

说明

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

系统能力: SystemCapability.MiscServices.ScreenLock

返回值:

类型

说明

Promise<void>

Promise对象。无返回结果的Promise对象。

示例:

  1. screenLock.unlockScreen().then(() => {
  2. console.info('unlock the screen successfully.');
  3. }).catch((err) => {
  4. console.error(`Failed to unlock the screen, Code: ${err.code}, message: ${err.message}`);
  5. });
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号