@ohos.multimodalInput.shortKey (系统预置全局快捷键)(系统接口)

通过本模块接口，可以设置快捷键拉起Ability的延迟时间，如设置长按快捷键3s后再截屏等。

说明：

• 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

• 本模块接口为系统接口。

导入模块

import { shortKey } from '@kit.InputKit';

shortKey.setKeyDownDuration

setKeyDownDuration(businessKey: string, delay: number, callback: AsyncCallback<void>): void

设置快捷键拉起Ability的延迟时间，使用callback异步回调。

系统能力：SystemCapability.MultimodalInput.Input.ShortKey

参数：

参数名	类型	必填	说明
businessKey	string	是	业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应。调用接口前自行查询。
delay	number	是	按下快捷键多长时间后拉起Ability，单位：ms，仅支持快捷键按下触发。
callback	AsyncCallback<void>	是	回调函数。当设置快捷键拉起Ability的延迟时间成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { shortKey } from '@kit.InputKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 设置延迟拉起时间500ms
            shortKey.setKeyDownDuration("businessId", 500, (error: BusinessError) => {
              if (error) {
                console.error(`Failed to set key down duration, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
                return;
              }
              console.info(`Succeeded in setting key down duration.`);
            });
          } catch (error) {
            console.error(`Failed to set key down duration, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

shortKey.setKeyDownDuration

setKeyDownDuration(businessKey: string, delay: number): Promise<void>

设置快捷键拉起Ability的延迟时间，使用Promise异步回调。

系统能力：SystemCapability.MultimodalInput.Input.ShortKey

参数：

参数名	类型	必填	说明
businessKey	string	是	业务在多模侧注册的唯一标识，与ability_launch_config.json中的businessId对应。调用接口前自行查询。
delay	number	是	按下快捷键多长时间后拉起Ability，单位：ms，仅支持快捷键按下触发。

返回值：

类型	说明
Promise<void>	Promise对象，无返回结果。

错误码：

以下错误码的详细介绍请参见通用错误码。

错误码ID	错误信息
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { shortKey } from '@kit.InputKit';
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Index {
  build() {
    RelativeContainer() {
      Text()
        .onClick(() => {
          try {
            // 设置延迟拉起时间500ms
            shortKey.setKeyDownDuration("businessId", 500).then(() => {
              console.info(`Succeeded in setting key down duration.`);
            }).catch((error: BusinessError) => {
              console.error(`Failed to set key down, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
            })
          } catch (error) {
            console.error(`Failed to set key down duration, Code: ${(error as BusinessError).code}, message: ${(error as BusinessError).message}.`);
          }
        })
    }
  }
}

FingerprintAction¹²⁺

指纹手势事件类型的枚举。

系统能力： SystemCapability.MultimodalInput.Input.Core

名称	值	说明
DOWN	0	按下事件。
UP	1	抬起事件。
SLIDE	2	滑动事件。
RETOUCH	3	第二次按下事件。
CLICK	4	双触事件。

FingerprintEvent¹²⁺

指纹手势事件的类型和相对侧边指纹器件的偏移位置。

系统能力： SystemCapability.MultimodalInput.Input.Core

名称	类型	只读	可选	说明
action	FingerprintAction	否	否	指纹手势事件类型的枚举。
distanceX	number	否	否	相对于侧边指纹器件短轴偏移量（正数表示向右移动，负数表示向左移动）。
distanceY	number	否	否	相对于侧边指纹器件长轴偏移量（正数表示向上移动，负数表示向下移动）。