Package org.robolectric.shadows

Class ShadowUserManager

java.lang.Object

org.robolectric.shadows.ShadowUserManager

@Implements(value=android.os.UserManager.class,
            minSdk=17)
public class ShadowUserManager
extends Object

Robolectric implementation of UserManager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShadowUserManager.UserState Describes the current state of the user.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SECONDARY_USER_ID The default user ID user for secondary user testing, when the ID is not otherwise specified.
static int	FLAG_ADMIN
static int	FLAG_GUEST
static int	FLAG_PRIMARY
static int	FLAG_RESTRICTED

Constructor Summary

Constructors

Constructor and Description
ShadowUserManager()

Method Summary

Modifier and Type	Method and Description
protected void	__constructor__(Context context, IUserManager service)
void	addProfile(int userHandle, int profileUserHandle, String profileName, int profileFlags) Add a profile to be returned by getProfiles(int).
UserHandle	addUser(int id, String name, int flags) Creates a user with the specified name, userId and flags.
long	addUserProfile(UserHandle userHandle) Adds a profile associated for the user that the calling process is running on.
protected boolean	canSwitchUsers() Returns false by default, or the value specified via setCanSwitchUser(boolean).
void	clearUserRestrictions(UserHandle userHandle) Removes all user restrictions set of a user identified by userHandle.
void	enforcePermissionChecks(boolean enforcePermissions)
protected Bundle	getApplicationRestrictions(String packageName) Compared to real Android, there is no check that the package name matches the application package name and the method returns instantly.
protected List<UserInfo>	getProfiles(int userHandle) If any profiles have been added using addProfile(int, int, java.lang.String, int), return those profiles.
protected String	getSeedAccountType()
protected long	getSerialNumberForUser(UserHandle userHandle)
protected UserHandle	getUserForSerialNumber(long serialNumber)
protected UserInfo	getUserInfo(int userHandle)
protected List<UserHandle>	getUserProfiles()
protected Bundle	getUserRestrictions(UserHandle userHandle)
protected List<UserInfo>	getUsers()
protected int	getUserSerialNumber(int userHandle)
protected boolean	hasUserRestriction(String restrictionKey, UserHandle userHandle)
protected boolean	isDemoUser()
protected boolean	isLinkedUser()
protected boolean	isManagedProfile() If permissions are enforced (see enforcePermissionChecks(boolean)) and the application doesn’t have the Manifest.permission.MANAGE_USERS permission, throws a SecurityManager exception.
boolean	isRestrictedProfile() Returns ‘false’ by default, or the value specified via setIsRestrictedProfile(boolean).
protected boolean	isSystemUser()
protected boolean	isUserRunning(UserHandle handle)
protected boolean	isUserRunningOrStopping(UserHandle handle)
protected boolean	isUserUnlocked()
protected boolean	removeUser(int userHandle)
protected boolean	removeUser(UserHandle user)
static void	reset()
void	setApplicationRestrictions(String packageName, Bundle restrictions) Sets the value returned by UserManager.getApplicationRestrictions(String).
void	setCanSwitchUser(boolean canSwitchUser) Sets whether switching users is allowed or not; controls the return value of UserManager.canSwitchUsers()
void	setIsDemoUser(boolean isDemoUser) Deprecated. Use addUser(int, String, int) to create a demo user instead of changing default user flags.
void	setIsGuestUser(boolean isGuestUser) Deprecated. Use addUser(int, String, int) to create a guest user instead of changing default user flags.
void	setIsLinkedUser(boolean isLinkedUser) Deprecated. Use addUser(int, String, int) to create a linked user instead of changing default user flags.
void	setIsPrimaryUser(boolean isPrimaryUser) Deprecated. Use addUser(int, String, int) to create a primary user instead of changing default user flags.
void	setIsRestrictedProfile(boolean isRestrictedProfile) Sets this process running under a restricted profile; controls the return value of UserManager.isRestrictedProfile().
void	setIsSystemUser(boolean isSystemUser) Deprecated. Use addUser(int, String, int) to create a system user instead of changing default user flags.
void	setManagedProfile(boolean managedProfile) Setter for UserManager.isManagedProfile().
void	setSeedAccountType(String seedAccountType) Setter for UserManager.getSeedAccountType()
void	setSerialNumberForUser(UserHandle userHandle, long serialNumber) Deprecated. prefer addUserProfile(UserHandle) to ensure consistency of profiles known to the UserManager. Furthermore, calling this method for the current user, i.e: Process.myUserHandle() is no longer necessary as this user is always known to UserManager and has a preassigned serial number.
void	setSupportsMultipleUsers(boolean isMultiUserSupported) Sets whether multiple users are supported; controls the return value of UserManager#supportsMultipleUser.
void	setUserRestriction(UserHandle userHandle, String restrictionKey, boolean value)
void	setUserState(UserHandle handle, ShadowUserManager.UserState state) Sets the current state for a given user, see UserManager.isUserRunning(UserHandle) and UserManager.isUserRunningOrStopping(UserHandle)
void	setUserUnlocked(boolean userUnlocked) Setter for UserManager.isUserUnlocked()
protected static boolean	supportsMultipleUsers()
void	switchUser(int userId) Switches the current user to userHandle.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SECONDARY_USER_ID

