ShortcutInfoCompat
open class ShortcutInfoCompat
kotlin.Any | |
↳ | androidx.core.content.pm.ShortcutInfoCompat |
Helper for accessing features in ShortcutInfo
.
Summary
Nested classes | |
---|---|
open |
Builder class for |
Public methods | |
---|---|
open ComponentName? |
Return the target activity. |
open MutableSet<String!>? |
Return the categories set with |
open CharSequence? |
Return the message that should be shown when the user attempts to start a shortcut that is disabled. |
open Int |
Returns why a shortcut has been disabled. |
open PersistableBundle? | |
open String |
getId() Returns the ID of a shortcut. |
open Intent |
Returns the intent that is executed when the user selects this shortcut. |
open Array<Intent!> |
Return the intent set with |
open Long |
Last time when any of the fields was updated. |
open LocusIdCompat? |
Gets the |
open CharSequence? |
Return the long description of a shortcut. |
open String |
Return the package name of the publisher app. |
open Int |
getRank() Returns the rank of the shortcut set with |
open CharSequence |
Return the short description of a shortcut. |
open UserHandle? |
|
open Boolean |
Return whether a shortcut only contains "key" information only or not. |
open Boolean |
isCached() Return whether a shortcut is cached. |
open Boolean |
Return whether a shortcut is static; that is, whether a shortcut is published from AndroidManifest. |
open Boolean |
Return whether a shortcut is dynamic. |
open Boolean |
Returns |
open Boolean |
Return if a shortcut is immutable, in which case it cannot be modified with any of |
open Boolean |
isPinned() Return whether a shortcut is pinned. |
open ShortcutInfo! |
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
getCategories
@Nullable open fun getCategories(): MutableSet<String!>?
Return the categories set with Builder#setCategories(Set)
.
See Also
getDisabledMessage
@Nullable open fun getDisabledMessage(): CharSequence?
Return the message that should be shown when the user attempts to start a shortcut that is 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
getIntents
@NonNull open fun getIntents(): Array<Intent!>
Return the intent set with Builder#setIntents(Intent[])
.
See Also
getLastChangedTimestamp
open fun getLastChangedTimestamp(): Long
Last time when any of the fields was updated.
getLocusId
@Nullable open 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.
getLongLabel
@Nullable open fun getLongLabel(): CharSequence?
Return the long description of a shortcut.
See Also
getRank
open fun getRank(): Int
Returns the rank of the shortcut set with Builder#setRank(int)
.
See Also
getShortLabel
@NonNull open fun getShortLabel(): CharSequence
Return the short description of a shortcut.
See Also
getUserHandle
@Nullable open fun getUserHandle(): UserHandle?
UserHandle
on which the publisher created this shortcut.
hasKeyFieldsOnly
open fun hasKeyFieldsOnly(): Boolean
Return whether a shortcut only contains "key" information only or not. If true, only the following fields are available.
isDeclaredInManifest
open 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 isEnabled()
will be true
.
isEnabled
open fun isEnabled(): Boolean
Returns false
if a shortcut is disabled with ShortcutManagerCompat#disableShortcuts
.
isImmutable
open 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.
toShortcutInfo
@RequiresApi(25) open fun toShortcutInfo(): ShortcutInfo!
Return | |
---|---|
ShortcutInfo! |
ShortcutInfo object from this compat object. |