LauncherApps

ACTION_CONFIRM_PIN_APPWIDGET

static val ACTION_CONFIRM_PIN_APPWIDGET: String

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

See the android.appwidget.AppWidgetManager#requestPinAppWidget 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.

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

ACTION_CONFIRM_PIN_SHORTCUT

static val ACTION_CONFIRM_PIN_SHORTCUT: String

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.

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

EXTRA_PIN_ITEM_REQUEST

static val EXTRA_PIN_ITEM_REQUEST: String

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.

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

getActivityList

open fun getActivityList(
    packageName: String!, 
    user: UserHandle!
): MutableList<LauncherActivityInfo!>!

Retrieves a list of activities that specify Intent#ACTION_MAIN and Intent#CATEGORY_LAUNCHER, across all apps, for a specified user. If an app doesn't have any activities that specify ACTION_MAIN or CATEGORY_LAUNCHER, the system adds a synthesized activity to the list. This synthesized activity represents the app's details page within system settings.

Note: It's possible for system apps, such as app stores, to prevent the system from adding synthesized activities to the returned list.

As of Android Q, at least one of the app's activities or synthesized activities appears in the returned list unless the app satisfies at least one of the following conditions:

• The app is a system app.
• The app doesn't request any permissions.
• The app doesn't have a launcher activity that is enabled by default. A launcher activity has an intent containing the ACTION_MAIN action and the CATEGORY_LAUNCHER category.

Additionally, the system hides synthesized activities for some or all apps in the following enterprise-related cases:

• If the device is a fully managed device, no synthesized activities for any app appear in the returned list.
• If the current user has a work profile, no synthesized activities for the user's work apps appear in the returned list.

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

getAllPackageInstallerSessions

open fun getAllPackageInstallerSessions(): MutableList<PackageInstaller.SessionInfo!>

Return list of all known install sessions in this user and managed profiles, regardless of the installer. Callers need to either declare <queries> element with the specific package name in the app's manifest, have the android.permission.QUERY_ALL_PACKAGES, or be the session owner to retrieve these details.

To receive callbacks for hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

getAppMarketActivityIntent

open fun getAppMarketActivityIntent(
    packageName: String?, 
    user: UserHandle
): IntentSender?

Returns an intent sender which can be used to start the App Market activity (Installer Activity). This method is primarily used to get an intent sender which starts App Market activity for another profile, if the caller is not otherwise allowed to start activity in that profile.

When packageName is set, intent sender to start the App Market Activity which installed the package in calling user will be returned, but for the profile passed.

When packageName is not set, intent sender to launch the default App Market Activity for the profile will be returned. In case there are multiple App Market Activities available for the profile, IntentPicker will be started, allowing user to choose the preferred activity.

The method will fall back to the behaviour of not having the packageName set, in case:

• No activity for the packageName is found in calling user-space.
• The App Market Activity which installed the package in calling user-space is not present.
• The App Market Activity which installed the package in calling user-space is not present in the profile passed.

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

getApplicationInfo

open fun getApplicationInfo(
    packageName: String, 
    flags: Int, 
    user: UserHandle
): ApplicationInfo!

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

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

getLauncherUserInfo

fun getLauncherUserInfo(userHandle: UserHandle): LauncherUserInfo?

Returns information related to a user which is useful for displaying UI elements to distinguish it from other users (eg, badges).

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

getPinItemRequest

open fun getPinItemRequest(intent: Intent!): LauncherApps.PinItemRequest!

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

getPreInstalledSystemPackages

open fun getPreInstalledSystemPackages(userHandle: UserHandle): MutableList<String!>

Returns the list of the system packages that are installed at user creation.

An empty list denotes that all system packages should be treated as pre-installed for that user at creation.

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

getProfiles

open fun getProfiles(): MutableList<UserHandle!>!

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.

To get hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

getShortcutBadgedIconDrawable

open fun getShortcutBadgedIconDrawable(
    shortcut: ShortcutInfo!, 
    density: Int
): Drawable!

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

open fun getShortcutConfigActivityIntent(info: LauncherActivityInfo): IntentSender?

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 android.app.Activity#RESULT_OK.

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

getShortcutConfigActivityList

open fun getShortcutConfigActivityList(
    packageName: String?, 
    user: UserHandle
): MutableList<LauncherActivityInfo!>!

