From 267f81efe0657b41d4fad47c2e04fb28e049ad6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=99=BD=E9=9C=B2?= Date: Mon, 21 Feb 2022 10:43:55 +0800 Subject: [PATCH] =?UTF-8?q?inputConsumer=E6=8E=A5=E5=8F=A3=E8=B5=84?= =?UTF-8?q?=E6=96=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: bailu1992 --- .../reference/apis/js-apis-inputConsumer.md | 87 +++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-inputConsumer.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputConsumer.md b/zh-cn/application-dev/reference/apis/js-apis-inputConsumer.md new file mode 100644 index 00000000000..8eec99d9f88 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inputConsumer.md @@ -0,0 +1,87 @@ +# 系统按键订阅 + +> ![icon-note.gif](D:\Users\bailu\Desktop\inputConsumer\docs\zh-cn\application-dev\reference\apis\public_sys-resources\icon-note.gif) **说明:** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 + + +## 导入模块 + +``` +import inputConsumer from '@ohos.multimodalinput.inputConsumer'; +``` + + +## 权限 + +无 + + +## inputConsumer.on + +on(type: string, keyOption: KeyOptions, callback: AsyncCallback): void + +订阅系统按键。 + +- 参数: + + | 参数名 | 类型 | 必填 | 说明 | + | --------- | --------------------------- | ---- | ---------------------------- | + | type | string | 是 | 描述订阅类型,比如按键。 | + | keyOption | [KeyOptions](#KeyOptions) | 是 | 需要订阅的按键事件。 | + | callback | AsyncCallback): | 是 | 当按键触发,回调到此函数上。 | + +- 示例: + + ``` + callback(err,data) { + if (err) { + // 订阅、取消订阅失败 + } else if (data) { + // 订阅按键触发回调 + that.time = new Date(); + } else { + // 取消订阅成功 + } + }, + inputConsumer.on("key", {preKeys:[],'finalKey':22, 'isFinalKeyDown':true,'finalKeyDownDuration':0}, ,this.callback); + ``` + +## inputConsumer.off + +off(type: string, keyOption: KeyOptions, callback: AsyncCallback): void + +取消订阅系统按键。 + +- 参数: + + | 参数名 | 类型 | 必填 | 说明 | + | --------- | --------------------------- | ---- | ---------------------------- | + | type | string | 是 | 描述订阅类型,比如按键。 | + | keyOption | [KeyOptions](#KeyOptions) | 是 | 需要订阅的按键事件。 | + | callback | AsyncCallback): | 是 | 当按键触发,回调到此函数上。 | + +- 示例: + + ``` + callback(err,data) { + if (err) { + // 订阅、取消订阅失败 + } else if (data) { + // 取消订阅按键触发回调 + } else { + // 取消订阅成功 + } + }, + inputConsumer.off("key", {preKeys:[],'finalKey':18, 'isFinalKeyDown':true,'finalKeyDownDuration':0}, ,this.callback); + ``` + +## KeyOptions + +按键事件。 + +| 参数名 | 类型 | 必填 | 说明 | +| -------------------- | ------------- | ---- | ------------------------------------------------------------ | +| preKeys | Array | 否 | 前置按键。 | +| finalKey | number | 否 | 最后一个按键。 | +| isFinalKeyDown | boolean | 否 | 最后一个按键按下或者抬起触发。 | +| finalKeyDownDuration | number | 否 | 若按下触发,表示最后一个按键按下如此长时间后触发;若抬起触发,表示最后一个按键到抬起如此长时间内触发。 | -- Gitee