@ohos.multimodalInput.shortKey (Preset Global Shortcut Keys) (System API)

The shortKey module provides APIs to set the delay for starting an ability using a shortcut key. For example, you can set the delay to 3 seconds so that a screenshot is taken when you press and hold the shortcut key for 3 seconds.

NOTE

The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The APIs provided by this module are system APIs.

Modules to Import

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

shortKey.setKeyDownDuration

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

Sets the delay for starting an ability using shortcut keys. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.ShortKey

Parameters

Name	Type	Mandatory	Description
businessKey	string	Yes	Unique service ID registered on the multimodal side. It corresponds to businessId in the ability_launch_config.json file. You need to query this parameter on your own before calling the API.
delay	number	Yes	Delay for starting an ability using shortcut keys, in milliseconds. This field is invalid only when shortcut keys are used.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  shortKey.setKeyDownDuration("businessId", 500, (error) => {
    if (error) {
      console.error(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Set key down duration success`);
  });
} catch (error) {
  console.error(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

shortKey.setKeyDownDuration

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

Sets the delay for starting an ability using shortcut keys. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.ShortKey

Parameters

Name	Type	Mandatory	Description
businessKey	string	Yes	Unique service ID registered on the multimodal side. It corresponds to businessId in the ability_launch_config.json file. You need to query this parameter on your own before calling the API.
delay	number	Yes	Delay for starting an ability using shortcut keys, in milliseconds. This field is invalid only when shortcut keys are used.

Return value

Parameters	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  shortKey.setKeyDownDuration("businessId", 500).then(() => {
    console.log(`Set key down duration success`);
  });
} catch (error) {
  console.error(`Set key down duration failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

FingerprintAction¹²⁺

Enumerates key event types.

System capability: SystemCapability.MultimodalInput.Input.Core

Name	Value	Description
DOWN	0x00000000	Pressing down
UP	0x00000001	Lifting up
SLIDE	0x00000002	Sliding
RETOUCH	0x00000003	Retouching
CLICK	0x00000004	Clicking

FingerprintEvent¹²⁺

Defines the key event type and the offset position relative to the key.

System capability: SystemCapability.MultimodalInput.Input.Core

Name	Type	Read Only	Optional	Description
action	FingerprintAction	Yes	No	Key event type.
distanceX	number	Yes	No	Offset position on the X axis. A positive number indicates that the pointer moves rightward, and a negative number indicates that the cursor moves leftward.
distanceY	number	Yes	No	Offset position on the Y axis. A positive number indicates that the pointer moves upward, and a negative number indicates that the cursor moves downward.