• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 锁屏管理
2
3锁屏管理服务是OpenHarmony中系统服务,为锁屏应用提供注册亮屏、灭屏、开启屏幕、结束休眠、退出动画、请求解锁结果监听,并提供回调结果给锁屏应用。锁屏管理服务向三方应用提供请求解锁、查询锁屏状态、查询是否设置锁屏密码的能力。
4
5> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
6> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
7
8
9## 导入模块
10
11
12```js
13import screenlock from '@ohos.screenLock';
14```
15
16
17## screenlock.isScreenLocked
18
19isScreenLocked(callback: AsyncCallback<boolean>): void
20
21判断屏幕是否锁屏,使用callback作为异步方法。
22
23**系统能力**: SystemCapability.MiscServices.ScreenLock
24
25- 参数:
26    | 参数名 | 类型 | 必填 | 说明 |
27  | -------- | -------- | -------- | -------- |
28  | callback | AsyncCallback<boolean> | 是 | 回调函数,返回true表示屏幕已锁屏,返回false表示屏幕未锁屏。 |
29
30- 示例:
31
32  ```js
33  screenlock.isScreenLocked((err, data)=>{
34     if (err) {
35          console.error('isScreenLocked callback error -> ${JSON.stringify(err)}');
36          return;
37     }
38     console.info('isScreenLocked callback success data -> ${JSON.stringify(data)}');
39  });
40  ```
41
42
43## screenlock.isScreenLocked
44
45isScreenLocked(): Promise<boolean>
46
47判断屏幕是否锁屏,使用Promise作为异步方法。
48
49**系统能力**: SystemCapability.MiscServices.ScreenLock
50
51- 返回值:
52  | 类型 | 说明 |
53  | -------- | -------- |
54  | Promise<boolean> | 以Promise形式返回结果。 |
55
56- 示例:
57
58  ```js
59  screenlock.isScreenLocked().then((data) => {
60      console.log('isScreenLocked success: data -> ${JSON.stringify(data)}');
61  }).catch((err) => {
62      console.error('isScreenLocked fail, promise: err -> ${JSON.stringify(err)}');
63  });
64  ```
65
66
67## screenlock.isSecureMode
68
69isSecureMode(callback: AsyncCallback<boolean>): void
70
71
72判断设备是否处于安全模式下,使用callback作为异步方法。
73
74
75**系统能力**: SystemCapability.MiscServices.ScreenLock
76
77
78- 参数:
79    | 参数名 | 类型 | 必填 | 说明 |
80  | -------- | -------- | -------- | -------- |
81  | callback | AsyncCallback<boolean> | 是 | 回调函数。返回true表示屏幕处于安全模式下,返回false表示屏幕当前不在安全模式下。 |
82
83- 示例:
84
85  ```js
86  screenlock.isSecureMode((err, data)=>{
87     if (err) {
88          console.error('isSecureMode callback error -> ${JSON.stringify(err)}');
89          return;
90     }
91     console.info('isSecureMode callback success data -> ${JSON.stringify(err)}');
92  });
93  ```
94
95
96## screenlock.isSecureMode
97
98isSecureMode(): Promise<boolean>
99
100判断设备是否处于安全模式下,使用Promise作为异步方法。
101
102**系统能力**: SystemCapability.MiscServices.ScreenLock
103
104- 返回值:
105  | 类型 | 说明 |
106  | -------- | -------- |
107  | Promise<boolean> | 以Promise形式返回结果。 |
108
109- 示例:
110
111  ```js
112  screenlock.isSecureMode().then((data) => {
113      console.log('isSecureMode success: data->${JSON.stringify(data)}');
114  }).catch((err) => {
115      console.error('isSecureMode fail, promise: err->${JSON.stringify(err)}');
116  });
117  ```
118
119
120## screenlock.unlockScreen
121
122unlockScreen(callback: AsyncCallback<void>): void
123
124
125解锁屏幕,使用callback作为异步方法。
126
127
128**系统能力**: SystemCapability.MiscServices.ScreenLock
129
130
131- 参数:
132    | 参数名 | 类型 | 必填 | 说明 |
133  | -------- | -------- | -------- | -------- |
134  | callback | AsyncCallback<void> | 是 | 回调函数,失败时返回错误信息。 |
135
136- 示例:
137
138  ```js
139  screenlock.unlockScreen((err)=>{
140     if (err) {
141          console.error('unlockScreen callback error -> ${JSON.stringify(err)}');
142          return;
143     }
144     console.info('unlockScreen callback success');
145  });
146  ```
147
148
149## screenlock.unlockScreen
150
151unlockScreen(): Promise<void>
152
153解锁屏幕,使用Promise作为异步方法。
154
155**系统能力**: SystemCapability.MiscServices.ScreenLock
156
157- 返回值:
158    | 类型 | 说明 |
159  | -------- | -------- |
160  | Promise<void> | 以Promise形式返回结果。 |
161
162- 示例:
163
164  ```js
165  screenlock.unlockScreen().then(() => {
166      console.log('unlockScreen success');
167  }).catch((err) => {
168      console.error('unlockScreen fail, promise: err->${JSON.stringify(err)}');
169  });
170  ```
171