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 |
---|
![]() 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 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 |
|
---|---|
![]() java.lang.Object
|
|
![]() android.os.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. See AbstractAccountAuthenticator
for an example.
boolean customTokens
Authenticator handles its own token caching and permission screen
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
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 (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
|
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.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. |
boolean equals (Object o)
Compares the type only, suitable for key comparisons.
Parameters | |
---|---|
o |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj argument; false otherwise. |
int hashCode ()
Returns the hashcode of the type only.
Returns | |
---|---|
int |
a hash code value for this object. |
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 |
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. |
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. |
flags |
int : Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE . |