core/androidx.core.content.pm/ShortcutManagerCompat

ShortcutManagerCompat

open class ShortcutManagerCompat(source)

Helper for accessing features in android.content.pm.ShortcutManager.

Types

Link copied to clipboard

Properties

Link copied to clipboard
val EXTRA_SHORTCUT_ID: String = "android.intent.extra.shortcut.ID"
Key to get the shortcut ID from extras of a share intent.
Link copied to clipboard
val FLAG_MATCH_CACHED: Int = 8
Include cached shortcuts in the result.
Link copied to clipboard
val FLAG_MATCH_DYNAMIC: Int = 2
Include dynamic shortcuts in the result.
Link copied to clipboard
val FLAG_MATCH_MANIFEST: Int = 1
Include manifest shortcuts in the result.
Link copied to clipboard
val FLAG_MATCH_PINNED: Int = 4
Include pinned shortcuts in the result.

Functions

Link copied to clipboard
open fun addDynamicShortcuts(@NonNull context: Context, @NonNull shortcutInfoList: List<ShortcutInfoCompat>): Boolean
Publish the list of dynamic shortcuts.
Link copied to clipboard
@NonNull
open fun createShortcutResultIntent(@NonNull context: Context, @NonNull shortcut: ShortcutInfoCompat): Intent
Returns an Intent which can be used by the launcher to pin shortcut.
Link copied to clipboard
open fun disableShortcuts(@NonNull context: Context, @NonNull shortcutIds: List<String>, @Nullable disabledMessage: CharSequence)
Disable pinned shortcuts, showing the user a custom error message when they try to select the disabled shortcuts.
Link copied to clipboard
open fun enableShortcuts(@NonNull context: Context, @NonNull shortcutInfoList: List<ShortcutInfoCompat>)
Re-enable pinned shortcuts that were previously disabled.
Link copied to clipboard
@NonNull
open fun getDynamicShortcuts(@NonNull context: Context): List<ShortcutInfoCompat>
Return all dynamic shortcuts from the caller app.
Link copied to clipboard
open fun getIconMaxHeight(@NonNull context: Context): Int
Return the max height for icons, in pixels.
Link copied to clipboard
open fun getIconMaxWidth(@NonNull context: Context): Int
Return the max width for icons, in pixels.
Link copied to clipboard
Link copied to clipboard
@NonNull
open fun getShortcuts(@NonNull context: Context, matchFlags: Int): List<ShortcutInfoCompat>
Returns ShortcutInfoCompats that match matchFlags.
Link copied to clipboard
open fun isRateLimitingActive(@NonNull context: Context): Boolean
Return true when rate-limiting is active for the caller app.
Link copied to clipboard
Link copied to clipboard
open fun pushDynamicShortcut(@NonNull context: Context, @NonNull shortcut: ShortcutInfoCompat): Boolean
Publish a single dynamic shortcut.
Link copied to clipboard
open fun removeAllDynamicShortcuts(@NonNull context: Context)
Delete all dynamic shortcuts from the caller app.
Link copied to clipboard
open fun removeDynamicShortcuts(@NonNull context: Context, @NonNull shortcutIds: List<String>)
Delete dynamic shortcuts by ID.
Link copied to clipboard
open fun removeLongLivedShortcuts(@NonNull context: Context, @NonNull shortcutIds: List<String>)
Delete long lived shortcuts by ID.
Link copied to clipboard
open fun reportShortcutUsed(@NonNull context: Context, @NonNull shortcutId: String)
Apps that publish shortcuts should call this method whenever the user selects the shortcut containing the given ID or when the user completes an action in the app that is equivalent to selecting the shortcut.
Link copied to clipboard
open fun requestPinShortcut(@NonNull context: Context, @NonNull shortcut: ShortcutInfoCompat, @Nullable callback: IntentSender): Boolean
Request to create a pinned shortcut.
Link copied to clipboard
open fun setDynamicShortcuts(@NonNull context: Context, @NonNull shortcutInfoList: List<ShortcutInfoCompat>): Boolean
Publish the list of shortcuts.
Link copied to clipboard
open fun updateShortcuts(@NonNull context: Context, @NonNull shortcutInfoList: List<ShortcutInfoCompat>): Boolean
Update all existing shortcuts with the same IDs.