Added in API level 35

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

LauncherUserInfo

Kotlin |Java

public final class LauncherUserInfo
extends Object implements Parcelable

java.lang.Object
↳	android.content.pm.LauncherUserInfo

The LauncherUserInfo object holds information about an Android user that is required to display the Launcher related UI elements specific to the user (like badges).

Summary

Constants
`String`	`PRIVATE_SPACE_ENTRYPOINT_HIDDEN` A boolean extra indicating whether the private space entrypoint should be hidden when locked.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<LauncherUserInfo>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`Bundle`	`getUserConfig()` Returns additional configs for this launcher user
`int`	`getUserSerialNumber()` Returns serial number of user as returned by `UserManager.getSerialNumberForUser(UserHandle)`
`String`	`getUserType()` Returns type of the user as defined in `UserManager`.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

PRIVATE_SPACE_ENTRYPOINT_HIDDEN

Added in API level 36

public static final String PRIVATE_SPACE_ENTRYPOINT_HIDDEN

A boolean extra indicating whether the private space entrypoint should be hidden when locked.

See also:

getUserConfig()

Constant Value: "private_space_entrypoint_hidden"

Fields

CREATOR

Added in API level 35

public static final Creator<LauncherUserInfo> CREATOR

Public methods

describeContents

Added in API level 35

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getUserConfig

Added in API level 36

public Bundle getUserConfig ()

Returns additional configs for this launcher user

Returns
`Bundle`	This value cannot be `null`.

See also:

PRIVATE_SPACE_ENTRYPOINT_HIDDEN

getUserSerialNumber

Added in API level 35

public int getUserSerialNumber ()

Returns serial number of user as returned by UserManager.getSerialNumberForUser(UserHandle)

Returns
`int`	the serial number associated with the user

getUserType

Added in API level 35

public String getUserType ()

Returns type of the user as defined in UserManager. e.g., ERROR(/UserManager.USER_TYPE_PROFILE_MANAGED) or ERROR(/UserManager.USER_TYPE_PROFILE_ClONE) or ERROR(/UserManager.USER_TYPE_PROFILE_PRIVATE)

Returns
`String`	the userType for the user whose LauncherUserInfo this is This value cannot be `null`.

writeToParcel

Added in API level 35

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES