Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 2ef5eafc 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!12222 【轻量级 PR】：update zh-cn/application-dev/reference/apis/js-apis-screen-lock.md. 

Merge pull request !12222 from 葛亚芳/N/A
上级 04a7e9d1 436ba2da
隐藏空白更改
内联 并排
Showing with 203 addition and 205 deletion
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
浏览文件 @ 2ef5eafc
......@@ -12,69 +12,45 @@
import screenlock from '@ohos.screenLock';
```
## screenlock.isScreenLocked
isScreenLocked(callback: AsyncCallback<boolean>): void
判断屏幕是否锁屏，使用callback异步回调。
## EventType
> **说明：**
>
>从 API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.isLocked<sup>9+</sup>](#screenlockislocked9)代替。
定义系统事件类型。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ----------------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回true表示屏幕已锁屏，返回false表示屏幕未锁屏。 |
**示例：**
```js
screenlock.isScreenLocked((err, data)=>{
if (err) {
console.error('isScreenLocked callback error -> ${JSON.stringify(err)}');
return;
}
console.info('isScreenLocked callback success data -> ${JSON.stringify(data)}');
});
```
## screenlock.isScreenLocked
isScreenLocked(): Promise&lt;boolean&gt;
| 事件类型 | 说明 |
| ------------------ | ------------------------ |
| beginWakeUp | 表示事件开始时开始唤醒。 |
| endWakeUp | 表示事件结束时结束唤醒。 |
| beginScreenOn | 表示事件开始时开始亮屏。 |
| endScreenOn | 表示事件结束时结束亮屏。 |
| beginScreenOff | 表示事件开始时开始灭屏。 |
| endScreenOff | 表示事件结束时结束灭屏。 |
| unlockScreen | 表示请求解锁屏幕。 |
| lockScreen | 表示请求锁定屏幕。 |
| beginExitAnimation | 表示动画开始退场。 |
| beginSleep | 表示开始休眠。 |
| endSleep | 表示结束休眠。 |
| changeUser | 表示切换用户。 |
| screenlockEnabled | 表示锁屏是否启用。 |
| serviceRestart | 表示锁屏服务进行重启。 |
判断屏幕是否锁屏，使用Promise异步回调。
## SystemEvent
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.isLocked<sup>9+</sup>](#screenlockislocked9)代替。
定义系统事件回调参数结构。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**返回值：**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象，返回判断结果。返回true表示屏幕已锁屏，返回false表示屏幕未锁屏。 |
**示例：**
```js
screenlock.isScreenLocked().then((data) => {
console.log('isScreenLocked success: data -> ${JSON.stringify(data)}');
}).catch((err) => {
console.error('isScreenLocked fail, promise: err -> ${JSON.stringify(err)}');
});
```
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------- |
| eventType | [EventType](#eventtype) | 是 | 系统事件类型。 |
| params | string | 是 | 系统事件的事件参数。 |
## screenlock.isLocked<sup>9+</sup>
isLocked(): boolean
判断屏幕是否锁屏，使用同步方法。
判断屏幕是否锁屏。
**系统能力：** SystemCapability.MiscServices.ScreenLock
......@@ -90,64 +66,6 @@ isLocked(): boolean
let isLocked = screenlock.isLocked();
```
## screenlock.isSecureMode
isSecureMode(callback: AsyncCallback&lt;boolean&gt;): void
判断设备是否处于安全模式下，使用callback异步回调。
> **说明：**
>
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.isSecure<sup>9+</sup>](#screenlockissecure9)代替。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。返回true表示屏幕处于安全模式下，返回false表示屏幕当前不在安全模式下。 |
**示例：**
```js
screenlock.isSecureMode((err, data)=>{
if (err) {
console.error('isSecureMode callback error -> ${JSON.stringify(err)}');
return;
}
console.info('isSecureMode callback success data -> ${JSON.stringify(err)}');
});
```
## screenlock.isSecureMode
isSecureMode(): Promise&lt;boolean&gt;
判断设备是否处于安全模式下，使用Promise异步回调。
> **说明：**
>
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.isSecure<sup>9+</sup>](#screenlockissecure9)代替。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**返回值：**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | Promise对象。返回true表示屏幕处于安全模式下，返回false表示屏幕当前不在安全模式下。 |
**示例：**
```js
screenlock.isSecureMode().then((data) => {
console.log('isSecureMode success: data->${JSON.stringify(data)}');
}).catch((err) => {
console.error('isSecureMode fail, promise: err->${JSON.stringify(err)}');
});
```
## screenlock.isSecure<sup>9+</sup>
isSecure(): boolean
......@@ -168,64 +86,6 @@ isSecure(): boolean
let isSecure = screenlock.isSecure();
```
## screenlock.unlockScreen
unlockScreen(callback: AsyncCallback&lt;void&gt;): void
解锁屏幕，使用callback异步回调。
> **说明：**
>
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.unlock<sup>9+</sup>](#screenlockunlock9)代替。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | --------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，失败时返回错误信息。 |
**示例：**
```js
screenlock.unlockScreen((err) => {
if (err) {
console.error('unlockScreen callback error -> ${JSON.stringify(err)}');
return;
}
console.info('unlockScreen callback success');
});
```
## screenlock.unlockScreen
unlockScreen(): Promise&lt;void&gt;
解锁屏幕，使用Promise异步回调。
> **说明：**
>
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.unlock<sup>9+</sup>](#screenlockunlock9)代替。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
screenlock.unlockScreen().then(() => {
console.log('unlockScreen success');
}).catch((err) => {
console.error('unlockScreen fail, promise: err->${JSON.stringify(err)}');
});
```
## screenlock.unlock<sup>9+</sup>
unlock(callback: AsyncCallback&lt;boolean&gt;): void
......@@ -330,41 +190,6 @@ screenlock.lock().then((data) => {
});
```
## EventType
定义系统事件类型。
**系统能力：** SystemCapability.MiscServices.ScreenLock
| 事件类型 | 说明 |
| ------------------ | ------------------------ |
| beginWakeUp | 表示事件开始时开始唤醒。 |
| endWakeUp | 表示事件结束时结束唤醒。 |
| beginScreenOn | 表示事件开始时开始亮屏。 |
| endScreenOn | 表示事件结束时结束亮屏。 |
| beginScreenOff | 表示事件开始时开始灭屏。 |
| endScreenOff | 表示事件结束时结束灭屏。 |
| unlockScreen | 表示请求解锁屏幕。 |
| lockScreen | 表示请求锁定屏幕。 |
| beginExitAnimation | 表示动画开始退场。 |
| beginSleep | 表示开始休眠。 |
| endSleep | 表示结束休眠。 |
| changeUser | 表示切换用户。 |
| screenlockEnabled | 表示锁屏是否启用。 |
| serviceRestart | 表示锁屏服务进行重启。 |
## SystemEvent
定义系统事件回调参数结构。
**系统能力：** SystemCapability.MiscServices.ScreenLock
| 名称 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | ------------- |
| eventType | [EventType](#eventtype) | 是 | 系统事件类型。 |
| params | string | 是 | 系统事件的事件参数。 |
## screenlock.onSystemEvent<sup>9+</sup>
onSystemEvent(callback: Callback\<SystemEvent\>): boolean
......@@ -377,8 +202,8 @@ onSystemEvent(callback: Callback\<SystemEvent\>): boolean
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | ---------------------------- |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----------------- |
| callback | Callback\<[SystemEvent](#systemevent)> | 是 | 锁屏相关的系统事件回调函数。 |
**返回值：**
......@@ -443,8 +268,8 @@ sendScreenLockEvent(event: String, parameter: number): Promise\<boolean>
**返回值：**
| 类型 | 说明 |
| ------------------ | ------------------------------------------------------------ |
| 类型 | 说明 |
| ----------------- | ---------------------------------------------- |
| Promise\<boolean> | Promise对象，返回执行的结果。true表示执行成功，false表示执行失败。 |
**示例：**
......@@ -453,4 +278,177 @@ sendScreenLockEvent(event: String, parameter: number): Promise\<boolean>
screenlock.sendScreenLockEvent('unlockScreenResult', 0).then((result) => {
console.log('sending result:' + result);
});
```
\ No newline at end of file
```
## screenlock.isScreenLocked<sup>(deprecated)</sup>
isScreenLocked(callback: AsyncCallback&lt;boolean&gt;): void
判断屏幕是否锁屏，使用callback异步回调。
> **说明：**
>
>从 API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.isLocked<sup>9+</sup>](#screenlockislocked9)代替。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ----------------------------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回true表示屏幕已锁屏，返回false表示屏幕未锁屏。 |
**示例：**
```js
screenlock.isScreenLocked((err, data)=>{
if (err) {
console.error('isScreenLocked callback error -> ${JSON.stringify(err)}');
return;
}
console.info('isScreenLocked callback success data -> ${JSON.stringify(data)}');
});
```
## screenlock.isScreenLocked<sup>(deprecated)</sup>
isScreenLocked(): Promise&lt;boolean&gt;
判断屏幕是否锁屏，使用Promise异步回调。
> **说明：**
>
> 从API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.isLocked<sup>9+</sup>](#screenlockislocked9)代替。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**返回值：**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象，返回判断结果。返回true表示屏幕已锁屏，返回false表示屏幕未锁屏。 |
**示例：**
```js
screenlock.isScreenLocked().then((data) => {
console.log('isScreenLocked success: data -> ${JSON.stringify(data)}');
}).catch((err) => {
console.error('isScreenLocked fail, promise: err -> ${JSON.stringify(err)}');
});
```
## screenlock.isSecureMode<sup>(deprecated)</sup>
isSecureMode(callback: AsyncCallback&lt;boolean&gt;): void
判断设备是否处于安全模式下，使用callback异步回调。
> **说明：**
>
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.isSecure<sup>9+</sup>](#screenlockissecure9)代替。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------- | ---- | ------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。返回true表示屏幕处于安全模式下，返回false表示屏幕当前不在安全模式下。 |
**示例：**
```js
screenlock.isSecureMode((err, data)=>{
if (err) {
console.error('isSecureMode callback error -> ${JSON.stringify(err)}');
return;
}
console.info('isSecureMode callback success data -> ${JSON.stringify(err)}');
});
```
## screenlock.isSecureMode<sup>(deprecated)</sup>
isSecureMode(): Promise&lt;boolean&gt;
判断设备是否处于安全模式下，使用Promise异步回调。
> **说明：**
>
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.isSecure<sup>9+</sup>](#screenlockissecure9)代替。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**返回值：**
| 类型 | 说明 |
| ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | Promise对象。返回true表示屏幕处于安全模式下，返回false表示屏幕当前不在安全模式下。 |
**示例：**
```js
screenlock.isSecureMode().then((data) => {
console.log('isSecureMode success: data->${JSON.stringify(data)}');
}).catch((err) => {
console.error('isSecureMode fail, promise: err->${JSON.stringify(err)}');
});
```
## screenlock.unlockScreen<sup>(deprecated)</sup>
unlockScreen(callback: AsyncCallback&lt;void&gt;): void
解锁屏幕，使用callback异步回调。
> **说明：**
>
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.unlock<sup>9+</sup>](#screenlockunlock9)代替。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | --------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，失败时返回错误信息。 |
**示例：**
```js
screenlock.unlockScreen((err) => {
if (err) {
console.error('unlockScreen callback error -> ${JSON.stringify(err)}');
return;
}
console.info('unlockScreen callback success');
});
```
## screenlock.unlockScreen<sup>(deprecated)</sup>
unlockScreen(): Promise&lt;void&gt;
解锁屏幕，使用Promise异步回调。
> **说明：**
>
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[screenlock.unlock<sup>9+</sup>](#screenlockunlock9)代替。
**系统能力：** SystemCapability.MiscServices.ScreenLock
**返回值：**
| 类型 | 说明 |
| ------------------- | ------------------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
```js
screenlock.unlockScreen().then(() => {
console.log('unlockScreen success');
}).catch((err) => {
console.error('unlockScreen fail, promise: err->${JSON.stringify(err)}');
});
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或