core/androidx.core.content.pm/ShortcutInfoCompat/Builder

Builder

open class Builder(source)

Builder class for ShortcutInfoCompat objects.

Constructors

Link copied to clipboard
constructor(@NonNull context: Context, @NonNull id: String)
@RestrictTo(value = LIBRARY_GROUP_PREFIX)
constructor(@NonNull shortcutInfo: ShortcutInfoCompat)
@RequiresApi(value = 25)
@RestrictTo(value = LIBRARY_GROUP_PREFIX)
constructor(@NonNull context: Context, @NonNull shortcutInfo: ShortcutInfo)

Functions

Link copied to clipboard
@NonNull
open fun addCapabilityBinding(@NonNull capability: String): ShortcutInfoCompat.Builder
Associates a shortcut with a capability without any parameters.
@NonNull
open fun addCapabilityBinding(@NonNull capability: String, @NonNull parameter: String, @NonNull parameterValues: List<String>): ShortcutInfoCompat.Builder
Associates a shortcut with a capability, and a parameter of that capability.
Link copied to clipboard
@NonNull
open fun build(): ShortcutInfoCompat
Creates a ShortcutInfoCompat instance.
Link copied to clipboard
@NonNull
open fun setActivity(@NonNull activity: ComponentName): ShortcutInfoCompat.Builder
Sets the target activity.
Link copied to clipboard
@NonNull
open fun setAlwaysBadged(): ShortcutInfoCompat.Builder
Badges the icon before passing it over to the Launcher.
Link copied to clipboard
@NonNull
open fun setCategories(@NonNull categories: Set<String>): ShortcutInfoCompat.Builder
Sets categories for a shortcut.
Link copied to clipboard
@NonNull
open fun setDisabledMessage(@NonNull disabledMessage: CharSequence): ShortcutInfoCompat.Builder
Sets the message that should be shown when the user attempts to start a shortcut that is disabled.
Link copied to clipboard
@NonNull
open fun setExcludedFromSurfaces(surfaces: Int): ShortcutInfoCompat.Builder
Sets which surfaces a shortcut will be excluded from.
Link copied to clipboard
@NonNull
open fun setExtras(@NonNull extras: PersistableBundle): ShortcutInfoCompat.Builder
Extras that the app can set for any purpose.
Link copied to clipboard
@NonNull
open fun setIcon(icon: IconCompat): ShortcutInfoCompat.Builder
Sets an icon of a shortcut.
Link copied to clipboard
@NonNull
open fun setIntent(@NonNull intent: Intent): ShortcutInfoCompat.Builder
Sets the intent of a shortcut.
Link copied to clipboard
@NonNull
open fun setIntents(@NonNull intents: Array<Intent>): ShortcutInfoCompat.Builder
Sets multiple intents instead of a single intent, in order to launch an activity with other activities in back stack.
Link copied to clipboard
@NonNull
open fun setIsConversation(): ShortcutInfoCompat.Builder
Sets the corresponding fields indicating this shortcut is aimed for conversation.
Link copied to clipboard
@NonNull
open fun setLocusId(@Nullable locusId: LocusIdCompat): ShortcutInfoCompat.Builder
Sets the LocusIdCompat associated with this shortcut.
Link copied to clipboard
@NonNull
open fun setLongLabel(@NonNull longLabel: CharSequence): ShortcutInfoCompat.Builder
Sets the text of a shortcut.
Link copied to clipboard
@NonNull
open fun setLongLived(): ShortcutInfoCompat.Builder

@NonNull
open fun setLongLived(longLived: Boolean): ShortcutInfoCompat.Builder
Sets if a shortcut would be valid even if it has been unpublished/invisible by the app (as a dynamic or pinned shortcut).
Link copied to clipboard
@NonNull
open fun setPerson(@NonNull person: Person): ShortcutInfoCompat.Builder
Associate a person to a shortcut.
Link copied to clipboard
@NonNull
open fun setPersons(@NonNull persons: Array<Person>): ShortcutInfoCompat.Builder
Sets multiple persons instead of a single person.
Link copied to clipboard
@NonNull
open fun setRank(rank: Int): ShortcutInfoCompat.Builder
Sets rank of a shortcut, which is a non-negative value that's used by the system to sort shortcuts.
Link copied to clipboard
@NonNull
open fun setShortLabel(@NonNull shortLabel: CharSequence): ShortcutInfoCompat.Builder
Sets the short title of a shortcut.
Link copied to clipboard
@NonNull
open fun setSliceUri(@NonNull sliceUri: Uri): ShortcutInfoCompat.Builder
Sets the slice uri for a shortcut.
Link copied to clipboard