# ShortcutInfo
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary:[Nested Classes](https://developer.android.com/reference/android/content/pm/ShortcutInfo#nestedclasses)\|[Constants](https://developer.android.com/reference/android/content/pm/ShortcutInfo#constants)\|[Inherited Constants](https://developer.android.com/reference/android/content/pm/ShortcutInfo#inhconstants)\|[Fields](https://developer.android.com/reference/android/content/pm/ShortcutInfo#lfields)\|[Methods](https://developer.android.com/reference/android/content/pm/ShortcutInfo#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/content/pm/ShortcutInfo#inhmethods)
# ShortcutInfo
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/content/pm/ShortcutInfo "View this page in Kotlin")\|Java
`
public
final
class
ShortcutInfo
`
`
extends `[Object](https://developer.android.com/reference/java/lang/Object)`
``
implements
`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`
`
|---|---------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.content.pm.ShortcutInfo |
*** ** * ** ***
Represents a shortcut that can be published via[ShortcutManager](https://developer.android.com/reference/android/content/pm/ShortcutManager).
**See also:**
- [ShortcutManager](https://developer.android.com/reference/android/content/pm/ShortcutManager)
## Summary
| ### Nested classes ||
|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` class` | [ShortcutInfo.Builder](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder) Builder class for[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo)objects. |
| ### Constants ||
|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | [DISABLED_REASON_APP_CHANGED](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_APP_CHANGED) Shortcut has been disabled due to changes to the publisher app. |
| `int` | [DISABLED_REASON_BACKUP_NOT_SUPPORTED](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_BACKUP_NOT_SUPPORTED) Shortcut has not been restored because the publisher app does not support backup and restore. |
| `int` | [DISABLED_REASON_BY_APP](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_BY_APP) Shortcut has been disabled by the publisher app with the[ShortcutManager.disableShortcuts(List)](https://developer.android.com/reference/android/content/pm/ShortcutManager#disableShortcuts(java.util.List))API. |
| `int` | [DISABLED_REASON_NOT_DISABLED](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_NOT_DISABLED) Shortcut is not disabled. |
| `int` | [DISABLED_REASON_OTHER_RESTORE_ISSUE](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_OTHER_RESTORE_ISSUE) Shortcut has not been restored for unknown reason. |
| `int` | [DISABLED_REASON_SIGNATURE_MISMATCH](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_SIGNATURE_MISMATCH) Shortcut has not been restored because the publisher app's signature has changed. |
| `int` | [DISABLED_REASON_UNKNOWN](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_UNKNOWN) Shortcut is disabled for an unknown reason. |
| `int` | [DISABLED_REASON_VERSION_LOWER](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_VERSION_LOWER) Shortcut has been restored from the previous device, but the publisher app on the current device is of a lower version. |
| [String](https://developer.android.com/reference/java/lang/String) | [SHORTCUT_CATEGORY_CONVERSATION](https://developer.android.com/reference/android/content/pm/ShortcutInfo#SHORTCUT_CATEGORY_CONVERSATION) Shortcut category for messaging related actions, such as chat. |
| `int` | [SURFACE_LAUNCHER](https://developer.android.com/reference/android/content/pm/ShortcutInfo#SURFACE_LAUNCHER) Indicates system surfaces managed by a launcher app. |
| ### Inherited constants |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". | |
| ### Fields ||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| ` public static final `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo)`>` | [CREATOR](https://developer.android.com/reference/android/content/pm/ShortcutInfo#CREATOR)
|
| ### Public methods ||
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` static `[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo) | ` `[createFromGenericDocument](https://developer.android.com/reference/android/content/pm/ShortcutInfo#createFromGenericDocument(android.content.Context,%20android.app.appsearch.GenericDocument))`(`[Context](https://developer.android.com/reference/android/content/Context)` context, `[GenericDocument](https://developer.android.com/reference/android/app/appsearch/GenericDocument)` document) ` Convert a[GenericDocument](https://developer.android.com/reference/android/app/appsearch/GenericDocument)into a ShortcutInfo. |
| ` int` | ` `[describeContents](https://developer.android.com/reference/android/content/pm/ShortcutInfo#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` `[ComponentName](https://developer.android.com/reference/android/content/ComponentName) | ` `[getActivity](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getActivity())`() ` Return the target activity. |
| ` `[List](https://developer.android.com/reference/java/util/List)`<`[Capability](https://developer.android.com/reference/android/content/pm/Capability)`>` | ` `[getCapabilities](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getCapabilities())`() ` Return a list of[Capability](https://developer.android.com/reference/android/content/pm/Capability)associated with the shortcut. |
| ` `[List](https://developer.android.com/reference/java/util/List)`<`[CapabilityParams](https://developer.android.com/reference/android/content/pm/CapabilityParams)`>` | ` `[getCapabilityParams](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getCapabilityParams(android.content.pm.Capability))`(`[Capability](https://developer.android.com/reference/android/content/pm/Capability)` capability) ` Returns the[CapabilityParams](https://developer.android.com/reference/android/content/pm/CapabilityParams)in associated with given capability. |
| ` `[Set](https://developer.android.com/reference/java/util/Set)`<`[String](https://developer.android.com/reference/java/lang/String)`>` | ` `[getCategories](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getCategories())`() ` Return the shortcut's categories. |
| ` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | ` `[getDisabledMessage](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getDisabledMessage())`() ` Return the message that should be shown when the user attempts to start a shortcut that is disabled. |
| ` int` | ` `[getDisabledReason](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getDisabledReason())`() ` Returns why a shortcut has been disabled. |
| ` int` | ` `[getExcludedFromSurfaces](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getExcludedFromSurfaces())`() ` Returns a bitmask of all surfaces this shortcut is excluded from. |
| ` `[PersistableBundle](https://developer.android.com/reference/android/os/PersistableBundle) | ` `[getExtras](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getExtras())`() ` Extras that the app can set for any purpose. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getId](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getId())`() ` Returns the ID of a shortcut. |
| ` `[Intent](https://developer.android.com/reference/android/content/Intent) | ` `[getIntent](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getIntent())`() ` Returns the intent that is executed when the user selects this shortcut. |
| ` `[Intent[]](https://developer.android.com/reference/android/content/Intent) | ` `[getIntents](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getIntents())`() ` Return the intent set with[Builder.setIntents(Intent[])](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setIntents(android.content.Intent[])). |
| ` long` | ` `[getLastChangedTimestamp](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getLastChangedTimestamp())`() ` Last time when any of the fields was updated. |
| ` `[LocusId](https://developer.android.com/reference/android/content/LocusId) | ` `[getLocusId](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getLocusId())`() ` Gets the[LocusId](https://developer.android.com/reference/android/content/LocusId)associated with this shortcut. |
| ` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | ` `[getLongLabel](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getLongLabel())`() ` Return the long description of a shortcut. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getPackage](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getPackage())`() ` Return the package name of the publisher app. |
| ` int` | ` `[getRank](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getRank())`() ` "Rank" of a shortcut, which is a non-negative, sequential value that's unique for each[getActivity()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getActivity())for each of the two types of shortcuts (static and dynamic). |
| ` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | ` `[getShortLabel](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getShortLabel())`() ` Return the short description of a shortcut. |
| ` `[UserHandle](https://developer.android.com/reference/android/os/UserHandle) | ` `[getUserHandle](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getUserHandle())`() ` [UserHandle](https://developer.android.com/reference/android/os/UserHandle)on which the publisher created this shortcut. |
| ` boolean` | ` `[hasKeyFieldsOnly](https://developer.android.com/reference/android/content/pm/ShortcutInfo#hasKeyFieldsOnly())`() ` Return whether a shortcut only contains "key" information only or not. |
| ` boolean` | ` `[isCached](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isCached())`() ` Return whether a shortcut is cached. |
| ` boolean` | ` `[isDeclaredInManifest](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isDeclaredInManifest())`() ` Return whether a shortcut is static; that is, whether a shortcut is published from AndroidManifest.xml. |
| ` boolean` | ` `[isDynamic](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isDynamic())`() ` Return whether a shortcut is dynamic. |
| ` boolean` | ` `[isEnabled](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isEnabled())`() ` Returns`false`if a shortcut is disabled with[ShortcutManager.disableShortcuts](https://developer.android.com/reference/android/content/pm/ShortcutManager#disableShortcuts(java.util.List)). |
| ` boolean` | ` `[isExcludedFromSurfaces](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isExcludedFromSurfaces(int))`(int surface) ` Return true if the shortcut is excluded from specified surface. |
| ` boolean` | ` `[isImmutable](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isImmutable())`() ` Return if a shortcut is immutable, in which case it cannot be modified with any of[ShortcutManager](https://developer.android.com/reference/android/content/pm/ShortcutManager)APIs. |
| ` boolean` | ` `[isPinned](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isPinned())`() ` Return whether a shortcut is pinned. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/android/content/pm/ShortcutInfo#toString())`() ` Return a string representation, intended for logging. |
| ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/content/pm/ShortcutInfo#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. |
| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*. | ||
| From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||
## Constants
### DISABLED_REASON_APP_CHANGED
Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int DISABLED_REASON_APP_CHANGED
```
Shortcut has been disabled due to changes to the publisher app. (e.g. a manifest shortcut no longer exists.)
Constant Value: 2 (0x00000002)
### DISABLED_REASON_BACKUP_NOT_SUPPORTED
Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int DISABLED_REASON_BACKUP_NOT_SUPPORTED
```
Shortcut has not been restored because the publisher app does not support backup and restore.
Constant Value: 101 (0x00000065)
### DISABLED_REASON_BY_APP
Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int DISABLED_REASON_BY_APP
```
Shortcut has been disabled by the publisher app with the[ShortcutManager.disableShortcuts(List)](https://developer.android.com/reference/android/content/pm/ShortcutManager#disableShortcuts(java.util.List))API.
Constant Value: 1 (0x00000001)
### DISABLED_REASON_NOT_DISABLED
Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int DISABLED_REASON_NOT_DISABLED
```
Shortcut is not disabled.
Constant Value: 0 (0x00000000)
### DISABLED_REASON_OTHER_RESTORE_ISSUE
Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int DISABLED_REASON_OTHER_RESTORE_ISSUE
```
Shortcut has not been restored for unknown reason.
Constant Value: 103 (0x00000067)
### DISABLED_REASON_SIGNATURE_MISMATCH
Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int DISABLED_REASON_SIGNATURE_MISMATCH
```
Shortcut has not been restored because the publisher app's signature has changed.
Constant Value: 102 (0x00000066)
### DISABLED_REASON_UNKNOWN
Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int DISABLED_REASON_UNKNOWN
```
Shortcut is disabled for an unknown reason.
Constant Value: 3 (0x00000003)
### DISABLED_REASON_VERSION_LOWER
Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int DISABLED_REASON_VERSION_LOWER
```
Shortcut has been restored from the previous device, but the publisher app on the current device is of a lower version. The shortcut will not be usable until the app is upgraded to the same version or higher.
Constant Value: 100 (0x00000064)
### SHORTCUT_CATEGORY_CONVERSATION
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String SHORTCUT_CATEGORY_CONVERSATION
```
Shortcut category for messaging related actions, such as chat.
Constant Value: "android.shortcut.conversation"
### SURFACE_LAUNCHER
Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int SURFACE_LAUNCHER
```
Indicates system surfaces managed by a launcher app. e.g. Long-Press Menu.
Constant Value: 1 (0x00000001)
## Fields
### CREATOR
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final Creator CREATOR
```
## Public methods
### createFromGenericDocument
Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static ShortcutInfo createFromGenericDocument (Context context,
GenericDocument document)
```
Convert a[GenericDocument](https://developer.android.com/reference/android/app/appsearch/GenericDocument)into a ShortcutInfo.
| Parameters ||
|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `context` | `Context`: Client context This value cannot be`null`.
|
| `document` | `GenericDocument`: An instance of[GenericDocument](https://developer.android.com/reference/android/app/appsearch/GenericDocument)that represents the shortcut. This value cannot be`null`.
|
| Returns ||
|-----------------------------------------------------------------------------------------|------------------------------------|
| [ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo) | This value cannot be`null`.
|
### describeContents
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int describeContents ()
```
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of[writeToParcel(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.
| Returns ||
|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)
|
### getActivity
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public ComponentName getActivity ()
```
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.
| Returns ||
|----------------------------------------------------------------------------------------|---------------------------------|
| [ComponentName](https://developer.android.com/reference/android/content/ComponentName) | This value may be`null`.
|
**See also:**
- [ShortcutInfo.Builder.setActivity(ComponentName)](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setActivity(android.content.ComponentName))
### getCapabilities
Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public List getCapabilities ()
```
Return a list of[Capability](https://developer.android.com/reference/android/content/pm/Capability)associated with the shortcut.
| Returns ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
| [List](https://developer.android.com/reference/java/util/List)`<`[Capability](https://developer.android.com/reference/android/content/pm/Capability)`>` | This value cannot be`null`.
|
### getCapabilityParams
Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public List getCapabilityParams (Capability capability)
```
Returns the[CapabilityParams](https://developer.android.com/reference/android/content/pm/CapabilityParams)in associated with given capability.
| Parameters ||
|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `capability` | `Capability`:[Capability](https://developer.android.com/reference/android/content/pm/Capability)associated with the shortcut. This value cannot be`null`.
|
| Returns ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
| [List](https://developer.android.com/reference/java/util/List)`<`[CapabilityParams](https://developer.android.com/reference/android/content/pm/CapabilityParams)`>` | This value cannot be`null`.
|
### getCategories
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Set getCategories ()
```
Return the shortcut's categories.
| Returns ||
|--------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|
| [Set](https://developer.android.com/reference/java/util/Set)`<`[String](https://developer.android.com/reference/java/lang/String)`>` | This value may be`null`.
|
**See also:**
- [ShortcutInfo.Builder.setCategories(Set)](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setCategories(java.util.Set))
### getDisabledMessage
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public CharSequence getDisabledMessage ()
```
Return the message that should be shown when the user attempts to start a shortcut that is disabled.
| Returns ||
|--------------------------------------------------------------------------------|---------------------------------|
| [CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | This value may be`null`.
|
**See also:**
- [ShortcutInfo.Builder.setDisabledMessage(CharSequence)](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setDisabledMessage(java.lang.CharSequence))
### getDisabledReason
Added in[API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getDisabledReason ()
```
Returns why a shortcut has been disabled.
| Returns ||
|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | Value is[DISABLED_REASON_NOT_DISABLED](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_NOT_DISABLED),[DISABLED_REASON_BY_APP](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_BY_APP),[DISABLED_REASON_APP_CHANGED](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_APP_CHANGED),[DISABLED_REASON_UNKNOWN](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_UNKNOWN),[DISABLED_REASON_VERSION_LOWER](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_VERSION_LOWER),[DISABLED_REASON_BACKUP_NOT_SUPPORTED](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_BACKUP_NOT_SUPPORTED),[DISABLED_REASON_SIGNATURE_MISMATCH](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_SIGNATURE_MISMATCH), or[DISABLED_REASON_OTHER_RESTORE_ISSUE](https://developer.android.com/reference/android/content/pm/ShortcutInfo#DISABLED_REASON_OTHER_RESTORE_ISSUE)
|
### getExcludedFromSurfaces
Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getExcludedFromSurfaces ()
```
Returns a bitmask of all surfaces this shortcut is excluded from.
| Returns ||
|-------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `int` | Value is either`0`or[SURFACE_LAUNCHER](https://developer.android.com/reference/android/content/pm/ShortcutInfo#SURFACE_LAUNCHER)
|
**See also:**
- [ShortcutInfo.Builder.setExcludedFromSurfaces(int)](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setExcludedFromSurfaces(int))
### getExtras
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public PersistableBundle getExtras ()
```
Extras that the app can set for any purpose.
| Returns ||
|-------------------------------------------------------------------------------------------|---------------------------------|
| [PersistableBundle](https://developer.android.com/reference/android/os/PersistableBundle) | This value may be`null`.
|
**See also:**
- [ShortcutInfo.Builder.setExtras(PersistableBundle)](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setExtras(android.os.PersistableBundle))
### getId
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getId ()
```
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[ShortcutManager](https://developer.android.com/reference/android/content/pm/ShortcutManager)for details.
| Returns ||
|--------------------------------------------------------------------|------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`.
|
### getIntent
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Intent getIntent ()
```
Returns the intent that is executed when the user selects this shortcut. If setIntents() was used, then return the last intent in the array.
Launcher apps**cannot** see the intent. If a[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo)is obtained via[LauncherApps](https://developer.android.com/reference/android/content/pm/LauncherApps), then this method will always return null. Launchers can only start a shortcut intent with[LauncherApps.startShortcut](https://developer.android.com/reference/android/content/pm/LauncherApps#startShortcut(android.content.pm.ShortcutInfo,%20android.graphics.Rect,%20android.os.Bundle)).
| Returns ||
|--------------------------------------------------------------------------|--------|
| [Intent](https://developer.android.com/reference/android/content/Intent) |
|
**See also:**
- [ShortcutInfo.Builder.setIntent(Intent)](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setIntent(android.content.Intent))
### getIntents
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Intent[] getIntents ()
```
Return the intent set with[Builder.setIntents(Intent[])](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setIntents(android.content.Intent[])).
Launcher apps**cannot** see the intents. If a[ShortcutInfo](https://developer.android.com/reference/android/content/pm/ShortcutInfo)is obtained via[LauncherApps](https://developer.android.com/reference/android/content/pm/LauncherApps), then this method will always return null. Launchers can only start a shortcut intent with[LauncherApps.startShortcut](https://developer.android.com/reference/android/content/pm/LauncherApps#startShortcut(android.content.pm.ShortcutInfo,%20android.graphics.Rect,%20android.os.Bundle)).
| Returns ||
|----------------------------------------------------------------------------|--------|
| [Intent[]](https://developer.android.com/reference/android/content/Intent) |
|
**See also:**
- [ShortcutInfo.Builder.setIntents(Intent[])](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setIntents(android.content.Intent[]))
### getLastChangedTimestamp
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public long getLastChangedTimestamp ()
```
Last time when any of the fields was updated.
| Returns ||
|--------|--------|
| `long` |
|
### getLocusId
Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public LocusId getLocusId ()
```
Gets the[LocusId](https://developer.android.com/reference/android/content/LocusId)associated with this shortcut.
Used by the device's intelligence services to correlate objects (such as[Notification](https://developer.android.com/reference/android/app/Notification)and[ContentCaptureContext](https://developer.android.com/reference/android/view/contentcapture/ContentCaptureContext)) that are correlated.
| Returns ||
|----------------------------------------------------------------------------|---------------------------------|
| [LocusId](https://developer.android.com/reference/android/content/LocusId) | This value may be`null`.
|
### getLongLabel
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public CharSequence getLongLabel ()
```
Return the long description of a shortcut.
| Returns ||
|--------------------------------------------------------------------------------|---------------------------------|
| [CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | This value may be`null`.
|
**See also:**
- [ShortcutInfo.Builder.setLongLabel(CharSequence)](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setLongLabel(java.lang.CharSequence))
### getPackage
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String getPackage ()
```
Return the package name of the publisher app.
| Returns ||
|--------------------------------------------------------------------|------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`.
|
### getRank
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getRank ()
```
"Rank" of a shortcut, which is a non-negative, sequential value that's unique for each[getActivity()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getActivity())for each of the two types of shortcuts (static and dynamic).
*Floating shortcuts* , or shortcuts that are neither static nor dynamic, will all have rank 0, because they aren't sorted. See the[ShortcutManager](https://developer.android.com/reference/android/content/pm/ShortcutManager)'s class javadoc for details.
| Returns ||
|-------|--------|
| `int` |
|
**See also:**
- [ShortcutInfo.Builder.setRank(int)](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setRank(int))
### getShortLabel
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public CharSequence getShortLabel ()
```
Return the short description of a shortcut.
| Returns ||
|--------------------------------------------------------------------------------|---------------------------------|
| [CharSequence](https://developer.android.com/reference/java/lang/CharSequence) | This value may be`null`.
|
**See also:**
- [ShortcutInfo.Builder.setShortLabel(CharSequence)](https://developer.android.com/reference/android/content/pm/ShortcutInfo.Builder#setShortLabel(java.lang.CharSequence))
### getUserHandle
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public UserHandle getUserHandle ()
```
[UserHandle](https://developer.android.com/reference/android/os/UserHandle)on which the publisher created this shortcut.
| Returns ||
|-----------------------------------------------------------------------------|--------|
| [UserHandle](https://developer.android.com/reference/android/os/UserHandle) |
|
### hasKeyFieldsOnly
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean hasKeyFieldsOnly ()
```
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/android/content/pm/ShortcutInfo#getId())
- [getPackage()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getPackage())
- [getActivity()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getActivity())
- [getLastChangedTimestamp()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getLastChangedTimestamp())
- [isDynamic()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isDynamic())
- [isPinned()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isPinned())
- [isDeclaredInManifest()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isDeclaredInManifest())
- [isImmutable()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isImmutable())
- [isEnabled()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isEnabled())
- [getUserHandle()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#getUserHandle())
For performance reasons, shortcuts passed to[LauncherApps.Callback.onShortcutsChanged(String, List, UserHandle)](https://developer.android.com/reference/android/content/pm/LauncherApps.Callback#onShortcutsChanged(java.lang.String,%20java.util.List,%20android.os.UserHandle))as well as those returned from[LauncherApps.getShortcuts(ShortcutQuery, UserHandle)](https://developer.android.com/reference/android/content/pm/LauncherApps#getShortcuts(android.content.pm.LauncherApps.ShortcutQuery,%20android.os.UserHandle))while using the[ShortcutQuery.FLAG_GET_KEY_FIELDS_ONLY](https://developer.android.com/reference/android/content/pm/LauncherApps.ShortcutQuery#FLAG_GET_KEY_FIELDS_ONLY)option contain only key information.
| Returns ||
|-----------|--------|
| `boolean` |
|
### isCached
Added in[API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isCached ()
```
Return whether a shortcut is cached.
| Returns ||
|-----------|--------|
| `boolean` |
|
### isDeclaredInManifest
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isDeclaredInManifest ()
```
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/android/content/pm/ShortcutInfo#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/android/content/pm/ShortcutInfo#isEnabled())will be`false`and[isImmutable()](https://developer.android.com/reference/android/content/pm/ShortcutInfo#isImmutable())will be`true`.
| Returns ||
|-----------|--------|
| `boolean` |
|
### isDynamic
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isDynamic ()
```
Return whether a shortcut is dynamic.
| Returns ||
|-----------|--------|
| `boolean` |
|
### isEnabled
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isEnabled ()
```
Returns`false`if a shortcut is disabled with[ShortcutManager.disableShortcuts](https://developer.android.com/reference/android/content/pm/ShortcutManager#disableShortcuts(java.util.List)).
| Returns ||
|-----------|--------|
| `boolean` |
|
### isExcludedFromSurfaces
Added in[API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isExcludedFromSurfaces (int surface)
```
Return true if the shortcut is excluded from specified surface.
| Parameters ||
|-----------|------------------------------------------------------------------------------------------------------------------------------------------------|
| `surface` | `int`: Value is either`0`or[SURFACE_LAUNCHER](https://developer.android.com/reference/android/content/pm/ShortcutInfo#SURFACE_LAUNCHER)
|
| Returns ||
|-----------|--------|
| `boolean` |
|
### isImmutable
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isImmutable ()
```
Return if a shortcut is immutable, in which case it cannot be modified with any of[ShortcutManager](https://developer.android.com/reference/android/content/pm/ShortcutManager)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/android/content/pm/ShortcutInfo#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)APIs are all mutable.
| Returns ||
|-----------|--------|
| `boolean` |
|
### isPinned
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isPinned ()
```
Return whether a shortcut is pinned.
| Returns ||
|-----------|--------|
| `boolean` |
|
### toString
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String toString ()
```
Return a string representation, intended for logging. Some fields will be retracted.
| Returns ||
|--------------------------------------------------------------------|-----------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object.
|
### writeToParcel
Added in[API level 25](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void writeToParcel (Parcel dest,
int flags)
```
Flatten this object in to a Parcel.
| Parameters ||
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be`null`.
|
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
|