!9843 screenlock API 变更

Merge pull request !9843 from qimeng/master

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

@@ -232,61 +232,46 @@ lockScreen(): Promise<boolean>
   });
   ```
 
+## EventType
 
-## 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
-
-注册锁屏状态变化回调。
+  | 名称 | 说明 |
+  | -------- | -------- |
+  | beginWakeUp | 表示事件开始时开始唤醒。 |
+  | endWakeUp | 表示事件结束时结束唤醒。 |
+  | beginScreenOn | 表示事件开始时开始亮屏。 |
+  | endScreenOn | 表示事件结束时结束亮屏。 |
+  | beginScreenOff | 表示事件开始时开始灭屏。 |
+  | endScreenOff | 表示事件结束时结束灭屏。 |
+  | unlockScreen | 表示请求解锁屏幕。 |
+  | lockScreen | 表示请求锁定屏幕。 |
+  | beginExitAnimation | 表示动画开始退场。 |
+  | beginSleep | 表示开始休眠。 |
+  | endSleep | 表示结束休眠。 |
+  | changeUser | 表示切换用户。 |
+  | screenlockEnabled | 表示锁屏是否启用。 |
+  | serviceRestart | 表示锁屏服务进行重启。 |
+
+
+## SystemEvent
+
+定义系统事件回调参数结构。
 
 **系统能力**: SystemCapability.MiscServices.ScreenLock
 
-**系统接口**：此接口为系统接口，三方应用不支持调用。
+  | 名称 | 说明 |
+  | -------- | -------- |
+  | eventType | 系统事件类型。 |
+  | params | 系统事件的事件参数。 |
 
-**参数**：
+## screenlock.onSystemEvent<sup>9+</sup>
 
-  | 参数名 | 类型 | 必填 | 说明 |
-  | -------- | -------- | -------- | -------- |
-  | type | string | 是 | 设置事件类型。<br/>- type为"beginSleep"，表示开始休眠。<br/>- type为"endSleep"，表示结束休眠。<br/>- type为"changeUser"，表示切换用户。 |
-  | callback | Callback\<number\> | 是 | 事件回调方法。<br/>返回事件相应的状态。 |
+onSystemEvent(callback: Callback\<SystemEvent\>): boolean
 
-**示例**：
-  
-  ```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
 
@@ -296,41 +281,26 @@ on(type: 'screenlockEnabled', callback: Callback\<boolean\>): void
 
   | 参数名 | 类型 | 必填 | 说明 |
   | -------- | -------- | -------- | -------- |
-  | 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>
+  | callback | Callback\<SystemEvent\> | 是 | 锁屏相关的系统事件回调函数 |
 
-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\> | 是 | 注册成功的回调。 |
+  | 类型     | 说明                                        |
+  | ------- | -------------------------------------------- |
+  | boolean |  返回true表示锁屏系统事件注册成功，否则返回false|
 
 **示例**：
-  
+
   ```js
-  screenlock.off('beginWakeUp', () => {
-      console.log("callback");
-  });
+    let isSuccess = screenlock.onSystemEvent((err, event)=>{
+        console.log(`onSystemEvent:callback:${event.eventType}`)
+        if (err) {
+            console.log(`onSystemEvent callback error -> ${JSON.stringify(err)}`);
+        }
+    });
+    if (!isSuccess) {
+        console.log(`onSystemEvent result is false`)
+    }
   ```
 
 ## screenlock.sendScreenLockEvent<sup>9+</sup>