Most visited

Recently visited

Results for

Added in API level 5

Summary: Constants | Ctors | Methods | Inherited Methods | [Expand All]

AbstractAccountAuthenticator

public abstract class AbstractAccountAuthenticator
extends Object

java.lang.Object
↳	android.accounts.AbstractAccountAuthenticator

Abstract base class for creating AccountAuthenticators. In order to be an authenticator one must extend this class, provider implementations for the abstract methods and write a service that returns the result of getIBinder() in the service's onBind(android.content.Intent) when invoked with an intent with action ACTION_AUTHENTICATOR_INTENT. This service must specify the following intent filter and metadata tags in its AndroidManifest.xml file

   <intent-filter>
     <action android:name="android.accounts.AccountAuthenticator" />
   </intent-filter>
   <meta-data android:name="android.accounts.AccountAuthenticator"
             android:resource="@xml/authenticator" />

The android:resource attribute must point to a resource that looks like:

 <account-authenticator xmlns:android="http://schemas.android.com/apk/res/android"
    android:accountType="typeOfAuthenticator"
    android:icon="@drawable/icon"
    android:smallIcon="@drawable/miniIcon"
    android:label="@string/label"
    android:accountPreferences="@xml/account_preferences"
 />

Replace the icons and labels with your own resources. The android:accountType attribute must be a string that uniquely identifies your authenticator and will be the same string that user will use when making calls on the AccountManager and it also corresponds to type for your accounts. One user of the android:icon is the "Account & Sync" settings page and one user of the android:smallIcon is the Contact Application's tab panels.

The preferences attribute points to a PreferenceScreen xml hierarchy that contains a list of PreferenceScreens that can be invoked to manage the authenticator. An example is:

 <PreferenceScreen xmlns:android="http://schemas.android.com/apk/res/android">
    <PreferenceCategory android:title="@string/title_fmt" />
    <PreferenceScreen
         android:key="key1"
         android:title="@string/key1_action"
         android:summary="@string/key1_summary">
         <intent
             android:action="key1.ACTION"
             android:targetPackage="key1.package"
             android:targetClass="key1.class" />
     </PreferenceScreen>
 </PreferenceScreen>

The standard pattern for implementing any of the abstract methods is the following:

If the supplied arguments are enough for the authenticator to fully satisfy the request then it will do so and return a Bundle that contains the results.
If the authenticator needs information from the user to satisfy the request then it will create an Intent to an activity that will prompt the user for the information and then carry out the request. This intent must be returned in a Bundle as key KEY_INTENT.
The activity needs to return the final result when it is complete so the Intent should contain the AccountAuthenticatorResponse as KEY_ACCOUNT_MANAGER_RESPONSE. The activity must then call onResult(Bundle) or onError(int, String) when it is complete.
If the authenticator cannot synchronously process the request and return a result then it may choose to return null and then use the AccountManagerResponse to send the result when it has completed the request.

The following descriptions of each of the abstract authenticator methods will not describe the possible asynchronous nature of the request handling and will instead just describe the input parameters and the expected result.

When writing an activity to satisfy these requests one must pass in the AccountManagerResponse and return the result via that response when the activity finishes (or whenever else the activity author deems it is the correct time to respond). The AccountAuthenticatorActivity handles this, so one may wish to extend that when writing activities to handle these requests.

Summary

Constants
`String`	`KEY_CUSTOM_TOKEN_EXPIRY` Bundle key used for the `long` expiration time (in millis from the unix epoch) of the associated auth token.

Public constructors
`AbstractAccountAuthenticator(Context context)`

Public methods
`abstract Bundle`	`addAccount(AccountAuthenticatorResponse response, String accountType, String authTokenType, String[] requiredFeatures, Bundle options)` Adds an account of the specified accountType.
`Bundle`	`addAccountFromCredentials(AccountAuthenticatorResponse response, Account account, Bundle accountCredentials)` Creates an account based on credentials provided by the authenticator instance of another user on the device, who has chosen to share the account with this user.
`abstract Bundle`	`confirmCredentials(AccountAuthenticatorResponse response, Account account, Bundle options)` Checks that the user knows the credentials of an account.
`abstract Bundle`	`editProperties(AccountAuthenticatorResponse response, String accountType)` Returns a Bundle that contains the Intent of the activity that can be used to edit the properties.
`Bundle`	`getAccountCredentialsForCloning(AccountAuthenticatorResponse response, Account account)` Returns a Bundle that contains whatever is required to clone the account on a different user.
`Bundle`	`getAccountRemovalAllowed(AccountAuthenticatorResponse response, Account account)` Checks if the removal of this account is allowed.
`abstract Bundle`	`getAuthToken(AccountAuthenticatorResponse response, Account account, String authTokenType, Bundle options)` Gets an authtoken for an account.
`abstract String`	`getAuthTokenLabel(String authTokenType)` Ask the authenticator for a localized label for the given authTokenType.
`final IBinder`	`getIBinder()`
`abstract Bundle`	`hasFeatures(AccountAuthenticatorResponse response, Account account, String[] features)` Checks if the account supports all the specified authenticator specific features.
`abstract Bundle`	`updateCredentials(AccountAuthenticatorResponse response, Account account, String authTokenType, Bundle options)` Update the locally stored credentials for an account.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

