ShortcutInfoCompat

public static final int SURFACE_LAUNCHER = 1

Indicates system surfaces managed by a launcher app. e.g. Long-Press Menu.

public @Nullable ComponentName getActivity()

Return the target activity.

This has nothing to do with the activity that this shortcut will launch. Launcher apps should show the launcher icon for the returned activity alongside this shortcut.

public @Nullable Set<String> getCategories()

Return the categories set with setCategories.

public @Nullable CharSequence getDisabledMessage()

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

public int getDisabledReason()

Returns why a shortcut has been disabled.

public int getExcludedFromSurfaces()

Returns a bitmask of all surfaces this shortcut is excluded from.

public @NonNull String getId()

Returns the ID of a shortcut.

Shortcut IDs are unique within each publisher app and must be stable across devices so that shortcuts will still be valid when restored on a different device. See android.content.pm.ShortcutManager for details.

public @NonNull Intent getIntent()

Returns the intent that is executed when the user selects this shortcut. If setIntents() was used, then return the last intent in the array.

public @NonNull Intent[] getIntents()

Return the intent set with setIntents.

public long getLastChangedTimestamp()

Last time when any of the fields was updated.

public @Nullable LocusIdCompat getLocusId()

Gets the LocusIdCompat associated with this shortcut.

Used by the device's intelligence services to correlate objects (such as androidx.core.app.NotificationCompat and android.view.contentcapture.ContentCaptureContext) that are correlated.

public @Nullable CharSequence getLongLabel()

Return the long description of a shortcut.

public @NonNull String getPackage()

Return the package name of the publisher app.

public int getRank()

Returns the rank of the shortcut set with setRank.

public @NonNull CharSequence getShortLabel()

Return the short description of a shortcut.

public @Nullable UserHandle getUserHandle()

UserHandle on which the publisher created this shortcut.

public boolean hasKeyFieldsOnly()

Return whether a shortcut only contains "key" information only or not. If true, only the following fields are available.

• getId
• getPackage
• getActivity
• getLastChangedTimestamp
• isDynamic
• isPinned
• isDeclaredInManifest
• isImmutable
• isEnabled
• getUserHandle

public boolean isCached()

Return whether a shortcut is cached.

public boolean isDeclaredInManifest()

Return whether a shortcut is static; that is, whether a shortcut is published from AndroidManifest.xml. If true, the shortcut is also isImmutable.

When an app is upgraded and a shortcut is no longer published from AndroidManifest.xml, this will be set to false. If the shortcut is not pinned, then it'll disappear. However, if it's pinned, it will still be visible, isEnabled will be false and isImmutable will be true.

public boolean isDynamic()

Return whether a shortcut is dynamic.

public boolean isEnabled()

Returns false if a shortcut is disabled with disableShortcuts.

public boolean isExcludedFromSurfaces(int surface)

Return true if the shortcut is excluded from specified surface.

public boolean isImmutable()

Return if a shortcut is immutable, in which case it cannot be modified with any of ShortcutManagerCompat APIs.

All static shortcuts are immutable. When a static shortcut is pinned and is then disabled because it doesn't appear in AndroidManifest.xml for a newer version of the app, isDeclaredInManifest returns false, but the shortcut is still immutable.

All shortcuts originally published via the ShortcutManager APIs are all mutable.

public boolean isPinned()

Return whether a shortcut is pinned.