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 Description

static class ShadowUserManager.UserState
Describes the current state of the user.

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

Field Summary

Fields
Modifier and Type	Field	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_DEMO`
`static int`	`FLAG_GUEST`
`static int`	`FLAG_MANAGED_PROFILE`
`static int`	`FLAG_PRIMARY`
`static int`	`FLAG_RESTRICTED`
`protected Map<Integer,UserInfo>`	`userInfoMap`	Holds the UserInfo for all registered users and profiles, indexed by UserHandle.id
`protected static Map<Integer,Integer>`	`userPidMap`
`protected Map<Integer,List<UserHandle>>`	`userProfilesListMap`	Each user holds a list of UserHandles of assocated profiles and user itself.
`protected com.google.common.collect.BiMap<Integer,Long>`	`userSerialNumbers`	Holds the serial numbers for all users and profiles, indexed by UserHandle.id
`protected Map<Integer,ShadowUserManager.UserState>`	`userState`	Holds all UserStates, indexed by UserHandle.id

Constructor Summary

Constructors
Constructor Description

ShadowUserManager()

Constructors
Constructor	Description
`ShadowUserManager()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	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)`	Deprecated. use either addUser() or addProfile()
`protected boolean`	`canSwitchUsers()`	Returns `true` 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 UserInfo`	`getProfileParent(int userId)`
`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 int`	`getUserHandle(int serialNumber)`
`protected UserInfo`	`getUserInfo(int userHandle)`
`protected String`	`getUserName()`	Returns the name of the user.
`protected List<UserHandle>`	`getUserProfiles()`
`protected Bundle`	`getUserRestrictions(UserHandle userHandle)`
`protected List<UserInfo>`	`getUsers()`
`protected int`	`getUserSerialNumber(int userHandle)`
`protected int`	`getUserSwitchability()`
`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.
`protected boolean`	`isManagedProfile(int userHandle)`	If permissions are enforced (see `enforcePermissionChecks(boolean)`) and the application doesn't have the `Manifest.permission.MANAGE_USERS` permission, throws a `SecurityManager` exception.
`protected boolean`	`isQuietModeEnabled(UserHandle userHandle)`	Query whether the quiet mode is enabled for a managed profile.
`protected 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`	`isUserUnlocked(UserHandle handle)`
`protected boolean`	`removeUser(int userHandle)`
`protected boolean`	`removeUser(UserHandle user)`
`protected boolean`	`requestQuietModeEnabled(boolean enableQuietMode, UserHandle userHandle)`	Request the quiet mode.
`static void`	`reset()`
`protected void`	`sendQuietModeBroadcast(String action, UserHandle profileHandle)`	If the current application has the necessary rights, it will receive the background action too.
`void`	`setApplicationRestrictions(String packageName, Bundle restrictions)`	Sets the value returned by `UserManager.getApplicationRestrictions(String)`.
`void`	`setCanSwitchUser(boolean canSwitchUser)`	Deprecated. use `setUserSwitchability(int)` instead
`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`	`setProfileIsLocked(UserHandle profileHandle, boolean isLocked)`
`void`	`setSeedAccountType(String seedAccountType)`	Setter for `UserManager.getSeedAccountType()`
`void`	`setSerialNumberForUser(UserHandle userHandle, long serialNumber)`	`addUser(int, java.lang.String, int)` uses UserHandle for serialNumber.
`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`	`setUserSwitchability(int switchability)`	Sets the user switchability for all users.
`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
  - FLAG_DEMO
```
public static final int FLAG_DEMO
```
    See Also:
    
    Constant Field Values
  - FLAG_MANAGED_PROFILE
```
public static final int FLAG_MANAGED_PROFILE
```
    See Also:
    
    Constant Field Values
  - userPidMap
```
protected static Map<Integer,Integer> userPidMap
```
  - userSerialNumbers
```
protected com.google.common.collect.BiMap<Integer,Long> userSerialNumbers
```
    Holds the serial numbers for all users and profiles, indexed by UserHandle.id
  - userState
```
protected Map<Integer,ShadowUserManager.UserState> userState
```
    Holds all UserStates, indexed by UserHandle.id
  - userInfoMap
```
protected Map<Integer,UserInfo> userInfoMap
```
    Holds the UserInfo for all registered users and profiles, indexed by UserHandle.id
  - userProfilesListMap
```
protected Map<Integer,List<UserHandle>> userProfilesListMap
```
    Each user holds a list of UserHandles of assocated profiles and user itself. User is indexed by UserHandle.id. See UserManager.getProfiles(userId).
- 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
```
@Deprecated
public long addUserProfile(UserHandle userHandle)
```
    Deprecated. use either addUser() or addProfile()
    
    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.
  - getProfileParent
```
@Implementation(minSdk=21)
protected UserInfo getProfileParent(int userId)
```
  - addProfile
```
public void addProfile(int userHandle,
                       int profileUserHandle,
                       String profileName,
                       int profileFlags)
```
    Add a profile to be returned by getProfiles(int).
  - setUserUnlocked
```
public void setUserUnlocked(boolean userUnlocked)
```
    Setter for UserManager.isUserUnlocked()
  - isUserUnlocked
```
@Implementation(minSdk=24)
protected boolean isUserUnlocked()
```
  - isUserUnlocked
```
@Implementation(minSdk=24)
protected boolean isUserUnlocked(UserHandle handle)
```
    See Also:
    
    setUserState(UserHandle, UserState)
  - 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)
  - isManagedProfile