KEY_CUSTOM_TOKEN_EXPIRY

Added in API level 23

String KEY_CUSTOM_TOKEN_EXPIRY

Bundle key used for the long expiration time (in millis from the unix epoch) of the associated auth token.

See also:

getAuthToken(AccountAuthenticatorResponse, Account, String, Bundle)

Constant Value: "android.accounts.expiry"

Public constructors

AbstractAccountAuthenticator

Added in API level 5

AbstractAccountAuthenticator (Context context)

Parameters
`context`	`Context`

Public methods

addAccount

Added in API level 5

Bundle addAccount (AccountAuthenticatorResponse response, 
                String accountType, 
                String authTokenType, 
                String[] requiredFeatures, 
                Bundle options)

Adds an account of the specified accountType.

Parameters
`response`	`AccountAuthenticatorResponse`: to send the result back to the AccountManager, will never be null
`accountType`	`String`: the type of account to add, will never be null
`authTokenType`	`String`: the type of auth token to retrieve after adding the account, may be null
`requiredFeatures`	`String`: a String array of authenticator-specific features that the added account must support, may be null
`options`	`Bundle`: a Bundle of authenticator-specific options, may be null

Returns
`Bundle`	a Bundle result or null if the result is to be returned via the response. The result will contain either: `KEY_INTENT`, or `KEY_ACCOUNT_NAME` and `KEY_ACCOUNT_TYPE` of the account that was added, or `KEY_ERROR_CODE` and `KEY_ERROR_MESSAGE` to indicate an error

Throws
`NetworkErrorException`	if the authenticator could not honor the request due to a network error

addAccountFromCredentials

Added in API level 18

Bundle addAccountFromCredentials (AccountAuthenticatorResponse response, 
                Account account, 
                Bundle accountCredentials)

Creates an account based on credentials provided by the authenticator instance of another user on the device, who has chosen to share the account with this user.

Parameters
`response`	`AccountAuthenticatorResponse`: to send the result back to the AccountManager, will never be null
`account`	`Account`: the account to clone, will never be null
`accountCredentials`	`Bundle`: the Bundle containing the required credentials to create the account. Contents of the Bundle are only meaningful to the authenticator. This Bundle is provided by `getAccountCredentialsForCloning(AccountAuthenticatorResponse, Account)`.

Returns
`Bundle`	a Bundle result or null if the result is to be returned via the response.

Throws
	NetworkErrorException
`NetworkErrorException`

See also:

