• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.multimodalInput.inputEventClient (按键注入)
2
3按键注入模块，提供按键注入能力。
4
5> **说明：**
6>
7> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8>
9> - 本模块接口为系统接口。
10
11
12## 导入模块
13
14
15```js
16import inputEventClient from '@ohos.multimodalInput.inputEventClient';
17```
18
19
20## inputEventClient.injectEvent
21
22injectEvent({KeyEvent: KeyEvent}): void
23
24按键注入，当前仅支持返回键（键值2）注入。
25
26**系统能力：** SystemCapability.MultimodalInput.Input.InputSimulator
27
28**参数：**
29
30| 参数名       | 类型                    | 必填   | 说明        |
31| -------- | --------------------- | ---- | --------- |
32| KeyEvent | [KeyEvent](#keyevent) | 是    | 按键注入描述信息。 |
33
34**示例：**
35
36```js
37try {
38  let backKeyDown = {
39    isPressed: true,
40    keyCode: 2,
41    keyDownDuration: 0,
42    isIntercepted: false
43  }
44  inputEventClient.injectEvent({ KeyEvent: backKeyDown });
45
46  let backKeyUp = {
47    isPressed: false,
48    keyCode: 2,
49    keyDownDuration: 0,
50    isIntercepted: false
51  };
52  inputEventClient.injectEvent({ KeyEvent: backKeyUp });
53} catch (error) {
54  console.log(`Failed to inject KeyEvent, error: ${JSON.stringify(error, [`code`, `message`])}`);
55}
56```
57
58
59## KeyEvent
60
61按键注入描述信息。
62
63**系统能力：** SystemCapability.MultimodalInput.Input.InputSimulator
64
65| 名称        | 类型   | 可读   | 可写   | 说明      |
66| --------- | ------ | ---- | ---- | ------- |
67| isPressed       | boolean | 是    |  否 | 按键是否按下。               |
68| keyCode         | number  | 是    |  否 | 按键键值，当前只支持back键。 |
69| keyDownDuration | number  | 是    |  否 | 按键按下持续时间。           |
70| isIntercepted   | boolean | 是    |  否 | 按键是否可以被拦截。         |
71
72