```
@Implementation(minSdk=24)
protected boolean isManagedProfile(int userHandle)
```
    If permissions are enforced (see enforcePermissionChecks(boolean)) and the application doesn't have the Manifest.permission.MANAGE_USERS permission, throws a SecurityManager exception.
    
    Returns:
    
    true if the profile added has FLAG_MANAGED_PROFILE
    
    See Also:
    
    enforcePermissionChecks(boolean), addProfile(int, int, String, int), addUser(int, String, int)
  - 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:
    
    addProfile(int, int, String, int), addUser(int, String, int)
  - setSerialNumberForUser
```
public void setSerialNumberForUser(UserHandle userHandle,
                                   long serialNumber)
```
    addUser(int, java.lang.String, int) uses UserHandle for serialNumber. setSerialNumberForUser() allows assigning an arbitary serialNumber. Some test use serialNumber!=0 as secondary user check, so it's necessary to "fake" the serialNumber to a non-zero value.
  - getUserForSerialNumber
```
@Implementation
protected UserHandle getUserForSerialNumber(long serialNumber)
```
    See Also:
    
    addProfile(int, int, String, int), addUser(int, String, int)
  - getUserSerialNumber
```
@Implementation
protected int getUserSerialNumber(int userHandle)
```
    See Also:
    
    addProfile(int, int, String, int), addUser(int, String, int)
  - getUserName
```
@Implementation(minSdk=29)
protected String getUserName()
```
    Returns the name of the user. On real Android, if a UserHandle.USER_SYSTEM user is found but does not have a name, it will return a name like "Owner". In Robolectric, the USER_SYSTEM user always has a name.
  - getUserHandle
```
@HiddenApi
@Implementation(minSdk=17)
protected int getUserHandle(int serialNumber)
```
    Returns:
    
    user id for given user serial number.
  - 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
```
@Implementation(minSdk=28)
protected 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)
  - isQuietModeEnabled
```
@Implementation(minSdk=26)
protected boolean isQuietModeEnabled(UserHandle userHandle)
```
    Query whether the quiet mode is enabled for a managed profile.
    This method checks whether the user handle corresponds to a managed profile, and then query its state. When quiet, the user is not running.
  - requestQuietModeEnabled
```
@Implementation(minSdk=29)
protected boolean requestQuietModeEnabled(boolean enableQuietMode,
                                          UserHandle userHandle)
```
    Request the quiet mode. This will succeed unless setProfileIsLocked(UserHandle, boolean) is called with true for the managed profile, in which case it will always fail.
  - sendQuietModeBroadcast
```
protected void sendQuietModeBroadcast(String action,
                                      UserHandle profileHandle)
```
    If the current application has the necessary rights, it will receive the background action too.
  - setProfileIsLocked
```
public void setProfileIsLocked(UserHandle profileHandle,
                               boolean isLocked)
```
  - getUsers
```
@Implementation
protected List<UserInfo> getUsers()
```
  - getUserInfo
```
@Implementation
protected UserInfo getUserInfo(int userHandle)
```
  - setCanSwitchUser
```
@Deprecated
public void setCanSwitchUser(boolean canSwitchUser)
```
    Deprecated. use setUserSwitchability(int) instead
    
    Sets whether switching users is allowed or not; controls the return value of UserManager#canSwitchUser()
  - getSeedAccountType
```
@Implementation(minSdk=29)
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=29)
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
  - canSwitchUsers
```
@Implementation(minSdk=24,
                maxSdk=29)
protected boolean canSwitchUsers()
```
    Returns true by default, or the value specified via setCanSwitchUser(boolean).
  - getUserSwitchability
```
@Implementation(minSdk=29)
protected int getUserSwitchability()
```
  - setUserSwitchability
```
public void setUserSwitchability(int switchability)
```
    Sets the user switchability for all users.
  - reset
```
@Resetter
public static void reset()
```

Class ShadowUserManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SECONDARY_USER_ID

FLAG_PRIMARY

FLAG_ADMIN

FLAG_GUEST

FLAG_RESTRICTED

FLAG_DEMO

FLAG_MANAGED_PROFILE

userPidMap

userSerialNumbers

userState

userInfoMap

userProfilesListMap

Constructor Detail

ShadowUserManager

Method Detail

__constructor__

getApplicationRestrictions

setApplicationRestrictions

addUserProfile

getUserProfiles

getProfiles

getProfileParent

addProfile

setUserUnlocked

isUserUnlocked

isUserUnlocked

isManagedProfile

isManagedProfile

enforcePermissionChecks

setManagedProfile

hasUserRestriction

setUserRestriction

clearUserRestrictions

getUserRestrictions

getSerialNumberForUser

setSerialNumberForUser

getUserForSerialNumber

getUserSerialNumber

getUserName

getUserHandle

isDemoUser

setIsDemoUser

isSystemUser

setIsSystemUser

setIsPrimaryUser

isLinkedUser

setIsLinkedUser

isRestrictedProfile

setIsRestrictedProfile

setIsGuestUser

isUserRunning

isUserRunningOrStopping

setUserState

isQuietModeEnabled

requestQuietModeEnabled

sendQuietModeBroadcast

setProfileIsLocked

getUsers

getUserInfo

setCanSwitchUser

getSeedAccountType

setSeedAccountType

removeUser

removeUser

supportsMultipleUsers

setSupportsMultipleUsers

switchUser

addUser

canSwitchUsers

getUserSwitchability

setUserSwitchability

reset

constructor