public static final int DEFAULT_SECONDARY_USER_ID

The default user ID user for secondary user testing, when the ID is not otherwise specified.

See Also:

Constant Field Values

FLAG_PRIMARY

public static final int FLAG_PRIMARY

See Also:

Constant Field Values

FLAG_ADMIN

public static final int FLAG_ADMIN

See Also:

Constant Field Values

FLAG_GUEST

public static final int FLAG_GUEST

See Also:

Constant Field Values

FLAG_RESTRICTED

public static final int FLAG_RESTRICTED

See Also:

Constant Field Values

Constructor Detail

ShadowUserManager

public ShadowUserManager()

Method Detail

__constructor__

@Implementation
protected void __constructor__(Context context,
                               IUserManager service)

getApplicationRestrictions

@Implementation(minSdk=18)
protected Bundle getApplicationRestrictions(String packageName)

Compared to real Android, there is no check that the package name matches the application package name and the method returns instantly.

See Also:

setApplicationRestrictions(String, Bundle)

setApplicationRestrictions

public void setApplicationRestrictions(String packageName,
                                       Bundle restrictions)

Sets the value returned by UserManager.getApplicationRestrictions(String).

addUserProfile

public long addUserProfile(UserHandle userHandle)

Adds a profile associated for the user that the calling process is running on.

The user is assigned an arbitrary unique serial number.

Returns:

the user’s serial number

getUserProfiles

@Implementation(minSdk=21)
protected List<UserHandle> getUserProfiles()

getProfiles

@Implementation(minSdk=21)
protected List<UserInfo> getProfiles(int userHandle)

If any profiles have been added using addProfile(int, int, java.lang.String, int), return those profiles.

Otherwise follow real android behaviour.

addProfile

public void addProfile(int userHandle,
                       int profileUserHandle,
                       String profileName,
                       int profileFlags)

Add a profile to be returned by getProfiles(int).

isUserUnlocked

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

setUserUnlocked

public void setUserUnlocked(boolean userUnlocked)

Setter for UserManager.isUserUnlocked()

isManagedProfile

@Implementation(minSdk=21)
protected boolean isManagedProfile()

If permissions are enforced (see enforcePermissionChecks(boolean)) and the application doesn’t have the Manifest.permission.MANAGE_USERS permission, throws a SecurityManager exception.

Returns:

false by default, or the value specified via setManagedProfile(boolean)

See Also:

enforcePermissionChecks(boolean), setManagedProfile(boolean)

enforcePermissionChecks

public void enforcePermissionChecks(boolean enforcePermissions)

setManagedProfile

public void setManagedProfile(boolean managedProfile)

Setter for UserManager.isManagedProfile().

hasUserRestriction

@Implementation(minSdk=21)
protected boolean hasUserRestriction(String restrictionKey,
                                     UserHandle userHandle)

setUserRestriction

public void setUserRestriction(UserHandle userHandle,
                               String restrictionKey,
                               boolean value)

clearUserRestrictions

public void clearUserRestrictions(UserHandle userHandle)

Removes all user restrictions set of a user identified by userHandle.

getUserRestrictions

@Implementation(minSdk=18)
protected Bundle getUserRestrictions(UserHandle userHandle)

getSerialNumberForUser

@Implementation
protected long getSerialNumberForUser(UserHandle userHandle)

See Also:

addUserProfile(UserHandle)

setSerialNumberForUser

@Deprecated
public void setSerialNumberForUser(UserHandle userHandle,
                                   long serialNumber)

Deprecated. prefer addUserProfile(UserHandle) to ensure consistency of profiles known to the UserManager. Furthermore, calling this method for the current user, i.e: Process.myUserHandle() is no longer necessary as this user is always known to UserManager and has a preassigned serial number.

getUserForSerialNumber

