core/androidx.core.content.pm/ShortcutInfoCompat

ShortcutInfoCompat

open class ShortcutInfoCompat(source)

Helper for accessing features in ShortcutInfo.

Types

Link copied to clipboard
open class Builder
Builder class for ShortcutInfoCompat objects.
Link copied to clipboard

Properties

Link copied to clipboard
val SURFACE_LAUNCHER: Int = 1
Indicates system surfaces managed by a launcher app.

Functions

Link copied to clipboard
@Nullable
open fun getActivity(): ComponentName
Return the target activity.
Link copied to clipboard
@Nullable
open fun getCategories(): Set<String>
Return the categories set with setCategories.
Link copied to clipboard
@Nullable
open fun getDisabledMessage(): CharSequence
Return the message that should be shown when the user attempts to start a shortcut that is disabled.
Link copied to clipboard
open fun getDisabledReason(): Int
Returns why a shortcut has been disabled.
Link copied to clipboard
open fun getExcludedFromSurfaces(): Int
Returns a bitmask of all surfaces this shortcut is excluded from.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@NonNull
open fun getId(): String
Returns the ID of a shortcut.
Link copied to clipboard
@NonNull
open fun getIntent(): Intent
Returns the intent that is executed when the user selects this shortcut.
Link copied to clipboard
@NonNull
open fun getIntents(): Array<Intent>
Return the intent set with setIntents.
Link copied to clipboard
open fun getLastChangedTimestamp(): Long
Last time when any of the fields was updated.
Link copied to clipboard
@Nullable
open fun getLocusId(): LocusIdCompat
Gets the LocusIdCompat associated with this shortcut.
Link copied to clipboard
@Nullable
open fun getLongLabel(): CharSequence
Return the long description of a shortcut.
Link copied to clipboard
@NonNull
open fun getPackage(): String
Return the package name of the publisher app.
Link copied to clipboard
open fun getRank(): Int
Returns the rank of the shortcut set with setRank.
Link copied to clipboard
@NonNull
open fun getShortLabel(): CharSequence
Return the short description of a shortcut.
Link copied to clipboard
@RestrictTo(value = LIBRARY_GROUP_PREFIX)
@Nullable
open fun getTransientExtras(): Bundle
Get additional extras from the shortcut, which will not be persisted anywhere once the shortcut is published.
Link copied to clipboard
@Nullable
open fun getUserHandle(): UserHandle
UserHandle on which the publisher created this shortcut.
Link copied to clipboard
open fun hasKeyFieldsOnly(): Boolean
Return whether a shortcut only contains "key" information only or not.
Link copied to clipboard
open fun isCached(): Boolean
Return whether a shortcut is cached.
Link copied to clipboard
open fun isDeclaredInManifest(): Boolean
Return whether a shortcut is static; that is, whether a shortcut is published from AndroidManifest.xml.
Link copied to clipboard
open fun isDynamic(): Boolean
Return whether a shortcut is dynamic.
Link copied to clipboard
open fun isEnabled(): Boolean
Returns false if a shortcut is disabled with disableShortcuts.
Link copied to clipboard
open fun isExcludedFromSurfaces(surface: Int): Boolean
Return true if the shortcut is excluded from specified surface.
Link copied to clipboard
open fun isImmutable(): Boolean
Return if a shortcut is immutable, in which case it cannot be modified with any of ShortcutManagerCompat APIs.
Link copied to clipboard
open fun isPinned(): Boolean
Return whether a shortcut is pinned.
Link copied to clipboard
@RequiresApi(value = 25)
open fun toShortcutInfo(): ShortcutInfo