AuthenticatorDescription

Kotlin |Java

open class AuthenticatorDescription : Parcelable

kotlin.Any
↳	android.accounts.AuthenticatorDescription

A Parcelable value type that contains information about an account authenticator.

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
`AuthenticatorDescription(type: String!, packageName: String!, labelId: Int, iconId: Int, smallIconId: Int, prefId: Int)`
`AuthenticatorDescription(type: String!, packageName: String!, labelId: Int, iconId: Int, smallIconId: Int, prefId: Int, customTokens: Boolean)` A constructor for a full AuthenticatorDescription

Public methods
open Int	`describeContents()`
open Boolean	`equals(other: Any?)` Compares the type only, suitable for key comparisons.
open Int	`hashCode()` Returns the hashcode of the type only.
open static AuthenticatorDescription!	`newKey(type: String!)` A factory method for creating an AuthenticatorDescription that can be used as a key to identify the authenticator by its type.
open String	`toString()`
open Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<AuthenticatorDescription!>	`CREATOR` Used to create the object from a parcel.
Int	`accountPreferencesId` A resource id for a hierarchy of PreferenceScreen to be added to the settings page for the account.
Boolean	`customTokens` Authenticator handles its own token caching and permission screen
Int	`iconId` A resource id of a icon for the authenticator
Int	`labelId` A resource id of a label for the authenticator that is suitable for displaying
String!	`packageName` The package name that can be used to lookup the resources from above.
Int	`smallIconId` A resource id of a smaller icon for the authenticator
String!	`type` The string that uniquely identifies an authenticator

Public constructors

AuthenticatorDescription

Added in API level 5

AuthenticatorDescription(
    type: String!, 
    packageName: String!, 
    labelId: Int, 
    iconId: Int, 
    smallIconId: Int, 
    prefId: Int)

AuthenticatorDescription

Added in API level 11

AuthenticatorDescription(
    type: String!, 
    packageName: String!, 
    labelId: Int, 
    iconId: Int, 
    smallIconId: Int, 
    prefId: Int, 
    customTokens: Boolean)

A constructor for a full AuthenticatorDescription

Public methods

describeContents

Added in API level 5

open 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 5

open fun equals(other: Any?): Boolean

Compares the type only, suitable for key comparisons.

Parameters
`obj`	the reference object with which to compare.
`o`	This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

hashCode

Added in API level 5

open fun hashCode(): Int

Returns the hashcode of the type only.

Return
`Int`	a hash code value for this object.

newKey

Added in API level 5

open static fun newKey(type: String!): AuthenticatorDescription!

A factory method for creating an AuthenticatorDescription that can be used as a key to identify the authenticator by its type.

toString

Added in API level 5

open fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 5

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

Parameters
`dest`	Parcel: 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

Properties

CREATOR

Added in API level 5

static val CREATOR: Parcelable.Creator<AuthenticatorDescription!>

Used to create the object from a parcel.

accountPreferencesId

Added in API level 5

val accountPreferencesId: Int

A resource id for a hierarchy of PreferenceScreen to be added to the settings page for the account. See AbstractAccountAuthenticator for an example.