Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

AuthenticatorDescription

extends Object
implements Parcelable
java.lang.Object
   ↳ android.accounts.AuthenticatorDescription

Class Overview

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

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator < AuthenticatorDescription > CREATOR Used to create the object from a parcel.
public final int accountPreferencesId A resource id for a hierarchy of PreferenceScreen to be added to the settings page for the account.
public final boolean customTokens Authenticator handles its own token caching and permission screen
public final int iconId A resource id of a icon for the authenticator
public final int labelId A resource id of a label for the authenticator that is suitable for displaying
public final String packageName The package name that can be used to lookup the resources from above.
public final int smallIconId A resource id of a smaller icon for the authenticator
public final String type The string that uniquely identifies an authenticator
Public Constructors
AuthenticatorDescription ( String type, String packageName, int labelId, int iconId, int smallIconId, int prefId, boolean customTokens)
A constructor for a full AuthenticatorDescription
AuthenticatorDescription ( String type, String packageName, int labelId, int iconId, int smallIconId, int prefId)
Public Methods
int describeContents ()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals ( Object o)
Compares the type only, suitable for key comparisons.
int hashCode ()
Returns the hashcode of the type only.
static AuthenticatorDescription newKey ( String type)
A factory method for creating an AuthenticatorDescription that can be used as a key to identify the authenticator by its type.
String toString ()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel ( Parcel dest, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator < AuthenticatorDescription > CREATOR

Added in API level 5

Used to create the object from a parcel.

public final int accountPreferencesId

Added in API level 5

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

public final boolean customTokens

Added in API level 11

Authenticator handles its own token caching and permission screen

public final int iconId

Added in API level 5

A resource id of a icon for the authenticator

public final int labelId

Added in API level 5

A resource id of a label for the authenticator that is suitable for displaying

public final String packageName

Added in API level 5

The package name that can be used to lookup the resources from above.

public final int smallIconId

Added in API level 5

A resource id of a smaller icon for the authenticator

public final String type

Added in API level 5

The string that uniquely identifies an authenticator

Public Constructors

public AuthenticatorDescription ( String type, String packageName, int labelId, int iconId, int smallIconId, int prefId, boolean customTokens)

A constructor for a full AuthenticatorDescription

public AuthenticatorDescription ( String type, String packageName, int labelId, int iconId, int smallIconId, int prefId)

Added in API level 5

Public Methods

public int describeContents ()

Added in API level 5

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals ( Object o)

Added in API level 5

Compares the type only, suitable for key comparisons.

Parameters
o the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object ; false otherwise.

public int hashCode ()

Added in API level 5

Returns the hashcode of the type only.

Returns
  • this object's hash code.

public static AuthenticatorDescription newKey ( String type)

Added in API level 5

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

public String toString ()

Added in API level 5

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

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

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel ( Parcel dest, int flags)

Added in API level 5

Flatten this object in to a Parcel.

Parameters
dest The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE .