Added in API level 28

CrossProfileApps


open class CrossProfileApps
kotlin.Any
   ↳ android.content.pm.CrossProfileApps

Class for handling cross profile operations. Apps can use this class to interact with its instance in any profile that is in getTargetUserProfiles(). For example, app can use this class to start its main activity in managed profile.

Summary

Constants
static String

Broadcast signalling that the receiving app's permission to interact across profiles has changed.

Public methods
open Boolean

Returns whether the calling package can interact across profiles.

open Boolean

Returns whether the calling package can request to navigate the user to the relevant settings page to request user consent to interact across profiles.

open Intent

Returns an Intent to open the settings page that allows the user to decide whether the calling app can interact across profiles.

open Drawable

Return a drawable that calling app can show to user for the semantic of profile switching -- launching its own activity in specified user profile.

open CharSequence

Return a label that calling app can show to user for the semantic of profile switching -- launching its own activity in specified user profile.

open MutableList<UserHandle!>

Return a list of user profiles that that the caller can use when calling other APIs in this class.

open Boolean

Checks if the specified user is a managed profile.

open Boolean
isProfile(userHandle: UserHandle)

Checks if the specified user is a profile, i.

open Unit
startActivity(intent: Intent, targetUser: UserHandle, callingActivity: Activity?)

Starts the specified activity of the caller package in the specified profile.

open Unit
startActivity(intent: Intent, targetUser: UserHandle, callingActivity: Activity?, options: Bundle?)

Starts the specified activity of the caller package in the specified profile.

open Unit
startMainActivity(component: ComponentName, targetUser: UserHandle)

Starts the specified main activity of the caller package in the specified profile.

open Unit
startMainActivity(component: ComponentName, targetUser: UserHandle, callingActivity: Activity?, options: Bundle?)

Starts the specified main activity of the caller package in the specified profile, launching in the specified activity.

Constants

ACTION_CAN_INTERACT_ACROSS_PROFILES_CHANGED

Added in API level 30
static val ACTION_CAN_INTERACT_ACROSS_PROFILES_CHANGED: String

Broadcast signalling that the receiving app's permission to interact across profiles has changed. This includes the user, admin, or OEM changing their consent such that the permission for the app to interact across profiles has changed.

This broadcast is not sent when other circumstances result in a change to being able to interact across profiles in practice, such as the profile being turned off or removed, apps being uninstalled, etc. The methods canInteractAcrossProfiles() and canRequestInteractAcrossProfiles() can be used by apps prior to attempting to interact across profiles or attempting to request user consent to interact across profiles.

Apps that have set the android:crossProfile manifest attribute to true can receive this broadcast in manifest broadcast receivers. Otherwise, it can only be received by dynamically-registered broadcast receivers.

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

Public methods

canInteractAcrossProfiles

Added in API level 30
open fun canInteractAcrossProfiles(): Boolean

Returns whether the calling package can interact across profiles.

Specifically, returns whether the following are all true:

If false, the package's current ability to request user consent to interact across profiles can be checked with canRequestInteractAcrossProfiles(). If true, user consent can be obtained via createRequestInteractAcrossProfilesIntent(). The package can then listen to ACTION_CAN_INTERACT_ACROSS_PROFILES_CHANGED broadcasts.

Return
Boolean true if the calling package can interact across profiles.
Exceptions
java.lang.SecurityException if mContext.getPackageName() does not belong to the calling UID.

canRequestInteractAcrossProfiles

Added in API level 30
open fun canRequestInteractAcrossProfiles(): Boolean

Returns whether the calling package can request to navigate the user to the relevant settings page to request user consent to interact across profiles.

If true, the navigation intent can be obtained via createRequestInteractAcrossProfilesIntent(). The package can then listen to ACTION_CAN_INTERACT_ACROSS_PROFILES_CHANGED broadcasts.

