LauncherApps

ACTION_CONFIRM_PIN_APPWIDGET

public static final String ACTION_CONFIRM_PIN_APPWIDGET

Activity Action: For the default launcher to show the confirmation dialog to create a pinned app widget.

See the AppWidgetManager.requestPinAppWidget(ComponentName, Bundle, PendingIntent) javadoc for details.

Use getPinItemRequest(android.content.Intent) to get a PinItemRequest object, and call PinItemRequest#accept(Bundle) if the user accepts. If the user doesn't accept, no further action is required.

Constant Value: "android.content.pm.action.CONFIRM_PIN_APPWIDGET"

ACTION_CONFIRM_PIN_SHORTCUT

public static final String ACTION_CONFIRM_PIN_SHORTCUT

Activity Action: For the default launcher to show the confirmation dialog to create a pinned shortcut.

See the ShortcutManager javadoc for details.

Use getPinItemRequest(android.content.Intent) to get a PinItemRequest object, and call PinItemRequest#accept(Bundle) if the user accepts. If the user doesn't accept, no further action is required.

Constant Value: "android.content.pm.action.CONFIRM_PIN_SHORTCUT"

EXTRA_PIN_ITEM_REQUEST

public static final String EXTRA_PIN_ITEM_REQUEST

An extra for ACTION_CONFIRM_PIN_SHORTCUT & ACTION_CONFIRM_PIN_APPWIDGET containing a PinItemRequest of appropriate type asked to pin.

A helper function getPinItemRequest(android.content.Intent) can be used instead of using this constant directly.

Constant Value: "android.content.pm.extra.PIN_ITEM_REQUEST"

getActivityList

public List<LauncherActivityInfo> getActivityList (String packageName, 
                UserHandle user)

Retrieves a list of launchable activities that match Intent#ACTION_MAIN and Intent#CATEGORY_LAUNCHER, for a specified user. Result may include synthesized activities like app details Activity injected by system.

getAllPackageInstallerSessions

public List<PackageInstaller.SessionInfo> getAllPackageInstallerSessions ()

Return list of all known install sessions in this user and managed profiles, regardless of the installer.

getAppUsageLimit

public LauncherApps.AppUsageLimit getAppUsageLimit (String packageName, 
                UserHandle user)

Returns an object describing the app usage limit for the given package. If there are multiple limits that apply to the package, the one with the smallest time remaining will be returned.

getApplicationInfo

public ApplicationInfo getApplicationInfo (String packageName, 
                int flags, 
                UserHandle user)

Returns ApplicationInfo about an application installed for a specific user profile.

getPinItemRequest

public LauncherApps.PinItemRequest getPinItemRequest (Intent intent)

A helper method to extract a PinItemRequest set to the EXTRA_PIN_ITEM_REQUEST extra.

getProfiles

public List<UserHandle> getProfiles ()

Return a list of profiles that the caller can access via the LauncherApps APIs.

If the caller is running on a managed profile, it'll return only the current profile. Otherwise it'll return the same list as UserManager#getUserProfiles() would.

getShortcutBadgedIconDrawable

public Drawable getShortcutBadgedIconDrawable (ShortcutInfo shortcut, 
                int density)

Returns the shortcut icon with badging appropriate for the profile.

The calling launcher application must be allowed to access the shortcut information, as defined in hasShortcutHostPermission().

getShortcutConfigActivityIntent

public IntentSender getShortcutConfigActivityIntent (LauncherActivityInfo info)

Returns an intent sender which can be used to start the configure activity for creating custom shortcuts. Use this method if the provider is in another profile as you are not allowed to start an activity in another profile.

The caller should receive PinItemRequest in onActivityResult on Activity.RESULT_OK.

Callers must be allowed to access the shortcut information, as defined in hasShortcutHostPermission().

getShortcutConfigActivityList

public List<LauncherActivityInfo> getShortcutConfigActivityList (String packageName, 
                UserHandle user)

Retrieves a list of config activities for creating ShortcutInfo.

getShortcutIconDrawable

public Drawable getShortcutIconDrawable (ShortcutInfo shortcut, 
                int density)

Returns the icon for this shortcut, without any badging for the profile.

The calling launcher application must be allowed to access the shortcut information, as defined in hasShortcutHostPermission().

getShortcuts

public List<ShortcutInfo> getShortcuts (LauncherApps.ShortcutQuery query, 
                UserHandle user)

Returns ShortcutInfos that match query.

