!5191 【misc软件服务子系统】screenlock add api docs

Merge pull request !5191 from wangdongqi/master

zh-cn/application-dev/reference/apis/js-apis-screen-lock.md

@@ -20,12 +20,12 @@ isScreenLocked(callback: AsyncCallback<boolean>): void
 
 **系统能力**: SystemCapability.MiscServices.ScreenLock
 
-- 参数：
+**参数**：
     | 参数名 | 类型 | 必填 | 说明 | 
   | -------- | -------- | -------- | -------- |
   | callback | AsyncCallback<boolean> | 是 | 回调函数，返回true表示屏幕已锁屏，返回false表示屏幕未锁屏。 | 
 
-- 示例：
+**示例**：
   
   ```js
   screenlock.isScreenLocked((err, data)=>{      
@@ -46,12 +46,12 @@ isScreenLocked(): Promise<boolean>
 
 **系统能力**: SystemCapability.MiscServices.ScreenLock
 
-- 返回值：
+**返回值**：
   | 类型 | 说明 | 
   | -------- | -------- |
   | Promise<boolean> | 以Promise形式返回结果。 | 
 
-- 示例：
+**示例**：
 
   ```js
   screenlock.isScreenLocked().then((data) => {
@@ -73,12 +73,12 @@ isSecureMode(callback: AsyncCallback<boolean>): void
 **系统能力**: SystemCapability.MiscServices.ScreenLock
 
 
-- 参数：
+**参数**：
     | 参数名 | 类型 | 必填 | 说明 | 
   | -------- | -------- | -------- | -------- |
   | callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示屏幕处于安全模式下，返回false表示屏幕当前不在安全模式下。 | 
 
-- 示例：
+**示例**：
   
   ```js
   screenlock.isSecureMode((err, data)=>{      
@@ -99,12 +99,12 @@ isSecureMode(): Promise<boolean>
 
 **系统能力**: SystemCapability.MiscServices.ScreenLock
 
-- 返回值：
+**返回值**：
   | 类型 | 说明 | 
   | -------- | -------- |
   | Promise<boolean> | 以Promise形式返回结果。 | 
 
-- 示例：
+**示例**：
 
   ```js
   screenlock.isSecureMode().then((data) => {
@@ -126,15 +126,15 @@ unlockScreen(callback: AsyncCallback<void>): void
 **系统能力**: SystemCapability.MiscServices.ScreenLock
 
 
-- 参数：
+**参数**：
     | 参数名 | 类型 | 必填 | 说明 | 
   | -------- | -------- | -------- | -------- |
   | callback | AsyncCallback<void> | 是 | 回调函数，失败时返回错误信息。 | 
 
-- 示例：
+**示例**：
   
   ```js
-  screenlock.unlockScreen((err)=>{      
+  screenlock.unlockScreen((err) => {      
      if (err) {
           console.error('unlockScreen callback error -> ${JSON.stringify(err)}');
           return;    
@@ -152,12 +152,12 @@ unlockScreen(): Promise<void>
 
 **系统能力**: SystemCapability.MiscServices.ScreenLock
 
-- 返回值：
+**返回值**：
     | 类型 | 说明 | 
   | -------- | -------- |
   | Promise<void> | 以Promise形式返回结果。 | 
 
-- 示例：
+**示例**：
   
   ```js
   screenlock.unlockScreen().then(() => {
@@ -166,3 +166,141 @@ unlockScreen(): Promise<void>
       console.error('unlockScreen fail, promise: err->${JSON.stringify(err)}');
   });
   ```
+
+## screenlock.on<sup>9+</sup>
+
+on(type: 'beginWakeUp' | 'endWakeUp' | 'beginScreenOn' | 'endScreenOn' | 'beginScreenOff' | 'endScreenOff' | 'unlockScreen' | 'beginExitAnimation', callback: Callback\<void\>): void
+
+注册锁屏状态变化回调。
+
+**系统能力**: SystemCapability.MiscServices.ScreenLock
+
+**参数**：
+  | 参数名 | 类型 | 必填 | 说明 |
+  | -------- | -------- | -------- | -------- |
+  | type | string | 是 | 设置事件类型。<br/>- type为"beginWakeUp"，表示事件开始时开始唤醒。<br/>- type为"endWakeUp"，表示事件结束时结束唤醒。<br/>- type为"beginScreenOn"，表示事件开始时开始亮屏。<br/>- type为"endScreenOn"，表示事件结束时结束亮屏。<br/>- type为"beginScreenOff"，表示事件开始时开始灭屏。<br/>- type为"endScreenOff"，表示事件结束时结束灭屏。<br/>- type为"unlockScreen"，表示请求解锁。<br/>- type为"beginExitAnimation"，表示动画开始退场。 |
+  | callback | Callback\<void\> | 是 | 事件回调方法。 |
+
+**示例**：
+  
+  ```js
+  screenlock.on('beginWakeUp', () => {
+      console.log('beginWakeUp triggered');
+  });
+  ```
+
+## screenlock.on<sup>9+</sup>
+
+on(type: 'beginSleep' | 'endSleep' | 'changeUser', callback: Callback\<number\>): void
+
+注册锁屏状态变化回调。
+
+**系统能力**: SystemCapability.MiscServices.ScreenLock
+
+**参数**：
+  | 参数名 | 类型 | 必填 | 说明 |
+  | -------- | -------- | -------- | -------- |
+  | type | string | 是 | 设置事件类型。<br/>- type为"beginSleep"，表示开始休眠。<br/>- type为"endSleep"，表示结束休眠。<br/>- type为"changeUser"，表示切换用户。 |
+  | callback | Callback\<number\> | 是 | 事件回调方法。<br/>返回事件相应的状态。 |
+
+**示例**：
+  
+  ```js
+  screenlock.on('beginSleep', (why) => {
+      console.log('beginSleep triggered:' + why);
+  });
+  ```
+## screenlock.on<sup>9+</sup>
+
+on(type: 'screenlockEnabled', callback: Callback\<boolean\>): void
+
+注册锁屏状态变化回调。
+
+**系统能力**: SystemCapability.MiscServices.ScreenLock
+
+**参数**：
+  | 参数名 | 类型 | 必填 | 说明 |
+  | -------- | -------- | -------- | -------- |
+  | type | string | 是 | 设置事件类型。<br/>- type为"screenlockEnabled"，表示锁屏是否启用。 |
+  | callback | Callback\<boolean\> | 是 | 注册成功的回调。<br/>回调结果用true/false表示。 |
+
+**示例**：
+  
+  ```js
+  screenlock.on('screenlockEnabled', (isEnabled) => {
+      console.log('screenlockEnabled triggered, result:' + isEnabled);
+  });
+  ```
+
+## screenlock.off<sup>9+</sup>
+
+off(type: 'beginWakeUp' | 'endWakeUp' | 'beginScreenOn' | 'endScreenOn' | 'beginScreenOff' | 'endScreenOff' 
+      | 'unlockScreen' | 'beginExitAnimation' | 'screenlockEnabled' | 'beginSleep' | 'endSleep' | 'changeUser', callback: Callback\<void\>): void
+
+取消注册锁屏状态变化回调。
+
+**系统能力**: SystemCapability.MiscServices.ScreenLock
+
+**参数**：
+  | 参数名 | 类型 | 必填 | 说明 |
+  | -------- | -------- | -------- | -------- |
+  | type | string | 是 | 设置事件类型。<br/>- type为"beginWakeUp"，表示事件开始时开始唤醒。<br/>- type为"endWakeUp"，表示事件结束时结束唤醒。<br/>- type为"beginScreenOn"，表示事件开始时开始亮屏。<br/>- type为"endScreenOn"，表示事件结束时结束亮屏。<br/>- type为"beginScreenOff"，表示事件开始时开始灭屏。<br/>- type为"endScreenOff"，表示事件结束时结束灭屏。<br/>- type为"unlockScreen"，表示请求解锁。<br/>- type为"beginExitAnimation"，表示动画开始退场。<br/>- type为"screenlockEnabled"，表示锁屏是否启用。<br/>- type为"beginSleep"，表示开始休眠。<br/>- type为"endSleep"，表示结束休眠。<br/>- type为"changeUser"，表示切换用户。 |
+  | callback | Callback\<void\> | 是 | 注册成功的回调。 |
+
+**示例**：
+  
+  ```js
+  screenlock.off('beginWakeUp', () => {
+      console.log("callback");
+  });
+  ```
+
+## screenlock.sendScreenLockEvent<sup>9+</sup>
+
+sendScreenLockEvent(event: String, parameter: number, callback: AsyncCallback\<boolean\>): void
+
+应用发送事件到锁屏服务，异步方法。
+
+**系统能力**: SystemCapability.MiscServices.ScreenLock
+
+**参数**：
+  | 参数名 | 类型 | 必填 | 说明 |
+  | -------- | -------- | -------- | -------- |
+  | event | String | 是 | 事件类型，支持如下取值:<br/>- "unlockScreenResult"，表示解锁结果。<br/>- "screenDrawDone"，表示屏幕绘制完成。 |
+  | parameter | number | 是 | 解锁状态。<br/>- parameter为0，表示解锁成功。<br/>- parameter为1，表示解锁失败。<br/>- parameter为2，表示解锁取消。 |
+  | callback | AsyncCallback\<boolean\> | 是 | 表示执行结果。 |
+
+**示例**：
+  
+  ```js
+  screenlock.sendScreenLockEvent('unlockScreenResult', 0, (err, result) => {
+      console.log('sending result:' + result);
+  });
+  ```
+
+## screenlock.sendScreenLockEvent<sup>9+</sup>
+
+sendScreenLockEvent(event: String, parameter: number): Promise<boolean>
+
+应用发送事件到锁屏服务，异步方法。
+
+**系统能力**: SystemCapability.MiscServices.ScreenLock
+
+**参数**：
+  | 参数名 | 类型 | 必填 | 说明 |
+  | -------- | -------- | -------- | -------- |
+  | event | String | 是 | 事件类型，支持如下取值:<br/>- "unlockScreenResult"，表示解锁结果。<br/>- "screenDrawDone"，表示屏幕绘制完成。 |
+  | parameter | number | 是 | 解锁状态。<br/>- parameter为0，表示解锁成功。<br/>- parameter为1，表示解锁失败。<br/>- parameter为2，表示解锁取消。 |
+
+**返回值**：
+  | 类型 | 说明 | 
+  | -------- | -------- |
+  | Promise\<boolean\> | 以Promise形式返回执行结果。 | 
+
+**示例**：
+  
+  ```js
+  screenlock.sendScreenLockEvent('unlockScreenResult', 0).then((err, result) => {
+      console.log('sending result:' + result);
+  });
+  ```