public
class
AuthenticatorDescription
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.accounts.AuthenticatorDescription |
A Parcelable value type that contains information about an account authenticator.
Inherited constants |
|---|
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)
|
|
AuthenticatorDescription(String type, String packageName, int labelId, int iconId, int smallIconId, int prefId, boolean customTokens)
A constructor for a full AuthenticatorDescription |
|
Public methods | |
|---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled 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 representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
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. See AbstractAccountAuthenticator for an example.
public final boolean customTokens
Authenticator handles its own token caching and permission screen
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 AuthenticatorDescription (String type, String packageName, int labelId, int iconId, int smallIconId, int prefId)
| Parameters | |
|---|---|
type |
String |
packageName |
String |
labelId |
int |
iconId |
int |
smallIconId |
int |
prefId |
int |
public AuthenticatorDescription (String type, String packageName, int labelId, int iconId, int smallIconId, int prefId, boolean customTokens)
A constructor for a full AuthenticatorDescription
| Parameters | |
|---|---|
type |
String |
packageName |
String |
labelId |
int |
iconId |
int |
smallIconId |
int |
prefId |
int |
customTokens |
boolean |
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(Parcel,int),
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR bit.
int0 or
public boolean equals (Object o)
Compares the type only, suitable for key comparisons.
| Parameters | |
|---|---|
o |
Object: This value may be null. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
public int hashCode ()
Returns the hashcode of the type only.
| Returns | |
|---|---|
int |
a hash code value for this object. |
public 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.
| Parameters | |
|---|---|
type |
String |
| Returns | |
|---|---|
AuthenticatorDescription |
|
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
a string representation of the object. |
public void writeToParcel (Parcel dest,
int flags)Flatten this object in to a Parcel.
destParcel: The Parcel in which the object should be written.
null.flagsint: Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
0 or a combination of the following:
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-02-26 UTC.