Save the date! Android Dev Summit is coming to Mountain View, CA on November 7-8, 2018.

ShortcutInfo.Builder

public static class ShortcutInfo.Builder
extends Object

java.lang.Object
   ↳ android.content.pm.ShortcutInfo.Builder


Builder class for ShortcutInfo objects.

See also:

Summary

Public constructors

ShortcutInfo.Builder(Context context, String id)

Constructor.

Public methods

ShortcutInfo build()

Creates a ShortcutInfo instance.

ShortcutInfo.Builder setActivity(ComponentName activity)

Sets the target activity.

ShortcutInfo.Builder setCategories(Set<String> categories)

Sets categories for a shortcut.

ShortcutInfo.Builder setDisabledMessage(CharSequence disabledMessage)

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

ShortcutInfo.Builder setExtras(PersistableBundle extras)

Extras that the app can set for any purpose.

ShortcutInfo.Builder setIcon(Icon icon)

Sets an icon of a shortcut.

ShortcutInfo.Builder setIntent(Intent intent)

Sets the intent of a shortcut.

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.

ShortcutInfo.Builder setLongLabel(CharSequence longLabel)

Sets the text of a shortcut.

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.

ShortcutInfo.Builder setShortLabel(CharSequence shortLabel)

Sets the short title of a shortcut.

Inherited methods

Public constructors

ShortcutInfo.Builder

added in API level 25
public ShortcutInfo.Builder (Context context, 
                String id)

Constructor.

Parameters
context Context: Client context.

id String: ID of the shortcut.

Public methods

build

added in API level 25
public ShortcutInfo build ()

Creates a ShortcutInfo instance.

Returns
ShortcutInfo

This value will never be null.

setActivity

added in API level 25
public 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:

Parameters
activity ComponentName

This value must never be null.

Returns
ShortcutInfo.Builder

This value will never be null.

setCategories

added in API level 25
public ShortcutInfo.Builder setCategories (Set<String> categories)

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

Parameters
categories Set

Returns
ShortcutInfo.Builder

This value will never be null.

setDisabledMessage

added in API level 25
public ShortcutInfo.Builder setDisabledMessage (CharSequence disabledMessage)

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

Parameters
disabledMessage CharSequence

This value must never be null.

Returns
ShortcutInfo.Builder

This value will never be null.

setExtras

added in API level 25
public 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 ShortcutInfo.getExtras().

Parameters
extras PersistableBundle

This value must never be null.

Returns
ShortcutInfo.Builder

This value will never be null.

setIcon

added in API level 25
public 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 LauncherApps.getShortcutIconDrawable(ShortcutInfo, int) or LauncherApps.getShortcutBadgedIconDrawable(ShortcutInfo, int) to fetch shortcut icons.

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

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

Parameters
icon Icon

Returns
ShortcutInfo.Builder

This value will never be null.

setIntent

added in API level 25
public 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 ShortcutManager.addDynamicShortcuts(List) or ShortcutManager.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.

Parameters
intent Intent

This value must never be null.

Returns
ShortcutInfo.Builder

This value will never be null.

setIntents

added in API level 25
public 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.

Parameters
intents Intent

This value must never be null.

Returns
ShortcutInfo.Builder

This value will never be null.

setLongLabel

added in API level 25
public 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.

Parameters
longLabel CharSequence

This value must never be null.

Returns
ShortcutInfo.Builder

This value will never be null.

setRank

added in API level 25
public 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 ShortcutInfo.getRank() for details.

Parameters
rank int

Returns
ShortcutInfo.Builder

This value will never be null.

setShortLabel

added in API level 25
public ShortcutInfo.Builder setShortLabel (CharSequence shortLabel)

Sets the short title of a shortcut.

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

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

The recommended maximum length is 10 characters.

Parameters
shortLabel CharSequence

This value must never be null.

Returns
ShortcutInfo.Builder

This value will never be null.