ShortcutInfo

SHORTCUT_CATEGORY_CONVERSATION

String SHORTCUT_CATEGORY_CONVERSATION

Shortcut category for messaging related actions, such as chat.

Constant Value: "android.shortcut.conversation"

CREATOR

Creator<ShortcutInfo> CREATOR

describeContents

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(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

getActivity

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.

getCategories

Set<String> getCategories ()

Return the shortcut's categories.

getDisabledMessage

CharSequence getDisabledMessage ()

Return the message that should be shown when the user attempts to start a shortcut that is disabled.

getExtras

PersistableBundle getExtras ()

Extras that the app can set for any purpose.

getId

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 for details.

getIntent

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 is obtained via LauncherApps, then this method will always return null. Launchers can only start a shortcut intent with startShortcut(ShortcutInfo, Rect, Bundle).

getIntents

Intent[] getIntents ()

Return the intent set with setIntents(Intent[]).

Launcher apps cannot see the intents. If a ShortcutInfo is obtained via LauncherApps, then this method will always return null. Launchers can only start a shortcut intent with startShortcut(ShortcutInfo, Rect, Bundle).

getLastChangedTimestamp

long getLastChangedTimestamp ()

Last time when any of the fields was updated.

getLongLabel

CharSequence getLongLabel ()

Return the long description of a shortcut.

getPackage

String getPackage ()

Return the package name of the publisher app.

getRank

int getRank ()

"Rank" of a shortcut, which is a non-negative, sequential value that's unique for each getActivity() for each of the two types of shortcuts (static and dynamic).

Because static shortcuts and dynamic shortcuts have overlapping ranks, when a launcher app shows shortcuts for an activity, it should first show the static shortcuts, followed by the dynamic shortcuts. Within each of those categories, shortcuts should be sorted by rank in ascending order.

Floating shortcuts, or shortcuts that are neither static nor dynamic, will all have rank 0, because they aren't sorted. See the ShortcutManager's class javadoc for details.

getShortLabel

CharSequence getShortLabel ()

Return the short description of a shortcut.

getUserHandle

UserHandle getUserHandle ()

UserHandle on which the publisher created this shortcut.

hasKeyFieldsOnly

boolean hasKeyFieldsOnly ()

Return whether a shortcut only contains "key" information only or not. If true, only the following fields are available.

• getId()
• getPackage()
• getActivity()
• getLastChangedTimestamp()
• isDynamic()
• isPinned()
• isDeclaredInManifest()
• isImmutable()
• isEnabled()
• getUserHandle()

For performance reasons, shortcuts passed to onShortcutsChanged(String, List, UserHandle) as well as those returned from getShortcuts(ShortcutQuery, UserHandle) while using the FLAG_GET_KEY_FIELDS_ONLY option contain only key information.

isDeclaredInManifest

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().

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 isImmutable() will be true.

isDynamic

boolean isDynamic ()

Return whether a shortcut is dynamic.

isEnabled

boolean isEnabled ()

Returns false if a shortcut is disabled with disableShortcuts(List).

isImmutable

boolean isImmutable ()

Return if a shortcut is immutable, in which case it cannot be modified with any of 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() returns false, but the shortcut is still immutable.

All shortcuts originally published via the ShortcutManager APIs are all mutable.

isPinned

boolean isPinned ()

Return whether a shortcut is pinned.

toString

String toString ()

Return a string representation, intended for logging. Some fields will be retracted.

writeToParcel

void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.