Package org.robolectric.shadows

Class ShadowLauncherApps

java.lang.Object

org.robolectric.shadows.ShadowLauncherApps

@Implements(value=android.content.pm.LauncherApps.class,
            minSdk=21)
public class ShadowLauncherApps
extends Object

Shadow of LauncherApps.

Constructor Summary

Constructors

Constructor	Description
ShadowLauncherApps()

Method Summary

Modifier and Type	Method	Description
void	addActivity(UserHandle userHandle, LauncherActivityInfo activityInfo)	Adds a LauncherActivityInfo to be retrieved by getActivityList(String, UserHandle).
void	addDynamicShortcut(ShortcutInfo shortcutInfo)	Adds a dynamic shortcut to be returned by getShortcuts(ShortcutQuery, UserHandle).
void	addEnabledPackage(UserHandle userHandle, String packageName)	Adds an enabled package to be checked by isPackageEnabled(String, UserHandle).
void	addShortcutConfigActivity(UserHandle userHandle, LauncherActivityInfo activityInfo)	Adds a LauncherActivityInfo to be retrieved by getShortcutConfigActivityList(String, UserHandle).
protected List<LauncherActivityInfo>	getActivityList(String packageName, UserHandle user)
protected List<PackageInstaller.SessionInfo>	getAllPackageInstallerSessions()
protected IntentSender	getShortcutConfigActivityIntent(LauncherActivityInfo info)
protected List<LauncherActivityInfo>	getShortcutConfigActivityList(String packageName, UserHandle user)
protected List<ShortcutInfo>	getShortcuts(LauncherApps.ShortcutQuery query, UserHandle user)	This method is an incomplete implementation of this API that only supports querying for pinned dynamic shortcuts.
protected Bundle	getSuspendedPackageLauncherExtras(String packageName, UserHandle user)
protected boolean	hasShortcutHostPermission()
protected boolean	isActivityEnabled(ComponentName component, UserHandle user)
protected boolean	isPackageEnabled(String packageName, UserHandle user)
void	notifyPackageAdded(String packageName)	Fires LauncherApps.Callback.onPackageAdded(String, UserHandle) on all of the registered callbacks, with the provided packageName.
void	notifyPackageRemoved(String packageName)	Fires LauncherApps.Callback.onPackageRemoved(String, UserHandle) on all of the registered callbacks, with the provided packageName.
protected void	pinShortcuts(String packageName, List<String> shortcutIds, UserHandle user)
protected void	registerCallback(LauncherApps.Callback callback)
protected void	registerCallback(LauncherApps.Callback callback, Handler handler)
protected void	registerPackageInstallerSessionCallback(Executor executor, PackageInstaller.SessionCallback callback)
protected boolean	shouldHideFromSuggestions(String packageName, UserHandle user)
protected void	startAppDetailsActivity(ComponentName component, UserHandle user, Rect sourceBounds, Bundle opts)
protected void	startPackageInstallerSessionDetailsActivity(PackageInstaller.SessionInfo sessionInfo, Rect sourceBounds, Bundle opts)
protected void	startShortcut(ShortcutInfo shortcut, Rect sourceBounds, Bundle startActivityOptions)
protected void	startShortcut(String packageName, String shortcutId, Rect sourceBounds, Bundle startActivityOptions, UserHandle user)
protected void	unregisterCallback(LauncherApps.Callback callback)
protected void	unregisterPackageInstallerSessionCallback(PackageInstaller.SessionCallback callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShadowLauncherApps

public ShadowLauncherApps()

Method Detail

addDynamicShortcut

public void addDynamicShortcut(ShortcutInfo shortcutInfo)

Adds a dynamic shortcut to be returned by getShortcuts(ShortcutQuery, UserHandle).

Parameters:

shortcutInfo - the shortcut to add.

notifyPackageAdded

public void notifyPackageAdded(String packageName)

Fires LauncherApps.Callback.onPackageAdded(String, UserHandle) on all of the registered callbacks, with the provided packageName.

Parameters:

packageName - the package the was added.

addEnabledPackage

public void addEnabledPackage(UserHandle userHandle,
                              String packageName)

Adds an enabled package to be checked by isPackageEnabled(String, UserHandle).

Parameters:

userHandle - the user handle to be added.

packageName - the package name to be added.

addShortcutConfigActivity

public void addShortcutConfigActivity(UserHandle userHandle,
                                      LauncherActivityInfo activityInfo)

Adds a LauncherActivityInfo to be retrieved by getShortcutConfigActivityList(String, UserHandle).

Parameters:

userHandle - the user handle to be added.

activityInfo - the LauncherActivityInfo to be added.

addActivity

public void addActivity(UserHandle userHandle,
                        LauncherActivityInfo activityInfo)

Adds a LauncherActivityInfo to be retrieved by getActivityList(String, UserHandle).

Parameters:

userHandle - the user handle to be added.

activityInfo - the LauncherActivityInfo to be added.

notifyPackageRemoved

public void notifyPackageRemoved(String packageName)

Fires LauncherApps.Callback.onPackageRemoved(String, UserHandle) on all of the registered callbacks, with the provided packageName.

Parameters:

packageName - the package the was removed.

startPackageInstallerSessionDetailsActivity

@Implementation(minSdk=29)
protected void startPackageInstallerSessionDetailsActivity(@NonNull
                                                           PackageInstaller.SessionInfo sessionInfo,
                                                           @Nullable
                                                           Rect sourceBounds,
                                                           @Nullable
                                                           Bundle opts)

startAppDetailsActivity

@Implementation
protected void startAppDetailsActivity(ComponentName component,
                                       UserHandle user,
                                       Rect sourceBounds,
                                       Bundle opts)

getShortcutConfigActivityList

@Implementation(minSdk=26)
protected List<LauncherActivityInfo> getShortcutConfigActivityList(@Nullable
                                                                   String packageName,
                                                                   @NonNull
                                                                   UserHandle user)

getShortcutConfigActivityIntent

@Implementation(minSdk=26)
@Nullable
protected IntentSender getShortcutConfigActivityIntent(@NonNull
                                                       LauncherActivityInfo info)

isPackageEnabled

@Implementation
protected boolean isPackageEnabled(String packageName,
                                   UserHandle user)

getActivityList

@Implementation(minSdk=21)
protected List<LauncherActivityInfo> getActivityList(String packageName,
                                                     UserHandle user)

getSuspendedPackageLauncherExtras

@Implementation(minSdk=28)
@Nullable
protected Bundle getSuspendedPackageLauncherExtras(String packageName,
                                                   UserHandle user)

shouldHideFromSuggestions

@Implementation(minSdk=29)
protected boolean shouldHideFromSuggestions(@NonNull
                                            String packageName,
                                            @NonNull
                                            UserHandle user)

isActivityEnabled

@Implementation
protected boolean isActivityEnabled(ComponentName component,
                                    UserHandle user)

hasShortcutHostPermission

@Implementation(minSdk=24)
protected boolean hasShortcutHostPermission()

getShortcuts

@Implementation(minSdk=25)
@Nullable
protected List<ShortcutInfo> getShortcuts(@NonNull
                                          LauncherApps.ShortcutQuery query,
                                          @NonNull
                                          UserHandle user)

This method is an incomplete implementation of this API that only supports querying for pinned dynamic shortcuts. It also doesn't not support LauncherApps.ShortcutQuery.setChangedSince(long).

pinShortcuts

@Implementation(minSdk=25)
protected void pinShortcuts(@NonNull
                            String packageName,
                            @NonNull
                            List<String> shortcutIds,
                            @NonNull
                            UserHandle user)

startShortcut

@Implementation(minSdk=25)
protected void startShortcut(@NonNull
                             String packageName,
                             @NonNull
                             String shortcutId,
                             @Nullable
                             Rect sourceBounds,
                             @Nullable
                             Bundle startActivityOptions,
                             @NonNull
                             UserHandle user)

startShortcut

@Implementation(minSdk=25)
protected void startShortcut(@NonNull
                             ShortcutInfo shortcut,
                             @Nullable
                             Rect sourceBounds,
                             @Nullable
                             Bundle startActivityOptions)

registerCallback

@Implementation
protected void registerCallback(LauncherApps.Callback callback)

registerCallback

@Implementation
protected void registerCallback(LauncherApps.Callback callback,
                                Handler handler)

unregisterCallback

@Implementation
protected void unregisterCallback(LauncherApps.Callback callback)

registerPackageInstallerSessionCallback

@Implementation(minSdk=29)
protected void registerPackageInstallerSessionCallback(@NonNull
                                                       Executor executor,
                                                       @NonNull
                                                       PackageInstaller.SessionCallback callback)

unregisterPackageInstallerSessionCallback

@Implementation(minSdk=29)
protected void unregisterPackageInstallerSessionCallback(@NonNull
                                                         PackageInstaller.SessionCallback callback)

getAllPackageInstallerSessions

@Implementation(minSdk=29)
@NonNull
protected List<PackageInstaller.SessionInfo> getAllPackageInstallerSessions()