UserHandle

Kotlin |Java

class UserHandle : Parcelable

kotlin.Any
↳	android.os.UserHandle

Representation of a user on the device.

Summary

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 constructors
`UserHandle(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	`describeContents()`
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
static UserHandle!	`getUserHandleForUid(uid: Int)` Returns the user for a given uid.
Int	`hashCode()`
static UserHandle!	`readFromParcel(in: Parcel!)` 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	`toString()`
Unit	`writeToParcel(out: Parcel, flags: Int)`
static Unit	`writeToParcel(h: UserHandle!, out: Parcel!)` Write a UserHandle to a Parcel, handling null pointers.

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

Public constructors

UserHandle

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

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`obj`	This value may be `null`.

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.

See Also

#writeToParcel(UserHandle, Parcel)

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. 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

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.

See Also

#readFromParcel(Parcel)

Properties

CREATOR

Added in API level 17

static val CREATOR: Parcelable.Creator<UserHandle!>