Home Original page

LauncherApps.ShortcutQuery  |  API reference  |  Android Developers

public static class LauncherApps.ShortcutQuery
extends Object


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

Summary

Constants

int FLAG_GET_KEY_FIELDS_ONLY

Requests "key" fields only.

int FLAG_MATCH_CACHED

Include cached shortcuts in the result.

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.

int FLAG_MATCH_PINNED_BY_ANY_LAUNCHER

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

Public constructors

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 System.currentTimeMillis().

LauncherApps.ShortcutQuery setLocusIds(List<LocusId> locusIds)

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

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

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

FLAG_GET_KEY_FIELDS_ONLY

public static final int FLAG_GET_KEY_FIELDS_ONLY

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.

Constant Value: 4 (0x00000004)

FLAG_MATCH_CACHED

public static final int FLAG_MATCH_CACHED

Include cached shortcuts in the result.

Constant Value: 16 (0x00000010)

FLAG_MATCH_DYNAMIC

public static final int FLAG_MATCH_DYNAMIC

Include dynamic shortcuts in the result.

Constant Value: 1 (0x00000001)

FLAG_MATCH_MANIFEST

public static final int FLAG_MATCH_MANIFEST

Include manifest shortcuts in the result.

Constant Value: 8 (0x00000008)

FLAG_MATCH_PINNED

public static final int FLAG_MATCH_PINNED

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.

Constant Value: 2 (0x00000002)

FLAG_MATCH_PINNED_BY_ANY_LAUNCHER

public static final int FLAG_MATCH_PINNED_BY_ANY_LAUNCHER

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.

Constant Value: 1024 (0x00000400)

Public constructors

ShortcutQuery

public ShortcutQuery ()

Public methods