Skip to content

Most visited

Recently visited

navigation

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

From class java.lang.Object

Public constructors

ShortcutInfo.Builder

Added in API level 25
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
ShortcutInfo build ()

Creates a ShortcutInfo instance.

Returns
ShortcutInfo

setActivity

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

Parameters
activity ComponentName
Returns
ShortcutInfo.Builder

See also:

setCategories

Added in API level 25
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

See also:

setDisabledMessage

Added in API level 25
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
Returns
ShortcutInfo.Builder

See also:

setExtras

Added in API level 25
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().

Parameters
extras PersistableBundle
Returns
ShortcutInfo.Builder

setIcon

Added in API level 25
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) and createWithResource(Context, int) are supported. Other types, such as URI-based icons, are not supported.

Parameters
icon Icon
Returns
ShortcutInfo.Builder

See also:

setIntent

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

Parameters
intent Intent
Returns
ShortcutInfo.Builder

See also:

setIntents

Added in API level 25
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
Returns
ShortcutInfo.Builder

See also:

setLongLabel

Added in API level 25
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
Returns
ShortcutInfo.Builder

See also:

setRank

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

Parameters
rank int
Returns
ShortcutInfo.Builder

setShortLabel

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

Parameters
shortLabel CharSequence
Returns
ShortcutInfo.Builder

See also:

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.