Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
50429154
D
Docs
项目概览
OpenHarmony
/
Docs
12 个月 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
50429154
编写于
9月 24, 2022
作者:
O
openharmony_ci
提交者:
Gitee
9月 24, 2022
浏览文件
操作
浏览文件
下载
差异文件
!9843 screenlock API 变更
Merge pull request !9843 from qimeng/master
上级
c4aaca1e
cd601252
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
45 addition
and
75 deletion
+45
-75
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
+45
-75
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-screen-lock.md
浏览文件 @
50429154
...
...
@@ -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>
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录