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 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 CharSequence? |
Return the long description of a shortcut. |
open Int |
getRank() Returns the rank of the shortcut set with |
open CharSequence |
Return the short description of a shortcut. |
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.
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
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
toShortcutInfo
open fun toShortcutInfo(): ShortcutInfo!
Return | |
---|---|
ShortcutInfo!: ShortcutInfo object from this compat object. |