Retrieves a list of config activities for creating ShortcutInfo.

getShortcutIconDrawable

open fun getShortcutIconDrawable(
    shortcut: ShortcutInfo, 
    density: Int
): Drawable!

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

getShortcutIntent

open fun getShortcutIntent(
    packageName: String, 
    shortcutId: String, 
    opts: Bundle?, 
    user: UserHandle
): PendingIntent?

Returns PendingIntent associated with specified shortcut.

getShortcuts

open fun getShortcuts(
    query: LauncherApps.ShortcutQuery, 
    user: UserHandle
): MutableList<ShortcutInfo!>?

Returns ShortcutInfos that match query.

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

getSuspendedPackageLauncherExtras

open fun getSuspendedPackageLauncherExtras(
    packageName: String!, 
    user: UserHandle!
): Bundle?

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.

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

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

hasShortcutHostPermission

open fun hasShortcutHostPermission(): Boolean

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

open fun isActivityEnabled(
    component: ComponentName!, 
    user: UserHandle!
): Boolean

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

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

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

isPackageEnabled

open fun isPackageEnabled(
    packageName: String!, 
    user: UserHandle!
): Boolean

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

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

pinShortcuts

open fun pinShortcuts(
    packageName: String, 
    shortcutIds: MutableList<String!>, 
    user: UserHandle
): Unit

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

For user-profiles with items restricted on home screen, caller must have the required permission.

registerCallback

open fun registerCallback(callback: LauncherApps.Callback!): Unit

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

To receive callbacks for hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

registerCallback

open fun registerCallback(
    callback: LauncherApps.Callback!, 
    handler: Handler!
): Unit

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

To receive callbacks for hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

registerPackageInstallerSessionCallback

open fun registerPackageInstallerSessionCallback(
    executor: Executor, 
    callback: PackageInstaller.SessionCallback
): Unit

Register a callback to watch for session lifecycle events in this user and managed profiles. Callers need to either declare <queries> element with the specific package name in the app's manifest, have the android.permission.QUERY_ALL_PACKAGES, or be the session owner to watch for these events.

Session callbacks are not sent for user-profiles that have items restricted on home screen.

resolveActivity

open fun resolveActivity(
    intent: Intent!, 
    user: UserHandle!
): LauncherActivityInfo!

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

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

setArchiveCompatibility

open fun setArchiveCompatibility(params: LauncherApps.ArchiveCompatibilityParams): Unit

Disable different archive compatibility options of the launcher for the caller of this method.

shouldHideFromSuggestions

open fun shouldHideFromSuggestions(
    packageName: String, 
    user: UserHandle
): Boolean

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).

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

startAppDetailsActivity

open fun startAppDetailsActivity(
    component: ComponentName!, 
    user: UserHandle!, 
    sourceBounds: Rect!, 
    opts: Bundle!
): Unit

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

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

startMainActivity

open fun startMainActivity(
    component: ComponentName!, 
    user: UserHandle!, 
    sourceBounds: Rect!, 
    opts: Bundle!
): Unit

Starts a Main activity in the specified profile.

If the user in question is a hidden profile UserManager#USER_TYPE_PROFILE_PRIVATE, caller should have normal android.Manifest.permission#ACCESS_HIDDEN_PROFILES permission and the android.app.role.RoleManager#ROLE_HOME role.

startPackageInstallerSessionDetailsActivity

open fun startPackageInstallerSessionDetailsActivity(
    sessionInfo: PackageInstaller.SessionInfo, 
    sourceBounds: Rect?, 
    opts: Bundle?
): Unit

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

startShortcut

open fun startShortcut(
    packageName: String, 
    shortcutId: String, 
    sourceBounds: Rect?, 
    startActivityOptions: Bundle?, 
    user: UserHandle
): Unit

Starts a shortcut.

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

startShortcut

open fun startShortcut(
    shortcut: ShortcutInfo, 
    sourceBounds: Rect?, 
    startActivityOptions: Bundle?
): Unit

Launches a shortcut.

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

unregisterCallback

open fun unregisterCallback(callback: LauncherApps.Callback!): Unit

Unregisters a callback that was previously registered.

unregisterPackageInstallerSessionCallback

open fun unregisterPackageInstallerSessionCallback(callback: PackageInstaller.SessionCallback): Unit

Unregisters a callback that was previously registered.