Class ShadowUserManager
UserManager
.-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Describes the current state of the user. -
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The default user ID user for secondary user testing, when the ID is not otherwise specified.static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
__constructor__
(Context context, IUserManager service) void
addProfile
(int userHandle, int profileUserHandle, UserInfo profileUserInfo) Add a profile to be returned bygetProfiles(int)
.void
addProfile
(int userHandle, int profileUserHandle, String profileName, int profileFlags) Add a profile to be returned bygetProfiles(int)
.Creates a user with the specified name, userId and flags.long
addUserProfile
(UserHandle userHandle) Deprecated.use either addUser() or addProfile()protected boolean
Returnstrue
by default, or the value specified viasetCanSwitchUser(boolean)
.protected void
void
clearUserRestrictions
(UserHandle userHandle) Removes all user restrictions set of a user identified byuserHandle
.protected UserHandle
createProfile
(String name, String userType, Set<String> disallowedPackages) void
enforcePermissionChecks
(boolean enforcePermissions) protected List<UserHandle>
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<UserHandle>
protected static int
protected UserInfo
getProfileParent
(int userId) getProfiles
(int userHandle) If any profiles have been added usingaddProfile(int, int, java.lang.String, int)
, return those profiles.protected String
protected PersistableBundle
protected String
protected long
getSerialNumberForUser
(UserHandle userHandle) protected long[]
getSerialNumbersOfUsers
(boolean excludeDying) protected UserHandle
getUserForSerialNumber
(long serialNumber) protected int
getUserHandle
(int serialNumber) protected List<UserHandle>
getUserHandles
(boolean excludeDying) protected Bitmap
protected UserInfo
getUserInfo
(int userHandle) protected String
Returns the name of the user.protected List<UserHandle>
protected Bundle
protected Bundle
getUserRestrictions
(UserHandle userHandle) getUsers()
protected int
getUserSerialNumber
(int userHandle) protected int
protected boolean
hasUserRestriction
(String restrictionKey, UserHandle userHandle) protected boolean
hasUserRestrictionForUser
(String restrictionKey, int userId) protected boolean
hasUserRestrictionForUser
(String restrictionKey, UserHandle userHandle) protected boolean
If permissions are enforced (seeenforcePermissionChecks(boolean)
) and the application doesn't have theManifest.permission.MANAGE_USERS
permission, throws aSecurityManager
exception.protected boolean
protected static boolean
protected boolean
protected boolean
If permissions are enforced (seeenforcePermissionChecks(boolean)
) and the application doesn't have theManifest.permission.MANAGE_USERS
permission, throws aSecurityManager
exception.protected boolean
isManagedProfile
(int userHandle) If permissions are enforced (seeenforcePermissionChecks(boolean)
) and the application doesn't have theManifest.permission.MANAGE_USERS
permission, throws aSecurityManager
exception.protected boolean
protected boolean
isQuietModeEnabled
(UserHandle userHandle) Query whether the quiet mode is enabled for a managed profile.protected boolean
Returns 'false' by default, or the value specified viasetIsRestrictedProfile(boolean)
.protected boolean
isSameProfileGroup
(UserHandle user, UserHandle otherUser) protected boolean
protected boolean
protected boolean
isUserOfType
(String userType) protected boolean
isUserRunning
(UserHandle handle) protected boolean
isUserRunningOrStopping
(UserHandle handle) protected boolean
protected boolean
isUserUnlocked
(UserHandle handle) protected boolean
isUserUnlockingOrUnlocked
(UserHandle handle) void
removeSomeUserHasAccount
(String accountName, String accountType) Removes user account set viasetSomeUserHasAccount(String, String)
.protected boolean
removeUser
(int userHandle) protected boolean
removeUser
(UserHandle user) protected int
removeUserWhenPossible
(UserHandle user, boolean overrideDevicePolicy) protected boolean
requestQuietModeEnabled
(boolean enableQuietMode, UserHandle userHandle) Request the quiet mode.protected boolean
requestQuietModeEnabled
(boolean enableQuietMode, UserHandle userHandle, int flags) 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 byUserManager.getApplicationRestrictions(String)
.void
setCanSwitchUser
(boolean canSwitchUser) Deprecated.usesetUserSwitchability(int)
insteadvoid
setCloneProfile
(boolean cloneProfile) Setter forUserManager.isCloneProfile()
.static void
setHeadlessSystemUserMode
(boolean isEnabled) Updates headless system user mode.void
setIsDemoUser
(boolean isDemoUser) Deprecated.UseaddUser(int, String, int)
to create a demo user instead of changing default user flags.void
setIsGuestUser
(boolean isGuestUser) Deprecated.UseaddUser(int, String, int)
to create a guest user instead of changing default user flags.void
setIsLinkedUser
(boolean isLinkedUser) Deprecated.UseaddUser(int, String, int)
to create a linked user instead of changing default user flags.void
setIsPrimaryUser
(boolean isPrimaryUser) Deprecated.UseaddUser(int, String, int)
to create a primary user instead of changing default user flags.void
setIsRestrictedProfile
(boolean isRestrictedProfile) Deprecated.useShadowUserManager#addUser()
insteadvoid
setIsSystemUser
(boolean isSystemUser) Deprecated.UseaddUser(int, String, int)
to create a system user instead of changing default user flags.void
setIsUserEnabled
(int userId, boolean enabled) void
setManagedProfile
(boolean managedProfile) Setter forUserManager.isManagedProfile()
.void
setMaxSupportedUsers
(int maxSupportedUsers) void
setProfileIsLocked
(UserHandle profileHandle, boolean isLocked) void
setSeedAccountName
(String seedAccountName) Setter forUserManager.getSeedAccountName()
void
setSeedAccountOptions
(PersistableBundle seedAccountOptions) Setter forUserManager.getSeedAccountOptions()
void
setSeedAccountType
(String seedAccountType) Setter forUserManager.getSeedAccountType()
void
setSerialNumberForUser
(UserHandle userHandle, long serialNumber) addUser(int, java.lang.String, int)
uses UserHandle for serialNumber.void
setSomeUserHasAccount
(String accountName, String accountType) Setter forUserManager.someUserHasAccount(String, String)
.void
setSupportsMultipleUsers
(boolean isMultiUserSupported) Sets whether multiple users are supported; controls the return value ofUserManager#supportsMultipleUser
.void
setUserForeground
(boolean foreground) Sets whether or not the current user is the foreground user.protected void
setUserIcon
(Bitmap icon) protected void
setUserName
(String name) void
setUserRestriction
(UserHandle userHandle, String restrictionKey, boolean value) Deprecated.When possible, please use the real Android framework APIUserManager#setUserRestriction()
.protected void
setUserRestriction
(String key, boolean value) protected void
setUserRestriction
(String key, boolean value, UserHandle userHandle) Shadows UserManager.setUserRestriction() API.void
setUserState
(UserHandle handle, ShadowUserManager.UserState state) Sets the current state for a given user, seeUserManager.isUserRunning(UserHandle)
andUserManager.isUserRunningOrStopping(UserHandle)
void
setUserSwitchability
(int switchability) Sets the user switchability for all users.void
setUserUnlocked
(boolean userUnlocked) Setter forUserManager.isUserUnlocked()
protected boolean
someUserHasAccount
(String accountName, String accountType) protected static boolean
void
switchUser
(int userId) Switches the current user touserHandle
.
-
Field Details
-
DEFAULT_SECONDARY_USER_ID
public static final int DEFAULT_SECONDARY_USER_IDThe default user ID user for secondary user testing, when the ID is not otherwise specified.- See Also:
-
FLAG_PRIMARY
public static final int FLAG_PRIMARY- See Also:
-
FLAG_ADMIN
public static final int FLAG_ADMIN- See Also:
-
FLAG_GUEST
public static final int FLAG_GUEST- See Also:
-
FLAG_RESTRICTED
public static final int FLAG_RESTRICTED- See Also:
-
FLAG_DEMO
public static final int FLAG_DEMO- See Also:
-
FLAG_MANAGED_PROFILE
public static final int FLAG_MANAGED_PROFILE- See Also:
-
FLAG_PROFILE
public static final int FLAG_PROFILE- See Also:
-
FLAG_FULL
public static final int FLAG_FULL- See Also:
-
FLAG_SYSTEM
public static final int FLAG_SYSTEM- See Also:
-
-
Constructor Details
-
ShadowUserManager
public ShadowUserManager()
-
-
Method Details
-
__constructor__
-
getApplicationRestrictions
Compared to real Android, there is no check that the package name matches the application package name and the method returns instantly. -
setApplicationRestrictions
Sets the value returned byUserManager.getApplicationRestrictions(String)
. -
addUserProfile
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
-
getProfiles
If any profiles have been added usingaddProfile(int, int, java.lang.String, int)
, return those profiles.Otherwise follow real android behaviour.
-
getEnabledProfiles
-
getAllProfiles
-
getProfileParent
-
createProfile
@Implementation(minSdk=30) protected UserHandle createProfile(String name, String userType, Set<String> disallowedPackages) -
addProfile
Add a profile to be returned bygetProfiles(int)
. -
addProfile
Add a profile to be returned bygetProfiles(int)
. -
setUserUnlocked
public void setUserUnlocked(boolean userUnlocked) Setter forUserManager.isUserUnlocked()
-
isUserUnlocked
-
isUserUnlocked
- See Also:
-
isManagedProfile
If permissions are enforced (seeenforcePermissionChecks(boolean)
) and the application doesn't have theManifest.permission.MANAGE_USERS
permission, throws aSecurityManager
exception.- Returns:
- false by default, or the value specified via
setManagedProfile(boolean)
- See Also:
-
isManagedProfile
If permissions are enforced (seeenforcePermissionChecks(boolean)
) and the application doesn't have theManifest.permission.MANAGE_USERS
permission, throws aSecurityManager
exception.- Returns:
- true if the profile added has FLAG_MANAGED_PROFILE
- See Also:
-
enforcePermissionChecks
public void enforcePermissionChecks(boolean enforcePermissions) -
setManagedProfile
public void setManagedProfile(boolean managedProfile) Setter forUserManager.isManagedProfile()
. -
isCloneProfile
If permissions are enforced (seeenforcePermissionChecks(boolean)
) and the application doesn't have theManifest.permission.MANAGE_USERS
permission, throws aSecurityManager
exception.- Returns:
- true if the user is clone, or the value specified via
setCloneProfile(boolean)
- See Also:
-
setCloneProfile
public void setCloneProfile(boolean cloneProfile) Setter forUserManager.isCloneProfile()
. -
isProfile
-
isUserOfType
-
isSameProfileGroup
@Implementation(minSdk=30) protected boolean isSameProfileGroup(UserHandle user, UserHandle otherUser) -
hasUserRestriction
@Implementation(minSdk=21) protected boolean hasUserRestriction(String restrictionKey, UserHandle userHandle) -
setUserRestriction
@Implementation(minSdk=18) protected void setUserRestriction(String key, boolean value, UserHandle userHandle) Shadows UserManager.setUserRestriction() API. This allows UserManager.hasUserRestriction() to return meaningful results in test environment; thus, allowing test to verify the invoking of UserManager.setUserRestriction(). -
setUserRestriction
-
setUserRestriction
@Deprecated public void setUserRestriction(UserHandle userHandle, String restrictionKey, boolean value) Deprecated.When possible, please use the real Android framework APIUserManager#setUserRestriction()
. -
clearUserRestrictions
Removes all user restrictions set of a user identified byuserHandle
. -
getUserRestrictions
-
getSerialNumberForUser
-
setSerialNumberForUser
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
-
getUserSerialNumber
-
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.
-
setUserName
-
getUserIcon
-
setUserIcon
-
getUserHandle
- Returns:
- user id for given user serial number.
-
getUserHandles
@HiddenApi @Implementation(minSdk=30) protected List<UserHandle> getUserHandles(boolean excludeDying) -
getMaxSupportedUsers
-
setMaxSupportedUsers
public void setMaxSupportedUsers(int maxSupportedUsers) -
isDemoUser
- Returns:
- false by default, or the value specified via
setIsDemoUser(boolean)
-
setIsDemoUser
Deprecated.UseaddUser(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 ofUserManager.isDemoUser()
. -
isSystemUser
- Returns:
- 'true' by default, or the value specified via
setIsSystemUser(boolean)
-
setIsSystemUser
Deprecated.UseaddUser(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 ofUserManager.isSystemUser()
. -
setIsPrimaryUser
Deprecated.UseaddUser(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 ofUserManager.isPrimaryUser()
. -
isLinkedUser
- Returns:
- 'false' by default, or the value specified via
setIsLinkedUser(boolean)
-
setIsLinkedUser
Deprecated.UseaddUser(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 ofUserManager.isLinkedUser()
. -
isRestrictedProfile
Returns 'false' by default, or the value specified viasetIsRestrictedProfile(boolean)
. -
setIsRestrictedProfile
Deprecated.useShadowUserManager#addUser()
insteadSets this process running under a restricted profile; controls the return value ofUserManager.isRestrictedProfile()
. -
setIsGuestUser
Deprecated.UseaddUser(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 ofUserManager.isGuestUser()
. -
setIsUserEnabled
public void setIsUserEnabled(int userId, boolean enabled) -
isUserRunning
- See Also:
-
isUserRunningOrStopping
- See Also:
-
isUserUnlockingOrUnlocked
- See Also:
-
setUserState
Sets the current state for a given user, seeUserManager.isUserRunning(UserHandle)
andUserManager.isUserRunningOrStopping(UserHandle)
-
isQuietModeEnabled
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 withtrue
for the managed profile, in which case it will always fail. -
sendQuietModeBroadcast
If the current application has the necessary rights, it will receive the background action too. -
setProfileIsLocked
-
getSerialNumbersOfUsers
-
getUsers
-
getUserInfo
-
setCanSwitchUser
Deprecated.usesetUserSwitchability(int)
insteadSets whether switching users is allowed or not; controls the return value ofUserManager#canSwitchUser()
-
getSeedAccountName
-
setSeedAccountName
Setter forUserManager.getSeedAccountName()
-
getSeedAccountType
-
setSeedAccountType
Setter forUserManager.getSeedAccountType()
-
getSeedAccountOptions
-
setSeedAccountOptions
Setter forUserManager.getSeedAccountOptions()
-
clearSeedAccountData
-
removeUser
-
removeUser
-
removeUserWhenPossible
@Implementation(minSdk=33) protected int removeUserWhenPossible(UserHandle user, boolean overrideDevicePolicy) -
supportsMultipleUsers
-
setSupportsMultipleUsers
public void setSupportsMultipleUsers(boolean isMultiUserSupported) Sets whether multiple users are supported; controls the return value ofUserManager#supportsMultipleUser
. -
switchUser
public void switchUser(int userId) Switches the current user touserHandle
.- Parameters:
userId
- the integer handle of the user, where 0 is the primary user.
-
addUser
Creates a user with the specified name, userId and flags.- Parameters:
id
- the unique id of username
- name of the userflags
- 16 bits for user type. SeeUserInfo.flags
- Returns:
- a handle to the new user
-
canSwitchUsers
Returnstrue
by default, or the value specified viasetCanSwitchUser(boolean)
. -
getUserSwitchability
-
setUserSwitchability
public void setUserSwitchability(int switchability) Sets the user switchability for all users. -
hasUserRestrictionForUser
@Implementation(minSdk=30) protected boolean hasUserRestrictionForUser(String restrictionKey, UserHandle userHandle) -
requestQuietModeEnabled
@Implementation(minSdk=30) protected boolean requestQuietModeEnabled(boolean enableQuietMode, UserHandle userHandle, int flags) Request the quiet mode.If
setProfileIsLocked(UserHandle, boolean)
is called withtrue
for the managed profile a request to disable the quiet mode will fail and returnfalse
(i.e. as if the user refused to authenticate). Otherwise, the call will always succeed and returntrue
.This method simply re-directs to
requestQuietModeEnabled(boolean, UserHandle)
as it already has the desired behavior irrespective of the flag's value. -
isHeadlessSystemUserMode
-
setHeadlessSystemUserMode
public static void setHeadlessSystemUserMode(boolean isEnabled) Updates headless system user mode. -
getUserRestrictions
-
hasUserRestrictionForUser
@Implementation(minSdk=33) protected boolean hasUserRestrictionForUser(String restrictionKey, int userId) -
reset
-
someUserHasAccount
@Implementation(minSdk=33) protected boolean someUserHasAccount(String accountName, String accountType) -
setSomeUserHasAccount
Setter forUserManager.someUserHasAccount(String, String)
. -
removeSomeUserHasAccount
Removes user account set viasetSomeUserHasAccount(String, String)
. -
setUserForeground
public void setUserForeground(boolean foreground) Sets whether or not the current user is the foreground user. -
isUserForeground
-