• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#  @ohos.multimodalInput.shortKey(快捷键)
2
3通过本模块接口，可以设置快捷键拉起Ability的延迟时间，如设置长按快捷键3s后进行截屏等。
4
5> **说明：**
6>
7> - 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8> - 本模块接口为系统接口。
9
10##  导入模块
11
12```
13import shortKey from '@ohos.multimodalInput.shortKey';
14```
15
16##  shortKey.setKeyDownDuration
17
18setKeyDownDuration(businessKey: string, delay: number, callback: AsyncCallback<void>): void
19
20设置快捷键拉起Ability的延迟时间，使用AsyncCallback异步方式返回结果。
21
22**系统能力**：SystemCapability.MultimodalInput.Input.ShortKey
23
24**参数**：
25
26| 参数名     | 类型                | 必填 | 说明                                                         |
27| ---------- | ------------------- | ---- | ------------------------------------------------------------ |
28| businessKey| string              | 是   | 业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应 |
29| delay      | number              | 是   | 该值仅支持快捷键按下触发，表示按下快捷键多长时间后拉起Ability，单位是毫秒（ms） |
30| callback   | AsyncCallback<void> | 是   | 回调函数。                                                   |
31
32**示例**：
33
34```
35try {
36  shortKey.setKeyDownDuration("screenshot", 500, (error) => {
37    if (error) {
38      console.log(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
39      return;
40    }
41    console.log(`Set key down duration success`);
42  });
43} catch (error) {
44  console.log(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
45}
46```
47
48
49
50## shortKey.setKeyDownDuration
51
52setKeyDownDuration(businessKey: string, delay: number): Promise<void>
53
54设置快捷键拉起Ability的延迟时间，使用Promise异步方式返回结果。
55
56**系统能力**：SystemCapability.MultimodalInput.Input.ShortKey
57
58**参数**：
59
60| 参数名     | 类型   | 必填 | 说明                                                         |
61| ---------- | ------ | ---- | ------------------------------------------------------------ |
62| businessKey| string | 是   | 业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应 |
63| delay      | number | 是   | 该值仅支持快捷键按下触发，表示按下快捷键多长时间后拉起Ability，单位是毫秒（ms） |
64
65**返回值**：
66
67| 参数          | 说明          |
68| ------------- | ------------- |
69| Promise<void> | Promise对象。 |
70
71**示例**：
72
73```
74try {
75  shortKey.setKeyDownDuration("screenshot", 500).then(() => {
76    console.log(`Set key down duration success`);
77  });
78} catch (error) {
79  console.log(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
80}
81```
82