js-apis-inputeventclient.md 1.9 KB
Newer Older
1
# @ohos.multimodalInput.inputEventClient (按键注入)
M
mayunteng_1 已提交
2

3
按键注入模块,提供按键注入能力。
M
mayunteng_1 已提交
4

H
HelloCrease 已提交
5
> **说明:**
M
mayunteng_1 已提交
6
>
H
hungry_feiwei 已提交
7
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
M
mayunteng_1 已提交
8
>
H
HelloCrease 已提交
9
> - 本模块接口为系统接口。
M
mayunteng_1 已提交
10 11 12 13 14


## 导入模块


H
HelloCrease 已提交
15
```js
M
mayunteng_1 已提交
16 17 18 19
import inputEventClient from '@ohos.multimodalInput.inputEventClient';
```


20 21 22
## inputEventClient.injectEvent

injectEvent({KeyEvent: KeyEvent}): void
M
mayunteng_1 已提交
23

24
按键注入,当前仅支持返回键(键值2)注入。
M
mayunteng_1 已提交
25 26 27 28 29

**系统能力:** SystemCapability.MultimodalInput.Input.InputSimulator

**参数:**

M
mayunteng_1 已提交
30
| 参数名       | 类型                    | 必填   | 说明        |
31
| -------- | --------------------- | ---- | --------- |
32
| KeyEvent | [KeyEvent](#keyevent) | 是    | 按键注入描述信息。 |
M
mayunteng_1 已提交
33 34 35

**示例:**

36
```js
M
mayunteng_1 已提交
37
try {
38
  let backKeyDown = {
M
mayunteng_1 已提交
39 40 41 42
    isPressed: true,
    keyCode: 2,
    keyDownDuration: 0,
    isIntercepted: false
M
mayunteng_1 已提交
43
  }
M
mayunteng_1 已提交
44
  inputEventClient.injectEvent({ KeyEvent: backKeyDown });
45 46

  let backKeyUp = {
M
mayunteng_1 已提交
47 48 49 50 51
    isPressed: false,
    keyCode: 2,
    keyDownDuration: 0,
    isIntercepted: false
  };
M
mayunteng_1 已提交
52
  inputEventClient.injectEvent({ KeyEvent: backKeyUp });
M
mayunteng_1 已提交
53
} catch (error) {
54
  console.log(`Failed to inject KeyEvent, error: ${JSON.stringify(error, [`code`, `message`])}`);
M
mayunteng_1 已提交
55 56 57 58 59 60
}
```


## KeyEvent

61
按键注入描述信息。
H
hungry_feiwei 已提交
62

H
HelloCrease 已提交
63
**系统能力:** SystemCapability.MultimodalInput.Input.InputSimulator
M
mayunteng_1 已提交
64

M
mayunteng_1 已提交
65 66 67 68 69 70
| 名称        | 类型   | 可读   | 可写   | 说明      |
| --------- | ------ | ---- | ---- | ------- |
| isPressed       | boolean | 是    |  否 | 按键是否按下。               |
| keyCode         | number  | 是    |  否 | 按键键值,当前只支持back键。 |
| keyDownDuration | number  | 是    |  否 | 按键按下持续时间。           |
| isIntercepted   | boolean | 是    |  否 | 按键是否可以被拦截。         |
71