ShortcutInfo

The module describes the shortcut information defined in the module.json5 file of an application. The information can be obtained by running getAllShortcutInfoForSelf or getShortcutInfo.

NOTE

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

Modules to Import

import { shortcutManager } from '@kit.AbilityKit';

ShortcutWant

Describes a collection of target Wants information defined within a shortcut.

System capability: SystemCapability.BundleManager.BundleFramework.Launcher

Name	Type	Read-Only	Optional	Description
targetBundle	string	No	No	Target bundle name of the shortcut.
targetModule	string	No	Yes	Target module name of the shortcut.
targetAbility	string	No	No	Target ability name of the shortcut.
parameters	Array<ParameterItem>	No	Yes	Custom data for launching the shortcut. The data must be strings. Both keys and values can be strings up to 1024 characters long.

ShortcutInfo

Describes the configuration information for a shortcut.

System capability: SystemCapability.BundleManager.BundleFramework.Launcher

Name	Type	Read-Only	Optional	Description
id	string	No	No	ID of the shortcut.
bundleName	string	No	No	Bundle name of the application to which the shortcut belongs.
moduleName	string	No	Yes	Module name of the shortcut.
hostAbility	string	No	Yes	Name of the ability that hosts the shortcut.
icon	string	No	Yes	Icon of the shortcut. The value is the index of a resource file.
iconId	number	No	Yes	Resource ID of the shortcut icon.
label	string	No	Yes	Label of the shortcut. The value can be descriptive text or a resource index.
labelId	number	No	Yes	Resource ID of the shortcut label.
wants	Array<ShortcutWant>	No	Yes	A collection of target Wants information defined within the shortcut.
appIndex	number	No	No	Index of the application clone to which the shortcut belongs.
sourceType	number	No	No	Source type of the shortcut. The value 0 means a custom shortcut, 1 means a static shortcut, and 2 means a dynamic shortcut. Dynamic shortcuts are supported since API version 23.
visible	boolean	No	Yes	Whether the shortcut is visible. true if visible, false otherwise. The default value is true.