Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
70d04a8f
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
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看板
未验证
提交
70d04a8f
编写于
8月 18, 2023
作者:
N
ningning
提交者:
Gitee
8月 18, 2023
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md.
Signed-off-by:
N
ningning
<
wangningning14@huawei.com
>
上级
f02270a1
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
9 addition
and
13 deletion
+9
-13
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
...n/application-dev/reference/apis/js-apis-inputconsumer.md
+9
-13
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-inputconsumer.md
浏览文件 @
70d04a8f
...
@@ -8,18 +8,15 @@
...
@@ -8,18 +8,15 @@
>
>
> - 本模块接口为系统接口。
> - 本模块接口为系统接口。
## 导入模块
## 导入模块
```
js
```
js
import
inputConsumer
from
'
@ohos.multimodalInput.inputConsumer
'
;
import
inputConsumer
from
'
@ohos.multimodalInput.inputConsumer
'
;
```
```
## inputConsumer.on
## inputConsumer.on
on(type:
"key"
, keyOptions: KeyOptions, callback: Callback
<
KeyOptions
>
): void
on(type:
'key'
, keyOptions: KeyOptions, callback: Callback
<
KeyOptions
>
): void
订阅组合按键,当满足条件的组合按键输入事件发生时,使用Callback异步方式上报组合按键数据。
订阅组合按键,当满足条件的组合按键输入事件发生时,使用Callback异步方式上报组合按键数据。
...
@@ -29,7 +26,7 @@ on(type: "key", keyOptions: KeyOptions, callback: Callback<KeyOptions>): v
...
@@ -29,7 +26,7 @@ on(type: "key", keyOptions: KeyOptions, callback: Callback<KeyOptions>): v
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------- | ---- | ---------------------------------------- |
| ---------- | -------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 事件类型,目前
只支持”key“
。 |
| type | string | 是 | 事件类型,目前
仅支持'key'
。 |
| keyOptions |
[
KeyOptions
](
#keyoptions
)
| 是 | 组合键选项。 |
| keyOptions |
[
KeyOptions
](
#keyoptions
)
| 是 | 组合键选项。 |
| callback | Callback
<
KeyOptions
>
| 是 | 回调函数,当满足条件的组合按键输入事件发生时,异步上报组合按键数据。 |
| callback | Callback
<
KeyOptions
>
| 是 | 回调函数,当满足条件的组合按键输入事件发生时,异步上报组合按键数据。 |
...
@@ -50,7 +47,7 @@ try {
...
@@ -50,7 +47,7 @@ try {
## inputConsumer.off
## inputConsumer.off
off(type:
"key"
, keyOptions: KeyOptions, callback?: Callback
<
KeyOptions
>
): void
off(type:
'key'
, keyOptions: KeyOptions, callback?: Callback
<
KeyOptions
>
): void
取消订阅组合按键。
取消订阅组合按键。
...
@@ -60,9 +57,9 @@ off(type: "key", keyOptions: KeyOptions, callback?: Callback<KeyOptions>):
...
@@ -60,9 +57,9 @@ off(type: "key", keyOptions: KeyOptions, callback?: Callback<KeyOptions>):
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------- | ---- | ------------------------------- |
| ---------- | -------------------------- | ---- | ------------------------------- |
| type | string | 是 | 事件类型,当前
只支持”key“
。 |
| type | string | 是 | 事件类型,当前
仅支持 'key'
。 |
| keyOptions |
[
KeyOptions
](
#keyoptions
)
| 是 | 组合键选项。 |
| keyOptions |
[
KeyOptions
](
#keyoptions
)
| 是 | 组合键选项。 |
| callback | Callback
<
KeyOptions
>
| 否 | 需要取消订阅的回调函数
,若无此参数,则取消当前应用的
组合键选项已订阅的所有回调函数。 |
| callback | Callback
<
KeyOptions
>
| 否 | 需要取消订阅的回调函数
。若不填,则取消当前应用
组合键选项已订阅的所有回调函数。 |
**示例:**
**示例:**
...
@@ -99,7 +96,6 @@ try {
...
@@ -99,7 +96,6 @@ try {
}
}
```
```
## KeyOptions
## KeyOptions
组合键选项。
组合键选项。
...
@@ -108,7 +104,7 @@ try {
...
@@ -108,7 +104,7 @@ try {
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ------ | ---- | ---- | ------- |
| --------- | ------ | ---- | ---- | ------- |
| preKeys
| Array
\<
number> | 是 | 否 | 前置按键集合,数量范围[0, 4],前置按键无顺序要求
。 |
| preKeys
| Array
\<
number> | 是 | 否 | 前置按键集合,数量范围[0, 4],前置按键无顺序要求。
<br>
如组合按键Ctrl+Alt+A中,Ctrl+Alt称为前置按键
。 |
| finalKey | number | 是 | 否 | 最终按键,此项必填,最终按键触发上报回调函数。 |
| finalKey | number | 是 | 否 | 最终按键,此项必填,最终按键触发上报回调函数。
<br>
如组合按键Ctrl+Alt+A中,A称为最终按键按键。
|
| isFinalKeyDown | boolean | 是 | 否 | 最终按键状态。 |
| isFinalKeyDown | boolean | 是 | 否 | 最终按键状态。
<br>
ture表示按键按下,false表示按键抬起。
|
| finalKeyDownDuration | number | 是 | 否 | 最终按键保持按下持续时间,
为0时立即触发回调函数,大于0时,当isFinalKeyDown为true,则最终按键按下超过此时长后触发回调函数,当isFinalKeyDown为false,则最终按键按下到抬起时间小于此
时长时触发回调函数。 |
| finalKeyDownDuration | number | 是 | 否 | 最终按键保持按下持续时间,
单位为微秒(μs)。
<br>
当finalKeyDownDuration为0时,立即触发回调函数。
<br>
当finalKeyDownDuration大于0时,isFinalKeyDown为true,则最终按键按下超过设置时长后触发回调函数;isFinalKeyDown为false,则最终按键按下到抬起时间小于设置
时长时触发回调函数。 |
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录