1#  @ohos.multimodalInput.shortKey(快捷键)(系统接口)
2
3通过本模块接口，可以设置快捷键拉起Ability的延迟时间，如设置长按快捷键3s后再截屏等。
4
5> **说明：**
6>
7> - 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8>
9> - 本模块接口为系统接口。
10
11##  导入模块
12
13```js
14import { shortKey } from '@kit.InputKit';
15```
16
17##  shortKey.setKeyDownDuration
18
19setKeyDownDuration(businessKey: string, delay: number, callback: AsyncCallback<void>): void
20
21设置快捷键拉起Ability的延迟时间，使用Callback异步回调。
22
23**系统能力**：SystemCapability.MultimodalInput.Input.ShortKey
24
25**参数**：
26
27| 参数名     | 类型                | 必填 | 说明                                                         |
28| ---------- | ------------------- | ---- | ------------------------------------------------------------ |
29| businessKey| string              | 是   | 业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应。调用接口前自行查询。|
30| delay      | number              | 是   | 按下快捷键多长时间后拉起Ability，单位是毫秒（ms），仅支持快捷键按下触发。 |
31| callback   | AsyncCallback<void> | 是   | 回调函数，设置成功时，err为undefined，否则为错误对象。  |
32
33**错误码**：
34
35以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
36
37| 错误码ID  | 错误信息             |
38| ---- | --------------------- |
39| 202  | SystemAPI permission error.  |
40| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
41
42**示例**：
43
44```js
45import { shortKey } from '@kit.InputKit';
46try {
47  shortKey.setKeyDownDuration("businessId", 500, (error) => {
48    if (error) {
49      console.log(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
50      return;
51    }
52    console.log(`Set key down duration success`);
53  });
54} catch (error) {
55  console.log(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
56}
57```
58
59## shortKey.setKeyDownDuration
60
61setKeyDownDuration(businessKey: string, delay: number): Promise<void>
62
63设置快捷键拉起Ability的延迟时间，使用Promise异步回调。
64
65**系统能力**：SystemCapability.MultimodalInput.Input.ShortKey
66
67**参数**：
68
69| 参数名     | 类型   | 必填 | 说明                                                         |
70| ---------- | ------ | ---- | ------------------------------------------------------------ |
71| businessKey| string | 是   | 业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应。调用接口前自行查询。|
72| delay      | number | 是   | 按下快捷键多长时间后拉起Ability，单位是毫秒（ms），仅支持快捷键按下触发。 |
73
74**返回值**：
75
76| 参数          | 说明          |
77| ------------- | ------------- |
78| Promise<void> | 无返回结果的Promise对象。 |
79
80**错误码**：
81
82以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
83
84| 错误码ID  | 错误信息             |
85| ---- | --------------------- |
86| 202  | SystemAPI permission error.  |
87| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
88
89**示例**：
90
91```js
92import { shortKey } from '@kit.InputKit';
93try {
94  shortKey.setKeyDownDuration("businessId", 500).then(() => {
95    console.log(`Set key down duration success`);
96  });
97} catch (error) {
98  console.log(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
99}
100```
101
102## FingerprintAction<sup>12+</sup>
103
104按键事件类型的枚举。
105
106**系统能力：** SystemCapability.MultimodalInput.Input.Core
107
108| 名称                 | 值          | 说明                |
109| ---------------------| ---------- | --------------------|
110| DOWN                 | 0x00000000 | 按下事件。           |
111| UP                   | 0x00000001 | 抬起事件。           |
112| SLIDE                | 0x00000002 | 滑动事件。           |
113| RETOUCH              | 0x00000003 | 滑动事件。           |
114| CLICK                | 0x00000004 | 点击事件。           |
115
116
117## FingerprintEvent<sup>12+</sup>
118
119按键事件的类型和相对按键的偏移位置。
120
121**系统能力：** SystemCapability.MultimodalInput.Input.Core
122
123| 名称      | 类型                                       |只读   | 可选  |说明                    |
124| --------  | ------------------------                  |-------|------ |--------               |
125| action    | [FingerprintAction](#fingerprintaction12)   | 是    |  否   |按键事件类型。           |
126| distanceX | number                                    | 是    |  否   |相对于光标位置的x轴偏移量（正数表示向右移动，负数表示向左移动）。 |
127| distanceY | number                                    | 是    |  否   |相对于光标位置的y轴偏移量（正数表示向上移动，负数表示向下移动）。 |
128