Join us for ⁠#Android11: The Beta Launch Show on June 3!
Added in API level 17

UserHandle

class UserHandle : Parcelable
kotlin.Any
   ↳ android.os.UserHandle

Representation of a user on the device.

Summary

Inherited constants

Public constructors

<init>(in: Parcel!)

Instantiate a new UserHandle from the data in a Parcel that was previously written with writeToParcel(android.os.Parcel,int).

Public methods

Int

Boolean
equals(other: Any?)

static UserHandle!

Returns the user for a given uid.

Int

static UserHandle!

Read a UserHandle from a Parcel that was previously written with writeToParcel(android.os.UserHandle,android.os.Parcel), returning either a null or new object as appropriate.

String

Unit
writeToParcel(out: Parcel!, flags: Int)

static Unit

Write a UserHandle to a Parcel, handling null pointers.

Properties

static Parcelable.Creator<UserHandle!>

Public constructors

<init>

Added in API level 17
UserHandle(in: Parcel!)

Instantiate a new UserHandle from the data in a Parcel that was previously written with writeToParcel(android.os.Parcel,int). Note that you must not use this with data written by writeToParcel(android.os.UserHandle,android.os.Parcel) since it is not possible to handle a null UserHandle here.

Parameters
in Parcel!: The Parcel containing the previously written UserHandle, positioned at the location in the buffer where it was written.

Public methods

describeContents

Added in API level 17
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

equals

Added in API level 17
fun equals(other: Any?): Boolean
Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getUserHandleForUid

Added in API level 24
static fun getUserHandleForUid(uid: Int): UserHandle!

Returns the user for a given uid.

Parameters
uid Int: A uid for an application running in a particular user.
Return
UserHandle! A UserHandle for that user.

hashCode

Added in API level 17
fun hashCode(): Int
Return
Int a hash code value for this object.

readFromParcel

Added in API level 17
static fun readFromParcel(in: Parcel!): UserHandle!

Read a UserHandle from a Parcel that was previously written with writeToParcel(android.os.UserHandle,android.os.Parcel), returning either a null or new object as appropriate.

Parameters
in Parcel!: The Parcel from which to read the UserHandle
Return
UserHandle! Returns a new UserHandle matching the previously written object, or null if a null had been written.

toString

Added in API level 17
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 17
fun writeToParcel(
    out: Parcel!,
    flags: Int
): Unit
Parameters
dest The Parcel in which the object should be written.
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

writeToParcel

Added in API level 17
static fun writeToParcel(
    h: UserHandle!,
    out: Parcel!
): Unit

Write a UserHandle to a Parcel, handling null pointers. Must be read with readFromParcel(android.os.Parcel).

Parameters
h UserHandle!: The UserHandle to be written.
out Parcel!: The Parcel in which the UserHandle will be placed.

Properties

CREATOR

Added in API level 17
static val CREATOR: Parcelable.Creator<UserHandle!>