# ShortcutInfoCompat
# ShortcutInfoCompat
Artifact:[androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core)
[View Source](https://cs.android.com/search?q=file:androidx/core/content/pm/ShortcutInfoCompat.java+class:androidx.core.content.pm.ShortcutInfoCompat)
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
*** ** * ** ***
Kotlin\|[Java](https://developer.android.com/reference/androidx/core/content/pm/ShortcutInfoCompat "View this page in Java")
```
class ShortcutInfoCompat
```
*** ** * ** ***
Helper for accessing features in[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo.html).
## Summary
| ### Nested types |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[ShortcutInfoCompat.Builder](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder) Builder class for[ShortcutInfoCompat](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat)objects. |
| ### Constants |
|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `const `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [SURFACE_LAUNCHER](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#SURFACE_LAUNCHER())` = 1` Indicates system surfaces managed by a launcher app. e.g. Long-Press Menu. |
| ### Public functions |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ComponentName](https://developer.android.com/reference/android/content/ComponentName.html)`?` | [getActivity](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getActivity())`()` Return the target activity. |
| `(`[Mutable](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-set/index.html)`)`[Set](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html)`<`[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!>?` | [getCategories](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getCategories())`()` Return the categories set with[setCategories](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setCategories(java.util.Set)). |
| [CharSequence](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html)`?` | [getDisabledMessage](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getDisabledMessage())`()` Return the message that should be shown when the user attempts to start a shortcut that is disabled. |
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [getDisabledReason](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getDisabledReason())`()` Returns why a shortcut has been disabled. |
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [getExcludedFromSurfaces](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getExcludedFromSurfaces())`()` Returns a bitmask of all surfaces this shortcut is excluded from. |
| [PersistableBundle](https://developer.android.com/reference/android/os/PersistableBundle.html)`?` | [getExtras](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getExtras())`()` |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) | [getId](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getId())`()` Returns the ID of a shortcut. |
| [Intent](https://developer.android.com/reference/android/content/Intent.html) | [getIntent](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getIntent())`()` Returns the intent that is executed when the user selects this shortcut. |
| [Array](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html)`<`[Intent](https://developer.android.com/reference/android/content/Intent.html)`!>` | [getIntents](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getIntents())`()` Return the intent set with[setIntents](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setIntents(android.content.Intent[])). |
| [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html) | [getLastChangedTimestamp](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getLastChangedTimestamp())`()` Last time when any of the fields was updated. |
| [LocusIdCompat](https://developer.android.com/reference/kotlin/androidx/core/content/LocusIdCompat)`?` | [getLocusId](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getLocusId())`()` Gets the[LocusIdCompat](https://developer.android.com/reference/kotlin/androidx/core/content/LocusIdCompat)associated with this shortcut. |
| [CharSequence](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html)`?` | [getLongLabel](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getLongLabel())`()` Return the long description of a shortcut. |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) | [getPackage](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getPackage())`()` Return the package name of the publisher app. |
| [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) | [getRank](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getRank())`()` Returns the rank of the shortcut set with[setRank](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setRank(int)). |
| [CharSequence](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html) | [getShortLabel](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getShortLabel())`()` Return the short description of a shortcut. |
| [UserHandle](https://developer.android.com/reference/android/os/UserHandle.html)`?` | [getUserHandle](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getUserHandle())`()` [UserHandle](https://developer.android.com/reference/android/os/UserHandle.html)on which the publisher created this shortcut. |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [hasKeyFieldsOnly](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#hasKeyFieldsOnly())`()` Return whether a shortcut only contains "key" information only or not. |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isCached](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isCached())`()` Return whether a shortcut is cached. |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isDeclaredInManifest](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isDeclaredInManifest())`()` Return whether a shortcut is static; that is, whether a shortcut is published from AndroidManifest.xml. |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isDynamic](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isDynamic())`()` Return whether a shortcut is dynamic. |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isEnabled](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isEnabled())`()` Returns`false`if a shortcut is disabled with[disableShortcuts](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutManagerCompat#disableShortcuts(android.content.Context,java.util.List,java.lang.CharSequence)). |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isExcludedFromSurfaces](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isExcludedFromSurfaces(int))`(surface: `[Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)`)` Return true if the shortcut is excluded from specified surface. |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isImmutable](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isImmutable())`()` Return if a shortcut is immutable, in which case it cannot be modified with any of[ShortcutManagerCompat](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutManagerCompat)APIs. |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [isPinned](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isPinned())`()` Return whether a shortcut is pinned. |
| [ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo.html)`!` | `@`[RequiresApi](https://developer.android.com/reference/kotlin/androidx/annotation/RequiresApi)`(value = 25)` [toShortcutInfo](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#toShortcutInfo())`()` |
## Constants
### SURFACE_LAUNCHER
Added in[1.8.0](https://developer.android.com/jetpack/androidx/releases/core#1.8.0)
```
const val SURFACE_LAUNCHER = 1: Int
```
Indicates system surfaces managed by a launcher app. e.g. Long-Press Menu.
## Public functions
### getActivity
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
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 |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setActivity](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setActivity(android.content.ComponentName)) | |
### getCategories
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
fun getCategories(): (Mutable)Set?
```
Return the categories set with[setCategories](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setCategories(java.util.Set)).
| See also |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setCategories](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setCategories(java.util.Set)) | |
### getDisabledMessage
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
fun getDisabledMessage(): CharSequence?
```
Return the message that should be shown when the user attempts to start a shortcut that is disabled.
| See also |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setDisabledMessage](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setDisabledMessage(java.lang.CharSequence)) | |
### getDisabledReason
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun getDisabledReason(): Int
```
Returns why a shortcut has been disabled.
### getExcludedFromSurfaces
Added in[1.8.0](https://developer.android.com/jetpack/androidx/releases/core#1.8.0)
```
fun getExcludedFromSurfaces(): Int
```
Returns a bitmask of all surfaces this shortcut is excluded from.
| See also |
|----------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setExcludedFromSurfaces](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder.html#setExcludedFromSurfaces(int)) | |
### getExtras
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun getExtras(): PersistableBundle?
```
### getId
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
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](https://developer.android.com/reference/android/content/pm/ShortcutManager.html)for details.
### getIntent
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
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 |
|---------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setIntent](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setIntent(android.content.Intent)) | |
### getIntents
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
fun getIntents(): Array
```
Return the intent set with[setIntents](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setIntents(android.content.Intent[])).
| See also |
|-------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setIntents](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setIntents(android.content.Intent[])) | |
### getLastChangedTimestamp
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun getLastChangedTimestamp(): Long
```
Last time when any of the fields was updated.
### getLocusId
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun getLocusId(): LocusIdCompat?
```
Gets the[LocusIdCompat](https://developer.android.com/reference/kotlin/androidx/core/content/LocusIdCompat)associated with this shortcut.
Used by the device's intelligence services to correlate objects (such as[androidx.core.app.NotificationCompat](https://developer.android.com/reference/kotlin/androidx/core/app/NotificationCompat)and[android.view.contentcapture.ContentCaptureContext](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext.html)) that are correlated.
### getLongLabel
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
fun getLongLabel(): CharSequence?
```
Return the long description of a shortcut.
| See also |
|---------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setLongLabel](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setLongLabel(java.lang.CharSequence)) | |
### getPackage
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun getPackage(): String
```
Return the package name of the publisher app.
### getRank
Added in[1.2.0](https://developer.android.com/jetpack/androidx/releases/core#1.2.0)
```
fun getRank(): Int
```
Returns the rank of the shortcut set with[setRank](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setRank(int)).
| See also |
|----------------------------------------------------------------------------------------------------------------------------|---|
| [setRank](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setRank(int)) | |
### getShortLabel
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
fun getShortLabel(): CharSequence
```
Return the short description of a shortcut.
| See also |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [setShortLabel](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat.Builder#setShortLabel(java.lang.CharSequence)) | |
### getUserHandle
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun getUserHandle(): UserHandle?
```
[UserHandle](https://developer.android.com/reference/android/os/UserHandle.html)on which the publisher created this shortcut.
### hasKeyFieldsOnly
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun hasKeyFieldsOnly(): Boolean
```
Return whether a shortcut only contains "key" information only or not. If true, only the following fields are available.
- [getId](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getId())
- [getPackage](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getPackage())
- [getActivity](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getActivity())
- [getLastChangedTimestamp](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getLastChangedTimestamp())
- [isDynamic](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isDynamic())
- [isPinned](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isPinned())
- [isDeclaredInManifest](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isDeclaredInManifest())
- [isImmutable](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isImmutable())
- [isEnabled](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isEnabled())
- [getUserHandle](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#getUserHandle())
### isCached
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun isCached(): Boolean
```
Return whether a shortcut is cached.
### isDeclaredInManifest
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
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](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#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](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isEnabled())will be`false`and[isImmutable](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isImmutable())will be`true`.
### isDynamic
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun isDynamic(): Boolean
```
Return whether a shortcut is dynamic.
### isEnabled
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun isEnabled(): Boolean
```
Returns`false`if a shortcut is disabled with[disableShortcuts](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutManagerCompat#disableShortcuts(android.content.Context,java.util.List,java.lang.CharSequence)).
### isExcludedFromSurfaces
Added in[1.8.0](https://developer.android.com/jetpack/androidx/releases/core#1.8.0)
```
fun isExcludedFromSurfaces(surface: Int): Boolean
```
Return true if the shortcut is excluded from specified surface.
### isImmutable
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun isImmutable(): Boolean
```
Return if a shortcut is immutable, in which case it cannot be modified with any of[ShortcutManagerCompat](https://developer.android.com/reference/kotlin/androidx/core/content/pm/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](https://developer.android.com/reference/kotlin/androidx/core/content/pm/ShortcutInfoCompat#isDeclaredInManifest())returns`false`, but the shortcut is still immutable.
All shortcuts originally published via the[ShortcutManager](https://developer.android.com/reference/android/content/pm/ShortcutManager.html)APIs are all mutable.
### isPinned
Added in[1.5.0](https://developer.android.com/jetpack/androidx/releases/core#1.5.0)
```
fun isPinned(): Boolean
```
Return whether a shortcut is pinned.
### toShortcutInfo
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)
```
@RequiresApi(value = 25)
fun toShortcutInfo(): ShortcutInfo!
```
| Returns |
|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
| [ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo.html)`!` | [ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo.html)object from this compat object. |