# AuthenticatorDescription

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Inherited Constants](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#inhconstants)\|[Fields](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#lfields)\|[Ctors](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#pubctors)\|[Methods](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#inhmethods)  

# AuthenticatorDescription

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/accounts/AuthenticatorDescription "View this page in Kotlin")\|Java

`
public


class
AuthenticatorDescription
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


implements

`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`


`

|---|-------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.accounts.AuthenticatorDescription |

<br />

*** ** * ** ***

A[Parcelable](https://developer.android.com/reference/android/os/Parcelable)value type that contains information about an account authenticator.

## Summary

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ### Inherited constants                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor.                                                                                                                                            | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): 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)`". | |

|                                                                                                                                                                                                                           ### Fields                                                                                                                                                                                                                           ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` public static final `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[AuthenticatorDescription](https://developer.android.com/reference/android/accounts/AuthenticatorDescription)`>` | [CREATOR](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#CREATOR) Used to create the object from a parcel.                                                                                      |
| ` public final int`                                                                                                                                                                                                        | [accountPreferencesId](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#accountPreferencesId) A resource id for a hierarchy of PreferenceScreen to be added to the settings page for the account. |
| ` public final boolean`                                                                                                                                                                                                    | [customTokens](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#customTokens) Authenticator handles its own token caching and permission screen                                                   |
| ` public final int`                                                                                                                                                                                                        | [iconId](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#iconId) A resource id of a icon for the authenticator                                                                                   |
| ` public final int`                                                                                                                                                                                                        | [labelId](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#labelId) A resource id of a label for the authenticator that is suitable for displaying                                                |
| ` public final `[String](https://developer.android.com/reference/java/lang/String)                                                                                                                                         | [packageName](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#packageName) The package name that can be used to lookup the resources from above.                                                 |
| ` public final int`                                                                                                                                                                                                        | [smallIconId](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#smallIconId) A resource id of a smaller icon for the authenticator                                                                 |
| ` public final `[String](https://developer.android.com/reference/java/lang/String)                                                                                                                                         | [type](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#type) The string that uniquely identifies an authenticator                                                                                |

|                                                                                                                                                                                                                                                 ### Public constructors                                                                                                                                                                                                                                                 ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[AuthenticatorDescription](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#AuthenticatorDescription(java.lang.String,%20java.lang.String,%20int,%20int,%20int,%20int))`(`[String](https://developer.android.com/reference/java/lang/String)` type, `[String](https://developer.android.com/reference/java/lang/String)` packageName, int labelId, int iconId, int smallIconId, int prefId) `                                                                                    |
| ` `[AuthenticatorDescription](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#AuthenticatorDescription(java.lang.String,%20java.lang.String,%20int,%20int,%20int,%20int,%20boolean))`(`[String](https://developer.android.com/reference/java/lang/String)` type, `[String](https://developer.android.com/reference/java/lang/String)` packageName, int labelId, int iconId, int smallIconId, int prefId, boolean customTokens) ` A constructor for a full AuthenticatorDescription |

|                                                                                                                                                                                                                      ### Public methods                                                                                                                                                                                                                       ||
|-------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int`                                                                                                                  | ` `[describeContents](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                                                                             |
| ` boolean`                                                                                                              | ` `[equals](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Compares the type only, suitable for key comparisons.                                                                             |
| ` int`                                                                                                                  | ` `[hashCode](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#hashCode())`() ` Returns the hashcode of the type only.                                                                                                                                                                              |
| ` static `[AuthenticatorDescription](https://developer.android.com/reference/android/accounts/AuthenticatorDescription) | ` `[newKey](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#newKey(java.lang.String))`(`[String](https://developer.android.com/reference/java/lang/String)` type) ` A factory method for creating an AuthenticatorDescription that can be used as a key to identify the authenticator by its type. |
| ` `[String](https://developer.android.com/reference/java/lang/String)                                                   | ` `[toString](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#toString())`() ` Returns a string representation of the object.                                                                                                                                                                      |
| ` void`                                                                                                                 | ` `[writeToParcel](https://developer.android.com/reference/android/accounts/AuthenticatorDescription#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel.                                                          |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||
| From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int`  | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                    | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||

## Fields

### CREATOR

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static final Creator<AuthenticatorDescription> CREATOR
```

Used to create the object from a parcel.

<br />

### accountPreferencesId

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final int accountPreferencesId
```

A resource id for a hierarchy of PreferenceScreen to be added to the settings page for the account. See[AbstractAccountAuthenticator](https://developer.android.com/reference/android/accounts/AbstractAccountAuthenticator)for an example.

<br />

### customTokens

Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final boolean customTokens
```

Authenticator handles its own token caching and permission screen

<br />

### iconId

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final int iconId
```

A resource id of a icon for the authenticator

<br />

### labelId

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final int labelId
```

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

<br />

### packageName

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final String packageName
```

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

<br />

### smallIconId

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final int smallIconId
```

A resource id of a smaller icon for the authenticator

<br />

### type

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final String type
```

The string that uniquely identifies an authenticator

<br />

## Public constructors

### AuthenticatorDescription

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

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

<br />

<br />

|           Parameters           ||
|---------------|-----------------|
| `type`        | `String` <br /> |
| `packageName` | `String` <br /> |
| `labelId`     | `int` <br />    |
| `iconId`      | `int` <br />    |
| `smallIconId` | `int` <br />    |
| `prefId`      | `int` <br />    |

### AuthenticatorDescription

Added in[API level 11](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

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

A constructor for a full AuthenticatorDescription

<br />

|            Parameters            ||
|----------------|------------------|
| `type`         | `String` <br />  |
| `packageName`  | `String` <br />  |
| `labelId`      | `int` <br />     |
| `iconId`       | `int` <br />     |
| `smallIconId`  | `int` <br />     |
| `prefId`       | `int` <br />     |
| `customTokens` | `boolean` <br /> |

## 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)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.

<br />

|                                                                                                                         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](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) <br /> |

### equals

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public boolean equals (Object o)
```

Compares the type only, suitable for key comparisons.

<br />

|                   Parameters                   ||
|-----|-------------------------------------------|
| `o` | `Object`: This value may be`null`. <br /> |

|                                         Returns                                          ||
|-----------|-------------------------------------------------------------------------------|
| `boolean` | `true`if this object is the same as the obj argument;`false`otherwise. <br /> |

### hashCode

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public int hashCode ()
```

Returns the hashcode of the type only.

<br />

|                     Returns                      ||
|-------|-------------------------------------------|
| `int` | a hash code value for this object. <br /> |

### newKey

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

|       Parameters        ||
|--------|-----------------|
| `type` | `String` <br /> |

|                                                        Returns                                                        ||
|---------------------------------------------------------------------------------------------------------------|--------|
| [AuthenticatorDescription](https://developer.android.com/reference/android/accounts/AuthenticatorDescription) | <br /> |

### toString

Added in[API level 5](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public String toString ()
```

Returns a string representation of the object.

<br />

|                                                      Returns                                                      ||
|--------------------------------------------------------------------|-----------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object. <br /> |

### writeToParcel

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

|                                                                                                                                                                                                                               Parameters                                                                                                                                                                                                                                ||
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dest`  | `Parcel`: The Parcel in which the object should be written. This value cannot be`null`. <br />                                                                                                                                                                                                                                                                                                                                                                 |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES <br /> |