ShortcutInfoCompat

Kotlin |Java

open class ShortcutInfoCompat

kotlin.Any
↳	androidx.core.content.pm.ShortcutInfoCompat

Helper for accessing features in ShortcutInfo.

Summary

Nested classes
open	`Builder` Builder class for `ShortcutInfoCompat` objects.

Public methods
open ComponentName?	`getActivity()` Return the target activity.
open MutableSet<String!>?	`getCategories()` Return the categories set with `Builder#setCategories(Set)`.
open CharSequence?	`getDisabledMessage()` Return the message that should be shown when the user attempts to start a shortcut that is disabled.
open Int	`getDisabledReason()` Returns why a shortcut has been disabled.
open PersistableBundle?	`getExtras()`
open String	`getId()` Returns the ID of a shortcut.
open Intent	`getIntent()` Returns the intent that is executed when the user selects this shortcut.
open Array<Intent!>	`getIntents()` Return the intent set with `Builder#setIntents(Intent[])`.
open Long	`getLastChangedTimestamp()` Last time when any of the fields was updated.
open LocusIdCompat?	`getLocusId()` Gets the `LocusIdCompat` associated with this shortcut.
open CharSequence?	`getLongLabel()` Return the long description of a shortcut.
open String	`getPackage()` Return the package name of the publisher app.
open Int	`getRank()` Returns the rank of the shortcut set with `Builder#setRank(int)`.
open CharSequence	`getShortLabel()` Return the short description of a shortcut.
open UserHandle?	`getUserHandle()` `UserHandle` on which the publisher created this shortcut.
open Boolean	`hasKeyFieldsOnly()` Return whether a shortcut only contains "key" information only or not.
open Boolean	`isCached()` Return whether a shortcut is cached.
open Boolean	`isDeclaredInManifest()` Return whether a shortcut is static; that is, whether a shortcut is published from AndroidManifest.
open Boolean	`isDynamic()` Return whether a shortcut is dynamic.
open Boolean	`isEnabled()` Returns `false` if a shortcut is disabled with `ShortcutManagerCompat#disableShortcuts`.
open Boolean	`isImmutable()` Return if a shortcut is immutable, in which case it cannot be modified with any of `ShortcutManagerCompat` APIs.
open Boolean	`isPinned()` Return whether a shortcut is pinned.
open ShortcutInfo!	`toShortcutInfo()`

Public methods

getActivity

@Nullable open 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.

See Also

Builder#setActivity(ComponentName)

getCategories

@Nullable open fun getCategories(): MutableSet<String!>?

Return the categories set with Builder#setCategories(Set).

See Also

Builder#setCategories(Set)

getDisabledMessage

@Nullable open fun getDisabledMessage(): CharSequence?

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

See Also

Builder#setDisabledMessage(CharSequence)

getDisabledReason

open fun getDisabledReason(): Int

Returns why a shortcut has been disabled.

getExtras

@Nullable open fun getExtras(): PersistableBundle?

getId

@NonNull open 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.

getIntent

@NonNull open 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.

See Also

Builder#setIntent(Intent)

getIntents

@NonNull open fun getIntents(): Array<Intent!>

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

See Also

Builder#setIntents(Intent[])

getLastChangedTimestamp

open fun getLastChangedTimestamp(): Long

Last time when any of t