ShortcutInfoCompat

const val SURFACE_LAUNCHER = 1: Int

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

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.

fun getCategories(): (Mutable)Set<String!>?

Return the categories set with setCategories.

fun getDisabledMessage(): CharSequence?

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

fun getDisabledReason(): Int

Returns why a shortcut has been disabled.

fun getExcludedFromSurfaces(): Int

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

fun getExtras(): PersistableBundle?

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

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.

fun getIntents(): Array<Intent!>

Return the intent set with setIntents.

fun getLastChangedTimestamp(): Long

Last time when any of the fields was updated.

fun getLocusId(): LocusIdCompat?

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.

fun getLongLabel(): CharSequence?

Return the long description of a shortcut.

fun getPackage(): String

Return the package name of the publisher app.

fun getRank(): Int

Returns the rank of the shortcut set with setRank.

fun getShortLabel(): CharSequence

Return the short description of a shortcut.

fun getUserHandle(): UserHandle?

UserHandle on which the publisher created this shortcut.

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

fun isCached(): Boolean

Return whether a shortcut is cached.

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.

fun isDynamic(): Boolean

Return whether a shortcut is dynamic.

fun isEnabled(): Boolean

Returns false if a shortcut is disabled with disableShortcuts.

fun isExcludedFromSurfaces(surface: Int): Boolean

Return true if the shortcut is excluded from specified surface.

fun isImmutable(): Boolean

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.

fun isPinned(): Boolean

Return whether a shortcut is pinned.

@RequiresApi(value = 25)
fun toShortcutInfo(): ShortcutInfo!