Specifically, returns whether the following are all true:

  • UserManager#getProfileIdsExcludingHidden(int) returns at least one other profile for the calling user.
  • The calling app has requested android.Manifest.permission.INTERACT_ACROSS_PROFILES in its manifest.
  • The calling app is not a profile owner within the profile group of the calling user.

Note that in order for the user to be able to grant the consent, the requesting package must be allowlisted by the admin or the OEM and installed in the other profile. If this is not the case the user will be shown a message explaining why they can't grant the consent.

Note that user consent could already be granted if given a return value of true. The package's current ability to interact across profiles can be checked with canInteractAcrossProfiles().

Return
Boolean true if the calling package can request to interact across profiles.

createRequestInteractAcrossProfilesIntent

Added in API level 30
open fun createRequestInteractAcrossProfilesIntent(): Intent

Returns an Intent to open the settings page that allows the user to decide whether the calling app can interact across profiles.

The method canRequestInteractAcrossProfiles() must be returning true.

Note that the user may already have given consent and the app may already be able to interact across profiles, even if canRequestInteractAcrossProfiles() is true. The current ability to interact across profiles is given by canInteractAcrossProfiles().

Return
Intent an Intent to open the settings page that allows the user to decide whether the app can interact across profiles This value cannot be null.
Exceptions
java.lang.SecurityException if mContext.getPackageName() does not belong to the calling UID, or canRequestInteractAcrossProfiles() is false.

getProfileSwitchingIconDrawable

Added in API level 28
open fun getProfileSwitchingIconDrawable(userHandle: UserHandle): Drawable

Return a drawable that calling app can show to user for the semantic of profile switching -- launching its own activity in specified user profile. For example, it may return a briefcase icon if the given user handle is the managed profile one.

Parameters
userHandle UserHandle: The UserHandle of the target profile, must be one of the users returned by getTargetUserProfiles(), otherwise a SecurityException will be thrown. This value cannot be null.
Return
Drawable an icon that calling app can show user for the semantic of launching its own activity in specified user profile. This value cannot be null.

getProfileSwitchingLabel

Added in API level 28
open fun getProfileSwitchingLabel(userHandle: UserHandle): CharSequence

Return a label that calling app can show to user for the semantic of profile switching -- launching its own activity in specified user profile. For example, it may return "Switch to work" if the given user handle is the managed profile one.

Parameters
userHandle UserHandle: The UserHandle of the target profile, must be one of the users returned by getTargetUserProfiles(), otherwise a SecurityException will be thrown. This value cannot be null.
Return
CharSequence a label that calling app can show user for the semantic of launching its own activity in the specified user profile. This value cannot be null.

getTargetUserProfiles

Added in API level 28
open fun getTargetUserProfiles(): MutableList<UserHandle!>

Return a list of user profiles that that the caller can use when calling other APIs in this class.

A user profile would be considered as a valid target user profile, provided that:

  • It gets caller app installed
  • It is not equal to the calling user
  • It is in the same profile group of calling user profile
  • It is enabled
  • It is not hidden (ex. profile type UserManager#USER_TYPE_PROFILE_PRIVATE)
Return
MutableList<UserHandle!> This value cannot be null.

isManagedProfile

Added in API level 35
open fun isManagedProfile(userHandle: UserHandle): Boolean

Checks if the specified user is a managed profile.

Parameters
userHandle UserHandle: The UserHandle of the target profile, must be one of the users returned by getTargetUserProfiles(), otherwise a SecurityException will be thrown. This value cannot be null.
Return
Boolean whether the specified user is a managed profile.

isProfile

Added in API level 35
open fun isProfile(userHandle: UserHandle): Boolean

Checks if the specified user is a profile, i.e. not the parent user.

Parameters
userHandle UserHandle: The UserHandle of the target profile, must be one of the users returned by getTargetUserProfiles(), otherwise a SecurityException will be thrown. This value cannot be null.
Return
Boolean whether the specified user is a profile.

startActivity

Added in API level 30
open fun startActivity(
    intent: Intent,
    targetUser: UserHandle,
    callingActivity: Activity?
): Unit

Starts the specified activity of the caller package in the specified profile.

The caller must have the android.Manifest.permission#INTERACT_ACROSS_PROFILES, android.Manifest.permission#INTERACT_ACROSS_USERS, or android.Manifest.permission#INTERACT_ACROSS_USERS_FULL permission. Both the caller and target user profiles must be in the same profile group. The target user must be a valid user returned from getTargetUserProfiles().
Requires android.Manifest.permission#INTERACT_ACROSS_PROFILES or android.Manifest.permission.INTERACT_ACROSS_USERS

Parameters
intent Intent: The intent to launch. A component in the caller package must be specified. This value cannot be null.
targetUser UserHandle: The UserHandle of the profile; must be one of the users returned by getTargetUserProfiles() if different to the calling user, otherwise a SecurityException will be thrown. This value cannot be null.
callingActivity Activity?: The activity to start the new activity from for the purposes of passing back any result and deciding which task the new activity should belong to. If null, the activity will always be started in a new task and no result will be returned.

startActivity

Added in API level 30
open fun startActivity(
    intent: Intent,
    targetUser: UserHandle,
    callingActivity: Activity?,
    options: Bundle?
): Unit

Starts the specified activity of the caller package in the specified profile.

The caller must have the android.Manifest.permission#INTERACT_ACROSS_PROFILES, android.Manifest.permission#INTERACT_ACROSS_USERS, or android.Manifest.permission#INTERACT_ACROSS_USERS_FULL permission. Both the caller and target user profiles must be in the same profile group. The target user must be a valid user returned from getTargetUserProfiles().
Requires android.Manifest.permission#INTERACT_ACROSS_PROFILES or android.Manifest.permission.INTERACT_ACROSS_USERS

Parameters
intent Intent: The intent to launch. A component in the caller package must be specified. This value cannot be null.
targetUser UserHandle: The UserHandle of the profile; must be one of the users returned by getTargetUserProfiles() if different to the calling user, otherwise a SecurityException will be thrown. This value cannot be null.
callingActivity Activity?: The activity to start the new activity from for the purposes of passing back any result and deciding which task the new activity should belong to. If null, the activity will always be started in a new task and no result will be returned.
options Bundle?: The activity options or null. See android.app.ActivityOptions.

startMainActivity

Added in API level 28
open fun startMainActivity(
    component: ComponentName,
    targetUser: UserHandle
): Unit

Starts the specified main activity of the caller package in the specified profile.

Parameters
component ComponentName: The ComponentName of the activity to launch, it must be exported and has action android.content.Intent#ACTION_MAIN, category android.content.Intent#CATEGORY_LAUNCHER. Otherwise, SecurityException will be thrown. This value cannot be null.
targetUser UserHandle: The UserHandle of the profile, must be one of the users returned by getTargetUserProfiles(), otherwise a SecurityException will be thrown. This value cannot be null.

startMainActivity

Added in API level 33
open fun startMainActivity(
    component: ComponentName,
    targetUser: UserHandle,
    callingActivity: Activity?,
    options: Bundle?
): Unit

Starts the specified main activity of the caller package in the specified profile, launching in the specified activity.

Parameters
component ComponentName: The ComponentName of the activity to launch, it must be exported and has action android.content.Intent#ACTION_MAIN, category android.content.Intent#CATEGORY_LAUNCHER. Otherwise, SecurityException will be thrown. This value cannot be null.
targetUser UserHandle: The UserHandle of the profile, must be one of the users returned by getTargetUserProfiles(), otherwise a SecurityException will be thrown. This value cannot be null.
callingActivity Activity?: The activity to start the new activity from for the purposes of deciding which task the new activity should belong to. If null, the activity will always be started in a new task.
options Bundle?: The activity options or null. See android.app.ActivityOptions.