• 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: inputEventClient.KeyEvent = {
39    isPressed: true,
40    keyCode: 2,
41    keyDownDuration: 0,
42    isIntercepted: false
43  }
44
45  class EventDown {
46    KeyEvent: inputEventClient.KeyEvent | null = null
47  }
48
49  let eventDown: EventDown = { KeyEvent: backKeyDown }
50  inputEventClient.injectEvent(eventDown);
51
52  let backKeyUp: inputEventClient.KeyEvent = {
53    isPressed: false,
54    keyCode: 2,
55    keyDownDuration: 0,
56    isIntercepted: false
57  };
58
59  class EventUp {
60    KeyEvent: inputEventClient.KeyEvent | null = null
61  }
62
63  let eventUp: EventUp = { KeyEvent: backKeyUp }
64  inputEventClient.injectEvent(eventUp);
65} catch (error) {
66  console.log(`Failed to inject KeyEvent, error: ${JSON.stringify(error, [`code`, `message`])}`);
67}
68```
69
70
71## KeyEvent
72
73按键注入描述信息。
74
75**系统能力：** SystemCapability.MultimodalInput.Input.InputSimulator
76
77| 名称        | 类型   | 可读   | 可写   | 说明      |
78| --------- | ------ | ---- | ---- | ------- |
79| isPressed       | boolean | 是    |  否 | 按键是否按下。               |
80| keyCode         | number  | 是    |  否 | 按键键值，当前只支持back键。 |
81| keyDownDuration | number  | 是    |  否 | 按键按下持续时间。           |
82| isIntercepted   | boolean | 是    |  否 | 按键是否可以被拦截。         |
83
84