UserProperties | Android Developers [proxy]

public final class UserProperties
extends Object implements Parcelable

Class holding the properties of a user that derive mostly from its user type.

Summary

Constants
`int`	`SHOW_IN_LAUNCHER_NO` Suggests that the launcher should not show this user.
`int`	`SHOW_IN_LAUNCHER_SEPARATE` Suggests that the launcher should show this user's apps, but separately from the apps of this user's parent.
`int`	`SHOW_IN_LAUNCHER_WITH_PARENT` Suggests that the launcher should show this user's apps in the main tab.

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<UserProperties>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`int`	`getShowInLauncher()` Returns whether, and how, a user should be shown in the Launcher.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int parcelableFlags)` 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

SHOW_IN_LAUNCHER_NO

public static final int SHOW_IN_LAUNCHER_NO

Suggests that the launcher should not show this user.

Constant Value: 2 (0x00000002)

SHOW_IN_LAUNCHER_SEPARATE

public static final int SHOW_IN_LAUNCHER_SEPARATE

Suggests that the launcher should show this user's apps, but separately from the apps of this user's parent.

Constant Value: 1 (0x00000001)

SHOW_IN_LAUNCHER_WITH_PARENT

public static final int SHOW_IN_LAUNCHER_WITH_PARENT

Suggests that the launcher should show this user's apps in the main tab. That is, either this user is a full user, so its apps should be presented accordingly, or, if this user is a profile, then its apps should be shown alongside its parent's apps.

Constant Value: 0 (0x00000000)

Fields

Public methods

describeContents

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`

getShowInLauncher

public int getShowInLauncher ()

Returns whether, and how, a user should be shown in the Launcher. This is generally inapplicable for non-profile users. Possible return values include SHOW_IN_LAUNCHER_WITH_PARENT}, SHOW_IN_LAUNCHER_SEPARATE, and SHOW_IN_LAUNCHER_NO.

Returns
`int`	whether, and how, a profile should be shown in the Launcher. Value is `SHOW_IN_LAUNCHER_WITH_PARENT`, `SHOW_IN_LAUNCHER_SEPARATE`, or `SHOW_IN_LAUNCHER_NO`

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int parcelableFlags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: This value cannot be `null`.
`parcelableFlags`	`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