Callers must be allowed to access the shortcut information, as defined in hasShortcutHostPermission().

getSuspendedPackageLauncherExtras

public Bundle getSuspendedPackageLauncherExtras (String packageName, 
                UserHandle user)

Gets the launcher extras supplied to the system when the given package was suspended via PackageManager#setPackagesSuspended(String[], boolean, PersistableBundle, PersistableBundle, String).

The contents of this Bundle are supposed to be a contract between the suspending app and the launcher.

Note: This just returns whatever extras were provided to the system, which might even be null.

hasShortcutHostPermission

public boolean hasShortcutHostPermission ()

Returns whether the caller can access the shortcut information. Access is currently available to:

• The current launcher (or default launcher if there is no set current launcher).
• The currently active voice interaction service.

Note when this method returns false, it may be a temporary situation because the user is trying a new launcher application. The user may decide to change the default launcher back to the calling application again, so even if a launcher application loses this permission, it does not have to purge pinned shortcut information. If the calling launcher application contains pinned shortcuts, they will still work, even though the caller no longer has the shortcut host permission.

isActivityEnabled

public boolean isActivityEnabled (ComponentName component, 
                UserHandle user)

Checks if the activity exists and it enabled for a profile.

The activity may still not be exported, in which case startMainActivity(ComponentName, UserHandle, Rect, Bundle) will throw a SecurityException unless the caller has the same UID as the target app's.

isPackageEnabled

public boolean isPackageEnabled (String packageName, 
                UserHandle user)

Checks if the package is installed and enabled for a profile.

pinShortcuts

public void pinShortcuts (String packageName, 
                List<String> shortcutIds, 
                UserHandle user)

Pin shortcuts on a package.

This API is NOT cumulative; this will replace all pinned shortcuts for the package. However, different launchers may have different set of pinned shortcuts.

The calling launcher application must be allowed to access the shortcut information, as defined in hasShortcutHostPermission().

registerCallback

public void registerCallback (LauncherApps.Callback callback)

Registers a callback for changes to packages in this user and managed profiles.

registerCallback

public void registerCallback (LauncherApps.Callback callback, 
                Handler handler)

Registers a callback for changes to packages in this user and managed profiles.

registerPackageInstallerSessionCallback

public void registerPackageInstallerSessionCallback (Executor executor, 
                PackageInstaller.SessionCallback callback)

Register a callback to watch for session lifecycle events in this user and managed profiles.

resolveActivity

public LauncherActivityInfo resolveActivity (Intent intent, 
                UserHandle user)

Returns the activity info for a given intent and user handle, if it resolves. Otherwise it returns null.

shouldHideFromSuggestions

public boolean shouldHideFromSuggestions (String packageName, 
                UserHandle user)

Returns whether a package should be hidden from suggestions to the user. Currently, this could be done because the package was marked as distracting to the user via PackageManager.setDistractingPackageRestrictions(String[], int).

startAppDetailsActivity

public void startAppDetailsActivity (ComponentName component, 
                UserHandle user, 
                Rect sourceBounds, 
                Bundle opts)

Starts the settings activity to show the application details for a package in the specified profile.

startMainActivity

public void startMainActivity (ComponentName component, 
                UserHandle user, 
                Rect sourceBounds, 
                Bundle opts)

Starts a Main activity in the specified profile.

startPackageInstallerSessionDetailsActivity

public void startPackageInstallerSessionDetailsActivity (PackageInstaller.SessionInfo sessionInfo, 
                Rect sourceBounds, 
                Bundle opts)

Starts an activity to show the details of the specified session.

startShortcut

public void startShortcut (String packageName, 
                String shortcutId, 
                Rect sourceBounds, 
                Bundle startActivityOptions, 
                UserHandle user)

Starts a shortcut.

The calling launcher application must be allowed to access the shortcut information, as defined in hasShortcutHostPermission().

startShortcut

public void startShortcut (ShortcutInfo shortcut, 
                Rect sourceBounds, 
                Bundle startActivityOptions)

Launches a shortcut.

The calling launcher application must be allowed to access the shortcut information, as defined in hasShortcutHostPermission().

unregisterCallback

public void unregisterCallback (LauncherApps.Callback callback)

Unregisters a callback that was previously registered.

unregisterPackageInstallerSessionCallback

public void unregisterPackageInstallerSessionCallback (PackageInstaller.SessionCallback callback)

Unregisters a callback that was previously registered.