@Implementation
protected UserHandle getUserForSerialNumber(long serialNumber)

See Also:

addUserProfile(UserHandle)

getUserSerialNumber

@Implementation
protected int getUserSerialNumber(int userHandle)

See Also:

addUserProfile(UserHandle)

isDemoUser

@Implementation(minSdk=25)
protected boolean isDemoUser()

Returns:

false by default, or the value specified via setIsDemoUser(boolean)

setIsDemoUser

@Deprecated
public void setIsDemoUser(boolean isDemoUser)

Deprecated. Use addUser(int, String, int) to create a demo user instead of changing default user flags.

Sets that the current user is a demo user; controls the return value of UserManager.isDemoUser().

isSystemUser

@Implementation(minSdk=23)
protected boolean isSystemUser()

Returns:

‘true’ by default, or the value specified via setIsSystemUser(boolean)

setIsSystemUser

@Deprecated
public void setIsSystemUser(boolean isSystemUser)

Deprecated. Use addUser(int, String, int) to create a system user instead of changing default user flags.

Sets that the current user is the system user; controls the return value of UserManager.isSystemUser().

setIsPrimaryUser

@Deprecated
public void setIsPrimaryUser(boolean isPrimaryUser)

Deprecated. Use addUser(int, String, int) to create a primary user instead of changing default user flags.

Sets that the current user is the primary user; controls the return value of UserManager.isPrimaryUser().

isLinkedUser

@Implementation(minSdk=18)
protected boolean isLinkedUser()

Returns:

‘false’ by default, or the value specified via setIsLinkedUser(boolean)

setIsLinkedUser

@Deprecated
public void setIsLinkedUser(boolean isLinkedUser)

Deprecated. Use addUser(int, String, int) to create a linked user instead of changing default user flags.

Sets that the current user is the linked user; controls the return value of UserManager.isLinkedUser().

isRestrictedProfile

public boolean isRestrictedProfile()

Returns ‘false’ by default, or the value specified via setIsRestrictedProfile(boolean).

setIsRestrictedProfile

public void setIsRestrictedProfile(boolean isRestrictedProfile)

Sets this process running under a restricted profile; controls the return value of UserManager.isRestrictedProfile().

setIsGuestUser

@Deprecated
public void setIsGuestUser(boolean isGuestUser)

Deprecated. Use addUser(int, String, int) to create a guest user instead of changing default user flags.

Sets that the current user is the guest user; controls the return value of UserManager.isGuestUser().

isUserRunning

@Implementation
protected boolean isUserRunning(UserHandle handle)

See Also:

setUserState(UserHandle, UserState)

isUserRunningOrStopping

@Implementation
protected boolean isUserRunningOrStopping(UserHandle handle)

See Also:

setUserState(UserHandle, UserState)

setUserState

public void setUserState(UserHandle handle,
                         ShadowUserManager.UserState state)

Sets the current state for a given user, see UserManager.isUserRunning(UserHandle) and UserManager.isUserRunningOrStopping(UserHandle)

getUsers

@Implementation
protected List<UserInfo> getUsers()

getUserInfo

@Implementation
protected UserInfo getUserInfo(int userHandle)

canSwitchUsers

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

Returns false by default, or the value specified via setCanSwitchUser(boolean).

setCanSwitchUser

public void setCanSwitchUser(boolean canSwitchUser)

Sets whether switching users is allowed or not; controls the return value of UserManager.canSwitchUsers()

getSeedAccountType

@Implementation(minSdk=10000)
protected String getSeedAccountType()

setSeedAccountType

public void setSeedAccountType(String seedAccountType)

Setter for UserManager.getSeedAccountType()

removeUser

@Implementation(minSdk=17)
protected boolean removeUser(int userHandle)

removeUser

@Implementation(minSdk=10000)
protected boolean removeUser(UserHandle user)

supportsMultipleUsers

@Implementation(minSdk=24)
protected static boolean supportsMultipleUsers()

setSupportsMultipleUsers

public void setSupportsMultipleUsers(boolean isMultiUserSupported)

Sets whether multiple users are supported; controls the return value of UserManager#supportsMultipleUser.

switchUser

public void switchUser(int userId)

Switches the current user to userHandle.

Parameters:

userId - the integer handle of the user, where 0 is the primary user.

addUser

public UserHandle addUser(int id,
                          String name,
                          int flags)

Creates a user with the specified name, userId and flags.

Parameters:

id - the unique id of user

name - name of the user

flags - 16 bits for user type. See UserInfo.flags

Returns:

a handle to the new user

reset

@Resetter
public static void reset()