From 611f95d136934b9d6c2aef0a4a326cde311fdc67 Mon Sep 17 00:00:00 2001 From: qixiao-meng Date: Fri, 26 Aug 2022 16:10:30 +0800 Subject: [PATCH] Signed-off-by: qixiao-meng feat: add lockScreen api --- .../reference/apis/js-apis-screen-lock.md | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/zh-cn/application-dev/reference/apis/js-apis-screen-lock.md b/zh-cn/application-dev/reference/apis/js-apis-screen-lock.md index 1f3b7ed132..6a45bdf035 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-screen-lock.md +++ b/zh-cn/application-dev/reference/apis/js-apis-screen-lock.md @@ -169,6 +169,62 @@ unlockScreen(): Promise<void> }); ``` + +## screenlock.lockScreen9+ + +lockScreen(callback: AsyncCallback<void>): void + + +锁定屏幕,使用callback作为异步方法。 + + +**系统能力**: SystemCapability.MiscServices.ScreenLock + +**系统API**:此接口为系统接口,三方应用不支持调用。 + +**参数**: + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<void> | 是 | 回调函数,失败时返回错误信息。 | + +**示例**: + + ```js + screenlock.lockScreen((err) => { + if (err) { + console.error('lockScreen callback error -> ${JSON.stringify(err)}'); + return; + } + console.info('lockScreen callback success'); + }); + ``` + +## screenlock.lockScreen9+ + +lockScreen(): Promise<void> + +锁定屏幕,使用Promise作为异步方法。 + +**系统能力**: SystemCapability.MiscServices.ScreenLock + +**系统API**:此接口为系统接口,三方应用不支持调用。 + +**返回值**: + | 类型 | 说明 | + | -------- | -------- | + | Promise<void> | 以Promise形式返回结果。 | + +**示例**: + + ```js + screenlock.lockScreen().then(() => { + console.log('lockScreen success'); + }).catch((err) => { + console.error('lockScreen fail, promise: err->${JSON.stringify(err)}'); + }); + ``` + + ## screenlock.on9+ on(type: 'beginWakeUp' | 'endWakeUp' | 'beginScreenOn' | 'endScreenOn' | 'beginScreenOff' | 'endScreenOff' | 'unlockScreen' | 'beginExitAnimation', callback: Callback\): void -- GitLab