Overview

Builder class for ShortcutInfoCompat objects.

Summary

Constructors

Methods

Sets the short title of a shortcut.

This is a mandatory field when publishing a new shortcut.

This field is intended to be a concise description of a shortcut.

The recommended maximum length is 10 characters.

Sets the text of a shortcut.

This field is intended to be more descriptive than the shortcut title. The launcher shows this instead of the short title when it has enough space.

The recommend maximum length is 25 characters.

Sets the message that should be shown when the user attempts to start a shortcut that is disabled.

See also: ShortcutInfo

Sets the intent of a shortcut. Alternatively, ShortcutInfoCompat.Builder.setIntents(Intent[]) can be used to launch an activity with other activities in the back stack.

This is a mandatory field when publishing a new shortcut.

The given intent can contain extras, but these extras must contain values of primitive types in order for the system to persist these values.

Sets multiple intents instead of a single intent, in order to launch an activity with other activities in back stack. Use to build intents. The last element in the list represents the only intent that doesn't place an activity on the back stack.

Sets an icon of a shortcut.

Sets the LocusIdCompat associated with this shortcut.

This method should be called when the LocusIdCompat is used in other places (such as NotificationCompat and ) so the device's intelligence services can correlate them.

Sets the corresponding fields indicating this shortcut is aimed for conversation.

If the shortcut is not associated with a LocusIdCompat, a LocusIdCompat based on ShortcutInfoCompat.getId() will be added upon ShortcutInfoCompat.Builder.build()

Additionally, the shortcut will be long-lived.

See also: ShortcutInfoCompat.Builder.setLongLived(boolean)

Sets the target activity. A shortcut will be shown along with this activity's icon on the launcher.

See also: ShortcutInfo

Badges the icon before passing it over to the Launcher.

Launcher automatically badges ShortcutInfo, so only the legacy shortcut icon, is badged. This field is ignored when using ShortcutInfo on API 25 and above.

If the shortcut is associated with an activity, the activity icon is used as the badge, otherwise application icon is used.

See also: ShortcutInfoCompat.Builder.setActivity(ComponentName)

Associate a person to a shortcut. Alternatively, ShortcutInfoCompat.Builder.setPersons(Person[]) can be used to add multiple persons to a shortcut.

This is an optional field when publishing a new shortcut.

See also: Person

Sets multiple persons instead of a single person.

Sets categories for a shortcut.

• Launcher apps may use this information to categorize shortcuts
• Used by the system to associate a published Sharing Shortcut with supported mimeTypes. Required for published Sharing Shortcuts with a matching category declared in share targets, defined in the app's manifest linked shortcuts xml file.

See also: ShortcutInfo

Deprecated: Use {@ink #setLongLived(boolean)) instead.

Sets if a shortcut would be valid even if it has been unpublished/invisible by the app (as a dynamic or pinned shortcut). If it is long lived, it can be cached by various system services even after it has been unpublished as a dynamic shortcut.

Sets which surfaces a shortcut will be excluded from. This API is reserved for future extension. Currently, marking a shortcut to be excluded from ShortcutInfoCompat.SURFACE_LAUNCHER will not publish the shortcut, thus the following operations will be a no-op: , , and .

On API <= 31, shortcuts that are excluded from ShortcutInfoCompat.SURFACE_LAUNCHER are not actually sent to . These shortcuts might still be made available to other surfaces via alternative means.

Sets rank of a shortcut, which is a non-negative value that's used by the system to sort shortcuts. Lower value means higher importance.

See also: for details.

Extras that the app can set for any purpose.

Apps can store arbitrary shortcut metadata in extras and retrieve the metadata later using ShortcutInfo.

See also: ShortcutInfo

Associates a shortcut with a capability without any parameters. Used when the shortcut is an instance of a capability.

This method can be called multiple times to associate multiple capabilities with this shortcut.

Parameters:

capability: capability associated with the shortcut. e.g. actions.intent .START_EXERCISE.

Associates a shortcut with a capability, and a parameter of that capability. Used when the shortcut is an instance of a capability.

This method can be called multiple times to associate multiple capabilities with this shortcut, or add multiple parameters to the same capability.

Parameters:

capability: capability associated with the shortcut. e.g. actions.intent .START_EXERCISE.
parameter: the parameter associated with the capability. e.g. exercise.name.
parameterValues: a list of values for that parameters. The first value will be the primary name, while the rest will be alternative names. If the values are empty, then the parameter will not be saved in the shortcut.

Sets the slice uri for a shortcut. The uri will be used if this shortcuts represents a slice, instead of an intent.

Creates a ShortcutInfoCompat instance.