ERROR(#getAccountCredentialsForCloning(AccountAuthenticatorResponse, Account)} /{@link #getAccountCredentialsForCloning(AccountAuthenticatorResponse, Account)})

confirmCredentials

Added in API level 5

Bundle confirmCredentials (AccountAuthenticatorResponse response, 
                Account account, 
                Bundle options)

Checks that the user knows the credentials of an account.

Parameters
`response`	`AccountAuthenticatorResponse`: to send the result back to the AccountManager, will never be null
`account`	`Account`: the account whose credentials are to be checked, will never be null
`options`	`Bundle`: a Bundle of authenticator-specific options, may be null

Returns
`Bundle`	a Bundle result or null if the result is to be returned via the response. The result will contain either: `KEY_INTENT`, or `KEY_BOOLEAN_RESULT`, true if the check succeeded, false otherwise `KEY_ERROR_CODE` and `KEY_ERROR_MESSAGE` to indicate an error

Throws
`NetworkErrorException`	if the authenticator could not honor the request due to a network error

editProperties

Added in API level 5

Bundle editProperties (AccountAuthenticatorResponse response, 
                String accountType)

Returns a Bundle that contains the Intent of the activity that can be used to edit the properties. In order to indicate success the activity should call response.setResult() with a non-null Bundle.

Parameters
`response`	`AccountAuthenticatorResponse`: used to set the result for the request. If the Constants.INTENT_KEY is set in the bundle then this response field is to be used for sending future results if and when the Intent is started.
`accountType`	`String`: the AccountType whose properties are to be edited.

Returns
`Bundle`	a Bundle containing the result or the Intent to start to continue the request. If this is null then the request is considered to still be active and the result should sent later using response.

getAccountCredentialsForCloning

Added in API level 18

Bundle getAccountCredentialsForCloning (AccountAuthenticatorResponse response, 
                Account account)

Returns a Bundle that contains whatever is required to clone the account on a different user. The Bundle is passed to the authenticator instance in the target user via addAccountFromCredentials(AccountAuthenticatorResponse, Account, Bundle). The default implementation returns null, indicating that cloning is not supported.

Parameters
`response`	`AccountAuthenticatorResponse`: to send the result back to the AccountManager, will never be null
`account`	`Account`: the account to clone, will never be null

Returns
`Bundle`	a Bundle result or null if the result is to be returned via the response.

Throws
	NetworkErrorException
`NetworkErrorException`

See also:

ERROR(#addAccountFromCredentials(AccountAuthenticatorResponse, Account, Bundle)} /{@link #addAccountFromCredentials(AccountAuthenticatorResponse, Account, Bundle)})

getAccountRemovalAllowed

Added in API level 5

Bundle getAccountRemovalAllowed (AccountAuthenticatorResponse response, 
                Account account)

Checks if the removal of this account is allowed.

Parameters
`response`	`AccountAuthenticatorResponse`: to send the result back to the AccountManager, will never be null
`account`	`Account`: the account to check, will never be null

Returns
`Bundle`	a Bundle result or null if the result is to be returned via the response. The result will contain either: `KEY_INTENT`, or `KEY_BOOLEAN_RESULT`, true if the removal of the account is allowed, false otherwise `KEY_ERROR_CODE` and `KEY_ERROR_MESSAGE` to indicate an error

Throws
`NetworkErrorException`	if the authenticator could not honor the request due to a network error

getAuthToken

Added in API level 5

Bundle getAuthToken (AccountAuthenticatorResponse response, 
                Account account, 
                String authTokenType, 
                Bundle options)

Gets an authtoken for an account. If not null, the resultant Bundle will contain different sets of keys depending on whether a token was successfully issued and, if not, whether one could be issued via some Activity.

If a token cannot be provided without some additional activity, the Bundle should contain KEY_INTENT with an associated Intent. On the other hand, if there is no such activity, then a Bundle containing KEY_ERROR_CODE and KEY_ERROR_MESSAGE should be returned.

If a token can be successfully issued, the implementation should return the KEY_ACCOUNT_NAME and KEY_ACCOUNT_TYPE of the account associated with the token as well as the KEY_AUTHTOKEN. In addition AbstractAccountAuthenticator implementations that declare themselves android:customTokens=true may also provide a non-negative KEY_CUSTOM_TOKEN_EXPIRY long value containing the expiration timestamp of the expiration time (in millis since the unix epoch).

Implementers should assume that tokens will be cached on the basis of account and authTokenType. The system may ignore the contents of the supplied options Bundle when determining to re-use a cached token. Furthermore, implementers should assume a supplied expiration time will be treated as non-binding advice.

Finally, note that for android:customTokens=false authenticators, tokens are cached indefinitely until some client calls invalidateAuthToken(String, String).

Parameters
`response`	`AccountAuthenticatorResponse`: to send the result back to the AccountManager, will never be null
`account`	`Account`: the account whose credentials are to be retrieved, will never be null
`authTokenType`	`String`: the type of auth token to retrieve, will never be null
`options`	`Bundle`: a Bundle of authenticator-specific options, may be null

Returns
`Bundle`	a Bundle result or null if the result is to be returned via the response.

Throws
`NetworkErrorException`	if the authenticator could not honor the request due to a network error

getAuthTokenLabel

Added in API level 5

String getAuthTokenLabel (String authTokenType)

Ask the authenticator for a localized label for the given authTokenType.

Parameters
`authTokenType`	`String`: the authTokenType whose label is to be returned, will never be null

Returns
`String`	the localized label of the auth token type, may be null if the type isn't known

getIBinder

Added in API level 5

IBinder getIBinder ()

Returns
`IBinder`	the IBinder for the AccountAuthenticator

hasFeatures

Added in API level 5

Bundle hasFeatures (AccountAuthenticatorResponse response, 
                Account account, 
                String[] features)

Checks if the account supports all the specified authenticator specific features.

Parameters
`response`	`AccountAuthenticatorResponse`: to send the result back to the AccountManager, will never be null
`account`	`Account`: the account to check, will never be null
`features`	`String`: an array of features to check, will never be null

Returns
`Bundle`	a Bundle result or null if the result is to be returned via the response. The result will contain either: `KEY_INTENT`, or `KEY_BOOLEAN_RESULT`, true if the account has all the features, false otherwise `KEY_ERROR_CODE` and `KEY_ERROR_MESSAGE` to indicate an error

Throws
`NetworkErrorException`	if the authenticator could not honor the request due to a network error

updateCredentials

Added in API level 5

Bundle updateCredentials (AccountAuthenticatorResponse response, 
                Account account, 
                String authTokenType, 
                Bundle options)

Update the locally stored credentials for an account.

Parameters
`response`	`AccountAuthenticatorResponse`: to send the result back to the AccountManager, will never be null
`account`	`Account`: the account whose credentials are to be updated, will never be null
`authTokenType`	`String`: the type of auth token to retrieve after updating the credentials, may be null
`options`	`Bundle`: a Bundle of authenticator-specific options, may be null

Returns
`Bundle`	a Bundle result or null if the result is to be returned via the response. The result will contain either: `KEY_INTENT`, or `KEY_ACCOUNT_NAME` and `KEY_ACCOUNT_TYPE` of the account whose credentials were updated, or `KEY_ERROR_CODE` and `KEY_ERROR_MESSAGE` to indicate an error

Throws
`NetworkErrorException`	if the authenticator could not honor the request due to a network error