AuthenticatorDescription
public
class
AuthenticatorDescription
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.accounts.AuthenticatorDescription |
A Parcelable
value type that contains information about an account authenticator.
Summary
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, 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 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 | |
---|---|
Fields
CREATOR
public static final Creator<AuthenticatorDescription> CREATOR
Used to create the object from a parcel.
accountPreferencesId
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.
customTokens
public final boolean customTokens
Authenticator handles its own token caching and permission screen
labelId
public final int labelId
A resource id of a label for the authenticator that is suitable for displaying
packageName
public final String packageName
The package name that can be used to lookup the resources from above.
smallIconId
public final int smallIconId
A resource id of a smaller icon for the authenticator
type
public final String type
The string that uniquely identifies an authenticator
Public constructors
AuthenticatorDescription
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 |
AuthenticatorDescription
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 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 |
equals
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. |
hashCode
public int hashCode ()
Returns the hashcode of the type only.
Returns | |
---|---|
int |
a hash code value for this object. |
newKey
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 |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
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.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |