ShortcutInfo

DISABLED_REASON_APP_CHANGED

static val DISABLED_REASON_APP_CHANGED: Int

Shortcut has been disabled due to changes to the publisher app. (e.g. a manifest shortcut no longer exists.)

Value: 2

DISABLED_REASON_BACKUP_NOT_SUPPORTED

static val DISABLED_REASON_BACKUP_NOT_SUPPORTED: Int

Shortcut has not been restored because the publisher app does not support backup and restore.

Value: 101

DISABLED_REASON_BY_APP

static val DISABLED_REASON_BY_APP: Int

Shortcut has been disabled by the publisher app with the ShortcutManager.disableShortcuts(List) API.

Value: 1

DISABLED_REASON_NOT_DISABLED

static val DISABLED_REASON_NOT_DISABLED: Int

Shortcut is not disabled.

Value: 0

DISABLED_REASON_OTHER_RESTORE_ISSUE

static val DISABLED_REASON_OTHER_RESTORE_ISSUE: Int

Shortcut has not been restored for unknown reason.

Value: 103

DISABLED_REASON_SIGNATURE_MISMATCH

static val DISABLED_REASON_SIGNATURE_MISMATCH: Int

Shortcut has not been restored because the publisher app's signature has changed.

Value: 102

DISABLED_REASON_UNKNOWN

static val DISABLED_REASON_UNKNOWN: Int

Shortcut is disabled for an unknown reason.

Value: 3

DISABLED_REASON_VERSION_LOWER

static val DISABLED_REASON_VERSION_LOWER: Int

Shortcut has been restored from the previous device, but the publisher app on the current device is of a lower version. The shortcut will not be usable until the app is upgraded to the same version or higher.

Value: 100

SHORTCUT_CATEGORY_CONVERSATION

static val SHORTCUT_CATEGORY_CONVERSATION: String

Shortcut category for messaging related actions, such as chat.

Value: "android.shortcut.conversation"

SURFACE_LAUNCHER

static val SURFACE_LAUNCHER: Int

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

Value: 1

createFromGenericDocument

static fun createFromGenericDocument(
    context: Context, 
    document: GenericDocument
): ShortcutInfo

Convert a GenericDocument into a ShortcutInfo.

describeContents

fun describeContents(): Int

getActivity

fun getActivity(): ComponentName?

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.

getCapabilities

fun getCapabilities(): MutableList<Capability!>

Return a list of Capability associated with the shortcut.

getCapabilityParams

fun getCapabilityParams(capability: Capability): MutableList<CapabilityParams!>

Returns the CapabilityParams in associated with given capability.

getCategories

fun getCategories(): MutableSet<String!>?

Return the shortcut's categories.

getDisabledMessage

fun getDisabledMessage(): CharSequence?

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

getDisabledReason

fun getDisabledReason(): Int

Returns why a shortcut has been disabled.

getExcludedFromSurfaces

fun getExcludedFromSurfaces(): Int

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

getExtras

fun getExtras(): PersistableBundle?

Extras that the app can set for any purpose.

getId

fun getId(): String

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 ShortcutManager for details.

getIntent

fun getIntent(): Intent?

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

Launcher apps cannot see the intent. If a ShortcutInfo is obtained via LauncherApps, then this method will always return null. Launchers can only start a shortcut intent with android.content.pm.LauncherApps#startShortcut.

getIntents

fun getIntents(): Array<Intent!>?

Return the intent set with Builder.setIntents(Intent[]).

Launcher apps cannot see the intents. If a ShortcutInfo is obtained via LauncherApps, then this method will always return null. Launchers can only start a shortcut intent with android.content.pm.LauncherApps#startShortcut.

getLastChangedTimestamp

fun getLastChangedTimestamp(): Long

Last time when any of the fields was updated.

getLocusId

fun getLocusId(): LocusId?

Gets the LocusId associated with this shortcut.

Used by the device's intelligence services to correlate objects (such as Notification and ContentCaptureContext) that are correlated.

getLongLabel

fun getLongLabel(): CharSequence?

Return the long description of a shortcut.

getPackage

fun getPackage(): String

Return the package name of the publisher app.

getRank

fun getRank(): Int

"Rank" of a shortcut, which is a non-negative, sequential value that's unique for each getActivity for each of the two types of shortcuts (static and dynamic).

Floating shortcuts, or shortcuts that are neither static nor dynamic, will all have rank 0, because they aren't sorted. See the ShortcutManager's class javadoc for details.

getShortLabel

fun getShortLabel(): CharSequence?

Return the short description of a shortcut.

getUserHandle

fun getUserHandle(): UserHandle!

UserHandle on which the publisher created this shortcut.

hasKeyFieldsOnly

fun hasKeyFieldsOnly(): Boolean

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()

For performance reasons, shortcuts passed to LauncherApps.Callback.onShortcutsChanged(String, List, UserHandle) as well as those returned from LauncherApps.getShortcuts(ShortcutQuery, UserHandle) while using the ShortcutQuery.FLAG_GET_KEY_FIELDS_ONLY option contain only key information.

isCached

fun isCached(): Boolean

Return whether a shortcut is cached.

isDeclaredInManifest

fun isDeclaredInManifest(): Boolean

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.

isDynamic

fun isDynamic(): Boolean

Return whether a shortcut is dynamic.

isEnabled

fun isEnabled(): Boolean

Returns false if a shortcut is disabled with android.content.pm.ShortcutManager#disableShortcuts.

isExcludedFromSurfaces

fun isExcludedFromSurfaces(surface: Int): Boolean

Return true if the shortcut is excluded from specified surface.

isImmutable

fun isImmutable(): Boolean

Return if a shortcut is immutable, in which case it cannot be modified with any of ShortcutManager 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.

isPinned

fun isPinned(): Boolean

Return whether a shortcut is pinned.

toString

fun toString(): String

Return a string representation, intended for logging. Some fields will be retracted.

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

CREATOR

static val CREATOR: Parcelable.Creator<ShortcutInfo!>