diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index d847562dac895b65ffe9447c102d990f521b31d6..33a1ff4e1e4d9fa981302784021ef67592324fa4 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -80,6 +80,7 @@ - [输入设备](js-apis-inputdevice.md) - [组合按键](js-apis-inputconsumer.md) - [输入监听](js-apis-inputmonitor.md) + - [事件注入](js-apis-inputeventclient.md) - 基本功能 - [应用上下文](js-apis-system-app.md) - [日志打印](js-apis-basic-features-logs.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md index 8d07bea3498faf2e95abf23fd428b9af7caae921..65c71a03bf58d7f298a1a9d751275be6f10f5609 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md +++ b/zh-cn/application-dev/reference/apis/js-apis-inputdevice.md @@ -24,11 +24,12 @@ getDeviceIds(callback: AsyncCallback<Array<number>>): void **系统能力：** SystemCapability.MultimodalInput.Input.InputDevice -**参数：** +**参数：** -| 参数 | 类型 | 必填 | 说明 | +| 参数 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<Array<number>> | 是 | 回调函数。 | +| callback | AsyncCallback<Array<number>> | 是 | 回调函数。 | + **示例：** @@ -46,6 +47,37 @@ testGetDeviceIds: function () { } ``` +## inputDevice.getDeviceIds + +function getDeviceIds(): Promise> + +获取所有输入设备的id列表，使用Promise方式作为异步方法。 + +**系统能力：** SystemCapability.MultimodalInput.Input.InputDevice + +**返回值：** + +| 参数 | 说明 | +| -------- | -------- | +| Promise> | Promise实例，用于异步获取结果 | + +**示例：** + +``` +testGetDeviceIds: function () { + console.info("InputDeviceJsTest---start---testGetDeviceIds"); + let promise = inputDevice.getDeviceIds(); + promise.then((data)=> { + console.info('GetDeviceIds successed, Data: ' + JSON.stringify(data)) + }).catch((err)=>{ + console.error('Failed GetDeviceIds. Cause: ' + JSON.stringify(err)); + }); +} +``` + + + + ## inputDevice.getDevice @@ -57,10 +89,10 @@ getDevice(deviceId: number, callback: AsyncCallback<InputDeviceData>): voi **参数：** -| 参数 | 类型 | 必填 | 说明 | +| 参数 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| deviceId | number | 是 | 需要获取信息的设备id。 | -| callback | AsyncCallback<[InputDeviceData](#inputdevicedata)> | 是 | 回调函数，异步返回InputDeviceData对象。 | +| deviceId | number | 是 | 需要获取信息的设备id。 | +| callback | AsyncCallback<[InputDeviceData](#inputdevicedata)> | 是 | 回调函数，异步返回InputDeviceData对象。 | **示例：** @@ -82,30 +114,84 @@ testGetDevice: function () { } ``` +## inputDevice.getDevice + +function getDevice(deviceId: number): Promise + +获取输入设备的描述信息，使用Promise方式作为异步方法。 + +**系统能力：** SystemCapability.MultimodalInput.Input.InputDevice + +**返回值：** + +| 参数 | 说明 | +| -------- | -------- | +| Promise | Promise实例，用于异步获取结果 | + +**示例：** + +``` +InputDeviceData { + deviceId : 0, + name : "NA", + sources : Array, + axisRanges : Array, +}, +testGetDevice: function () { + // 示例获取设备id为1的设备信息。 + console.info("InputDeviceJsTest---start---testGetDevice"); + let promise = inputDevice.getDevice(1); + promise.then((data)=> { + console.info('GetDeviceId successed, Data: ' + JSON.stringify(data)) + }).catch((err)=>{ + console.error('Failed GetDeviceId. Cause: ' + JSON.stringify(err)); + }); +} +``` + + ## InputDeviceData 输入设备的描述信息。 -**系统能力：** 以下各项对应系统能力均为SystemCapability.MultimodalInput.Input.InputDevice +**系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice - | 名称 | 参数类型 | 说明 | +| 名称 | 参数类型 | 说明 | | -------- | -------- | -------- | -| id | number | 输入设备的唯一标识，同一个物理设备反复插拔，其设备id会发生变化。 | -| name | string | 输入设备的名字。 | +| id | number | 输入设备的唯一标识，同一个物理设备反复插拔，其设备id会发生变化。 | +| name | string | 输入设备的名字。 | | sources | Array<[SourceType](#sourcetype)> | 输入设备支持的源类型。比如有的键盘上附带触摸板，则此设备有keyboard和touchpad两种输入源。 | +## AxisType + +轴类型，本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 + +## AxisRange + +输入设备的轴信息 + +**系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice + +| 名称 | 参数类型 | 说明 | +| ------ | ------------------------- | ---------------- | +| source | [SourceType](#sourcetype) | 轴的输入源类型。 | +| axis | [AxisType](axistype) | 轴的类型 | +| max | number | 轴上报的最大值 | +| min | number | 轴上报的最小值 | + + ## SourceType 定义这个轴的输入源类型。比如鼠标设备可上报x轴事件，则x轴的源就是鼠标。 -**系统能力：** 以下各项对应系统能力均为SystemCapability.MultimodalInput.Input.InputDevice +**系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputDevice - | 名称 | 参数类型 | 说明 | +| 名称 | 参数类型 | 说明 | | -------- | -------- | -------- | | keyboard | string | 表示输入设备是键盘。 | -| touchscreen | string | 表示输入设备是触摸屏。 | +| touchscreen | string | 表示输入设备是触摸屏。 | | mouse | string | 表示输入设备是鼠标。 | | trackball | string | 表示输入设备是轨迹球。 | | touchpad | string | 表示输入设备是触摸板。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md b/zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md new file mode 100644 index 0000000000000000000000000000000000000000..5a06a6a68c97ac82d65443df0e822607ff7a6796 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-inputeventclient.md @@ -0,0 +1,57 @@ +# 注入按键 + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> +> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> +> - 本模块接口均为系统接口，三方应用不支持调用。 + + +## 导入模块 + + +``` +import inputEventClient from '@ohos.multimodalInput.inputEventClient'; +``` + + +## inputEventClient.injectEvent + +injectEvent({KeyEvent: KeyEvent}): void + +注入按键，KeyEvent为注入按键的描述信息。 + +**系统能力：** SystemCapability.MultimodalInput.Input.InputSimulator + +**参数：** + +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| KeyEvent | [KeyEvent](#keyevent) | 是 | 注入按键的描述信息 | + +**示例：** + +``` +let keyEvent = { + isPressed: true, + keyCode: 2, + keyDownDuration: 0, + isIntercepted: false +} +res = inputEventClient.injectEvent({KeyEvent: keyEvent}); +``` + + +## KeyEvent + +注入按键的描述信息 + +**系统能力：** 以下各项对应的系统能力均为SystemCapability.MultimodalInput.Input.InputSimulator + +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| isPressed | boolean | 是 | 按键是否按下 | +| keyCode | Number | 是 | 按键键值 | +| keyDownDuration | boolean | 是 | 按键按下持续时间 | +| isIntercepted | Number | 是 | 按键是否可以被拦截 |