Skip to content

Most visited

Recently visited

navigation

LauncherApps.ShortcutQuery

public static class LauncherApps.ShortcutQuery
extends Object

java.lang.Object
   ↳ android.content.pm.LauncherApps.ShortcutQuery


Represents a query passed to getShortcuts(ShortcutQuery, UserHandle).

Summary

Constants

int FLAG_GET_KEY_FIELDS_ONLY

Requests "key" fields only.

int FLAG_MATCH_DYNAMIC

Include dynamic shortcuts in the result.

int FLAG_MATCH_MANIFEST

Include manifest shortcuts in the result.

int FLAG_MATCH_PINNED

Include pinned shortcuts in the result.

Public constructors

LauncherApps.ShortcutQuery()

Public methods

LauncherApps.ShortcutQuery setActivity(ComponentName activity)

If non-null, returns only shortcuts associated with the activity; i.e.

LauncherApps.ShortcutQuery setChangedSince(long changedSince)

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

LauncherApps.ShortcutQuery setPackage(String packageName)

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

LauncherApps.ShortcutQuery setQueryFlags(int queryFlags)

Set query options.

LauncherApps.ShortcutQuery setShortcutIds(List<String> shortcutIds)

If non-null, return only the specified shortcuts by ID.

Inherited methods

From class java.lang.Object

Constants

FLAG_GET_KEY_FIELDS_ONLY

added in API level 25
int FLAG_GET_KEY_FIELDS_ONLY

Requests "key" fields only. See 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 getLastChangedTimestamp() for each shortcut, fetching a shortcut's non-key information only if that shortcut has been updated.

See also:

Constant Value: 4 (0x00000004)

FLAG_MATCH_DYNAMIC

added in API level 25
int FLAG_MATCH_DYNAMIC

Include dynamic shortcuts in the result.

Constant Value: 1 (0x00000001)

FLAG_MATCH_MANIFEST

added in API level 25
int FLAG_MATCH_MANIFEST

Include manifest shortcuts in the result.

Constant Value: 8 (0x00000008)

FLAG_MATCH_PINNED

added in API level 25
int FLAG_MATCH_PINNED

Include pinned shortcuts in the result.

Constant Value: 2 (0x00000002)

Public constructors

LauncherApps.ShortcutQuery

added in API level 25
LauncherApps.ShortcutQuery ()

Public methods

setActivity

added in API level 25
LauncherApps.ShortcutQuery setActivity (ComponentName activity)

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

Parameters
activity ComponentName

This value may be null.

Returns
LauncherApps.ShortcutQuery

setChangedSince

added in API level 25
LauncherApps.ShortcutQuery setChangedSince (long changedSince)

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

Parameters
changedSince long

Returns
LauncherApps.ShortcutQuery

setPackage

added in API level 25
LauncherApps.ShortcutQuery setPackage (String packageName)

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

Parameters
packageName String

This value may be null.

Returns
LauncherApps.ShortcutQuery

setQueryFlags

added in API level 25
LauncherApps.ShortcutQuery setQueryFlags (int queryFlags)

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

Parameters
queryFlags int

Returns
LauncherApps.ShortcutQuery

setShortcutIds

added in API level 25
LauncherApps.ShortcutQuery setShortcutIds (List<String> shortcutIds)

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

Parameters
shortcutIds List

This value may be null.

Returns
LauncherApps.ShortcutQuery

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

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

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 short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)