ShortcutInfo.Builder

ShortcutInfo.Builder

ShortcutInfo.Builder (Context context, 
                String id)

Constructor.

build

ShortcutInfo build ()

Creates a ShortcutInfo instance.

setActivity

ShortcutInfo.Builder setActivity (ComponentName activity)

Sets the target activity. A shortcut will be shown along with this activity's icon on the launcher. When selecting a target activity, keep the following in mind:

• All dynamic shortcuts must have a target activity. When a shortcut with no target activity is published using addDynamicShortcuts(List) or setDynamicShortcuts(List), the first main activity defined in the app's AndroidManifest.xml file is used.
• Only "main" activities—ones that define the ACTION_MAIN and CATEGORY_LAUNCHER intent filters—can be target activities.
• By default, the first main activity defined in the app's manifest is the target activity.
• A target activity must belong to the publisher app.

setCategories

ShortcutInfo.Builder setCategories (Set<String> categories)

Sets categories for a shortcut. Launcher apps may use this information to categorize shortcuts.

setDisabledMessage

ShortcutInfo.Builder setDisabledMessage (CharSequence disabledMessage)

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

setExtras

ShortcutInfo.Builder setExtras (PersistableBundle extras)

Extras that the app can set for any purpose.

Apps can store arbitrary shortcut metadata in extras and retrieve the metadata later using getExtras().

setIcon

ShortcutInfo.Builder setIcon (Icon icon)

Sets an icon of a shortcut.

Icons are not available on ShortcutInfo instances returned by ShortcutManager or LauncherApps. The default launcher app can use getShortcutIconDrawable(ShortcutInfo, int) or getShortcutBadgedIconDrawable(ShortcutInfo, int) to fetch shortcut icons.

Tints set with setTint(int) or setTintList(ColorStateList) are not supported and will be ignored.

Only icons created with createWithBitmap(Bitmap), createWithAdaptiveBitmap(Bitmap) and createWithResource(Context, int) are supported. Other types, such as URI-based icons, are not supported.

setIntent

ShortcutInfo.Builder setIntent (Intent intent)

Sets the intent of a shortcut. Alternatively, setIntents(Intent[]) can be used to launch an activity with other activities in the back stack.

This is a mandatory field when publishing a new shortcut with addDynamicShortcuts(List) or setDynamicShortcuts(List).

A shortcut can launch any intent that the publisher app has permission to launch. For example, a shortcut can launch an unexported activity within the publisher app. A shortcut intent doesn't have to point at the target activity.

The given intent can contain extras, but these extras must contain values of primitive types in order for the system to persist these values.

setIntents

ShortcutInfo.Builder setIntents (Intent[] intents)

Sets multiple intents instead of a single intent, in order to launch an activity with other activities in back stack. Use TaskStackBuilder to build intents. The last element in the list represents the only intent that doesn't place an activity on the back stack. See the ShortcutManager javadoc for details.

setLongLabel

ShortcutInfo.Builder setLongLabel (CharSequence longLabel)

Sets the text of a shortcut.

This field is intended to be more descriptive than the shortcut title. The launcher shows this instead of the short title when it has enough space.

The recommend maximum length is 25 characters.

setRank

ShortcutInfo.Builder setRank (int rank)

"Rank" of a shortcut, which is a non-negative value that's used by the launcher app to sort shortcuts. See getRank() for details.

setShortLabel

ShortcutInfo.Builder setShortLabel (CharSequence shortLabel)

Sets the short title of a shortcut.

This is a mandatory field when publishing a new shortcut with addDynamicShortcuts(List) or setDynamicShortcuts(List).

This field is intended to be a concise description of a shortcut.

The recommended maximum length is 10 characters.