目录

锁屏(1090+)

接口声明

在manifest.json文件的 features属性中增加如下配置。

{"name": "system.keyguard"}

导入模块

在调用接口页面的<script>部分增加如下配置。

import keyguard from '@system.keyguard'

或

var keyguard = require("@system.keyguard")

使用限制

限制条件

说明

适用终端

手机、平板、智慧屏、车机

适用区域

全球

接口定义

接口

描述

keyguard.getKeyguardLockedStatus(OBJECT)

检测设备当前是否为锁屏状态。

[h2]keyguard.getKeyguardLockedStatus(OBJECT)

描述

检测设备当前是否为锁屏状态。

OBJECT参数

参数

类型

是否必填

说明

success

function

否

成功回调,返回值为对象。

fail

function

否

失败回调,返回值为错误码和错误消息。

success返回值:

参数

类型

说明

isKeyguardLocked

boolean

  • true:当前已锁屏。
  • false:当前未锁屏。

示例代码

import keyguard from '@system.keyguard'
export default {
  onShow() {
    keyguard.getKeyguardLockedStatus({
      success: result => {
        console.log('Is the current application locked : ', result.isKeyguardLocked)
      },
      fail: (data, code) => {
        console.log(`get isKeyguardLocked fail, errMsg = ${data}`)
        console.log(`get isKeyguardLocked fail, errCode = ${code}`)
      }
    })
  }
}

版本更新说明

版本

发布日期

描述

1090

2022-05-19

第一次正式发布。