ShortcutQuery

FLAG_GET_KEY_FIELDS_ONLY

static val FLAG_GET_KEY_FIELDS_ONLY: Int

Requests "key" fields only. See ShortcutInfo.hasKeyFieldsOnly()'s javadoc to see which fields fields "key". This allows quicker access to shortcut information in order to determine whether the caller's in-memory cache needs to be updated.

Typically, launcher applications cache all or most shortcut information in memory in order to show shortcuts without a delay. When a given launcher application wants to update its cache, such as when its process restarts, it can fetch shortcut information with this flag. The application can then check ShortcutInfo.getLastChangedTimestamp() for each shortcut, fetching a shortcut's non-key information only if that shortcut has been updated.

Value: 4

FLAG_MATCH_CACHED

static val FLAG_MATCH_CACHED: Int

Include cached shortcuts in the result.

Value: 16

FLAG_MATCH_DYNAMIC

static val FLAG_MATCH_DYNAMIC: Int

Include dynamic shortcuts in the result.

Value: 1

FLAG_MATCH_MANIFEST

static val FLAG_MATCH_MANIFEST: Int

Include manifest shortcuts in the result.

Value: 8

FLAG_MATCH_PINNED

static val FLAG_MATCH_PINNED: Int

Include pinned shortcuts in the result.

If you are the selected assistant app, and wishes to fetch all shortcuts that the user owns on the launcher (or by other launchers, in case the user has multiple), use FLAG_MATCH_PINNED_BY_ANY_LAUNCHER instead.

If you're a regular launcher app, there's no way to get shortcuts pinned by other launchers, and FLAG_MATCH_PINNED_BY_ANY_LAUNCHER will be ignored. So use this flag to get own pinned shortcuts.

Value: 2

FLAG_MATCH_PINNED_BY_ANY_LAUNCHER

static val FLAG_MATCH_PINNED_BY_ANY_LAUNCHER: Int

Include all pinned shortcuts by any launchers, not just by the caller, in the result.

The caller must be the selected assistant app to use this flag, or have the system ACCESS_SHORTCUTS permission.

If you are the selected assistant app, and wishes to fetch all shortcuts that the user owns on the launcher (or by other launchers, in case the user has multiple), use FLAG_MATCH_PINNED_BY_ANY_LAUNCHER instead.

If you're a regular launcher app (or any app that's not the selected assistant app) then this flag will be ignored.

Value: 1024

ShortcutQuery

ShortcutQuery()

setActivity

open fun setActivity(activity: ComponentName?): LauncherApps.ShortcutQuery!

If non-null, returns only shortcuts associated with the activity; i.e. ShortcutInfos whose ShortcutInfo.getActivity() are equal to activity.

setChangedSince

open fun setChangedSince(changedSince: Long): LauncherApps.ShortcutQuery!

If non-zero, returns only shortcuts that have been added or updated since the given timestamp, expressed in milliseconds since the Epoch—see System.currentTimeMillis().

setLocusIds

open fun setLocusIds(locusIds: MutableList<LocusId!>?): LauncherApps.ShortcutQuery

If non-null, return only the specified shortcuts by locus ID. When setting this field, a package name must also be set with setPackage.

setPackage

open fun setPackage(packageName: String?): LauncherApps.ShortcutQuery!

If non-null, returns only shortcuts from the package.

setQueryFlags

open fun setQueryFlags(queryFlags: Int): LauncherApps.ShortcutQuery!

Set query options. At least one of the MATCH flags should be set. Otherwise, no shortcuts will be returned.

• FLAG_MATCH_DYNAMIC
• FLAG_MATCH_PINNED
• FLAG_MATCH_MANIFEST
• FLAG_MATCH_CACHED
• FLAG_GET_KEY_FIELDS_ONLY

setShortcutIds

open fun setShortcutIds(shortcutIds: MutableList<String!>?): LauncherApps.ShortcutQuery!

If non-null, return only the specified shortcuts by ID. When setting this field, a package name must also be set with setPackage.