LauncherUserInfo

Kotlin |Java

class LauncherUserInfo : Parcelable

kotlin.Any
↳	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
static String	`PRIVATE_SPACE_ENTRYPOINT_HIDDEN` A boolean extra indicating whether the private space entrypoint should be hidden when locked.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
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`.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<LauncherUserInfo!>	`CREATOR`

Constants

PRIVATE_SPACE_ENTRYPOINT_HIDDEN

Added in API level 36

static val PRIVATE_SPACE_ENTRYPOINT_HIDDEN: String

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

Value: "private_space_entrypoint_hidden"

See Also

#getUserConfig

Public methods

describeContents

Added in API level 35

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getUserConfig

Added in API level 36

fun getUserConfig(): Bundle

Returns additional configs for this launcher user

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

See Also

#PRIVATE_SPACE_ENTRYPOINT_HIDDEN

getUserSerialNumber

Added in API level 35

fun getUserSerialNumber(): Int

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

Return
`Int`	the serial number associated with the user

getUserType

Added in API level 35

fun getUserType(): String

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

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

writeToParcel

Added in API level 35

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 35

static val CREATOR: Parcelable.Creator<LauncherUserInfo!>