CrossProfileApps

Kotlin |Java

public class CrossProfileApps
extends Object

java.lang.Object
↳	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

Public methods
`Drawable`	`getProfileSwitchingIconDrawable(UserHandle userHandle)` Return a drawable that calling app can show to user for the semantic of profile switching -- launching its own activity in specified user profile.
`CharSequence`	`getProfileSwitchingLabel(UserHandle userHandle)` Return a label that calling app can show to user for the semantic of profile switching -- launching its own activity in specified user profile.
`List<UserHandle>`	`getTargetUserProfiles()` Return a list of user profiles that that the caller can use when calling other APIs in this class.
`void`	`startMainActivity(ComponentName component, UserHandle targetUser)` Starts the specified main activity of the caller package in the specified profile.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public methods

getProfileSwitchingIconDrawable

Added in API level 28

public Drawable getProfileSwitchingIconDrawable (UserHandle userHandle)

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 must never be `null`.

Returns
`Drawable`	an icon that calling app can show user for the semantic of launching its own activity in specified user profile. This value will never be `null`.

See also:

startMainActivity(ComponentName, UserHandle)

getProfileSwitchingLabel

Added in API level 28

public CharSequence getProfileSwitchingLabel (UserHandle userHandle)

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 must never be `null`.

Returns
`CharSequence`	a label that calling app can show user for the semantic of launching its own activity in the specified user profile. This value will never be `null`.

See also:

startMainActivity(ComponentName, UserHandle)

getTargetUserProfiles

Added in API level 28

public List<UserHandle> getTargetUserProfiles ()

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

Returns
`List<UserHandle>`	This value will never be `null`.

See also:

UserManager.getUserProfiles()

startMainActivity

Added in API level 28

public void startMainActivity (ComponentName component, 
                UserHandle targetUser)

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 `Intent.ACTION_MAIN`, category `Intent.CATEGORY_LAUNCHER`. Otherwise, SecurityException will be thrown. This value must never 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 must never be `null`.