java.lang.Object | |
↳ | android.accounts.AccountManager |
This class provides access to a centralized registry of the user's online accounts. The user enters credentials (username and password) once per account, granting applications access to online resources with "one-click" approval.
Different online services have different ways of handling accounts and authentication, so the account manager uses pluggable authenticator modules for different account types. Authenticators (which may be written by third parties) handle the actual details of validating account credentials and storing account information. For example, Google, Facebook, and Microsoft Exchange each have their own authenticator.
Many servers support some notion of an authentication token, which can be used to authenticate a request to the server without sending the user's actual password. (Auth tokens are normally created with a separate request which does include the user's credentials.) AccountManager can generate auth tokens for applications, so the application doesn't need to handle passwords directly. Auth tokens are normally reusable and cached by AccountManager, but must be refreshed periodically. It's the responsibility of applications to invalidate auth tokens when they stop working so the AccountManager knows it needs to regenerate them.
Applications accessing a server normally go through these steps:
get(Context)
.
getAccountsByType(String)
or
getAccountsByTypeAndFeatures(String, String[], AccountManagerCallback, Handler)
. Normally applications will only
be interested in accounts with one particular type, which
identifies the authenticator. Account features are used to
identify particular account subtypes and capabilities. Both the account
type and features are authenticator-specific strings, and must be known by
the application in coordination with its preferred authenticators.
addAccount(String, String, String[], Bundle, Activity, AccountManagerCallback, Handler)
may be called to prompt the user to create an
account of the appropriate type.
getAccountsByType(String)
. Requesting an auth token
for an account no longer on the device results in an undefined failure.
getAuthToken(Account, String, Bundle, Activity, AccountManagerCallback, Handler)
methods or related helpers. Refer to the description
of each method for exact usage and error handling details.
invalidateAuthToken(String, String)
to remove
the token from the cache, otherwise requests will continue failing! After
invalidating the auth token, immediately go back to the "Request an auth
token" step above. If the process fails the second time, then it can be
treated as a "genuine" authentication failure and the user notified or other
appropriate actions taken.
Some AccountManager methods may need to interact with the user to
prompt for credentials, present options, or ask the user to add an account.
The caller may choose whether to allow AccountManager to directly launch the
necessary user interface and wait for the user, or to return an Intent which
the caller may use to launch the interface, or (in some cases) to install a
notification which the user can select at any time to launch the interface.
To have AccountManager launch the interface directly, the caller must supply
the current foreground Activity
context.
Many AccountManager methods take AccountManagerCallback
and
Handler
as parameters. These methods return immediately and
run asynchronously. If a callback is provided then
run(AccountManagerFuture
will be invoked on the Handler's
thread when the request completes, successfully or not.
The result is retrieved by calling getResult()
on the AccountManagerFuture
returned by the method (and also passed
to the callback). This method waits for the operation to complete (if
necessary) and either returns the result or throws an exception if an error
occurred during the operation. To make the request synchronously, call
getResult()
immediately on receiving the
future from the method; no callback need be supplied.
Requests which may block, including
getResult()
, must never be called on
the application's main event thread. These operations throw
IllegalStateException
if they are used on the main thread.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | ACTION_AUTHENTICATOR_INTENT | ||||||||||
String | AUTHENTICATOR_ATTRIBUTES_NAME | ||||||||||
String | AUTHENTICATOR_META_DATA_NAME | ||||||||||
int | ERROR_CODE_BAD_ARGUMENTS | ||||||||||
int | ERROR_CODE_BAD_AUTHENTICATION | ||||||||||
int | ERROR_CODE_BAD_REQUEST | ||||||||||
int | ERROR_CODE_CANCELED | ||||||||||
int | ERROR_CODE_INVALID_RESPONSE | ||||||||||
int | ERROR_CODE_NETWORK_ERROR | ||||||||||
int | ERROR_CODE_REMOTE_EXCEPTION | ||||||||||
int | ERROR_CODE_UNSUPPORTED_OPERATION | ||||||||||
String | KEY_ACCOUNTS | ||||||||||
String | KEY_ACCOUNT_AUTHENTICATOR_RESPONSE | ||||||||||
String | KEY_ACCOUNT_MANAGER_RESPONSE | ||||||||||
String | KEY_ACCOUNT_NAME | Bundle key used for the String account name in results
from methods which return information about a particular account. |
|||||||||
String | KEY_ACCOUNT_TYPE | Bundle key used for the String account type in results
from methods which return information about a particular account. |
|||||||||
String | KEY_ANDROID_PACKAGE_NAME | The Android package of the caller will be set in the options bundle by the
AccountManager and will be passed to the AccountManagerService and
to the AccountAuthenticators. |
|||||||||
String | KEY_AUTHENTICATOR_TYPES | ||||||||||
String | KEY_AUTHTOKEN | Bundle key used for the auth token value in results
from getAuthToken(Account, String, Bundle, Activity, AccountManagerCallback and friends. |
|||||||||
String | KEY_AUTH_FAILED_MESSAGE | ||||||||||
String | KEY_AUTH_TOKEN_LABEL | ||||||||||
String | KEY_BOOLEAN_RESULT | ||||||||||
String | KEY_CALLER_PID | ||||||||||
String | KEY_CALLER_UID | Authenticators using 'customTokens' option will also get the UID of the caller | |||||||||
String | KEY_ERROR_CODE | ||||||||||
String | KEY_ERROR_MESSAGE | ||||||||||
String | KEY_INTENT | Bundle key used for an Intent in results from methods that
may require the caller to interact with the user. |
|||||||||
String | KEY_PASSWORD | Bundle key used to supply the password directly in options to
confirmCredentials(Account, Bundle, Activity, AccountManagerCallback , rather than prompting the user with
the standard password prompt. |
|||||||||
String | KEY_USERDATA | ||||||||||
String | LOGIN_ACCOUNTS_CHANGED_ACTION | Action sent as a broadcast Intent by the AccountsService when accounts are added, accounts are removed, or an account's credentials (saved password, etc) are changed. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Asks the user to add an account of a specified type.
| |||||||||||
Adds an account directly to the AccountManager.
| |||||||||||
Adds an
OnAccountsUpdateListener to this instance of the
AccountManager . | |||||||||||
This convenience helper synchronously gets an auth token with
getAuthToken(Account, String, boolean, AccountManagerCallback, Handler) . | |||||||||||
Forgets a saved password.
| |||||||||||
Confirms that the user knows the password for an account to make extra
sure they are the owner of the account.
| |||||||||||
Offers the user an opportunity to change an authenticator's settings.
| |||||||||||
Gets an AccountManager instance associated with a Context.
| |||||||||||
Lists all accounts of any type registered on the device.
| |||||||||||
Lists all accounts of a particular type.
| |||||||||||
Lists all accounts of a type which have certain features.
| |||||||||||
Returns the accounts visible to the specified package, in an environment where some apps
are not authorized to view all accounts.
| |||||||||||
Gets an auth token of the specified type for a particular account,
prompting the user for credentials if necessary.
| |||||||||||
This method was deprecated
in API level 14.
use
getAuthToken(Account, String, android.os.Bundle, boolean, AccountManagerCallback, android.os.Handler) instead
| |||||||||||
Gets an auth token of the specified type for a particular account,
optionally raising a notification if the user must enter credentials.
| |||||||||||
This convenience helper combines the functionality of
getAccountsByTypeAndFeatures(String, String[], AccountManagerCallback , getAuthToken(Account, String, Bundle, Activity, AccountManagerCallback , and
addAccount(String, String, String[], Bundle, Activity, AccountManagerCallback . | |||||||||||
Lists the currently registered authenticators.
| |||||||||||
Gets the saved password associated with the account.
| |||||||||||
Gets the user data named by "key" associated with the account.
| |||||||||||
Finds out whether a particular account has all the specified features.
| |||||||||||
Removes an auth token from the AccountManager's cache.
| |||||||||||
Returns an intent to an
Activity that prompts the user to choose from a list of
accounts. | |||||||||||
Gets an auth token from the AccountManager's cache.
| |||||||||||
Removes an account from the AccountManager.
| |||||||||||
Removes an
OnAccountsUpdateListener previously registered with
addOnAccountsUpdatedListener(OnAccountsUpdateListener, Handler, boolean) . | |||||||||||
Adds an auth token to the AccountManager cache for an account.
| |||||||||||
Sets or forgets a saved password.
| |||||||||||
Sets one userdata key for an account.
| |||||||||||
Asks the user to enter a new password for an account, updating the
saved credentials for the account.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Bundle key used for the String
account name in results
from methods which return information about a particular account.
Bundle key used for the String
account type in results
from methods which return information about a particular account.
The Android package of the caller will be set in the options bundle by the
AccountManager
and will be passed to the AccountManagerService and
to the AccountAuthenticators. The uid of the caller will be known by the
AccountManagerService as well as the AccountAuthenticators so they will be able to
verify that the package is consistent with the uid (a uid might be shared by many
packages).
Bundle key used for the auth token value in results
from getAuthToken(Account, String, Bundle, Activity, AccountManagerCallback
and friends.
Authenticators using 'customTokens' option will also get the UID of the caller
Bundle key used for an Intent
in results from methods that
may require the caller to interact with the user. The Intent can
be used to start the corresponding user interface activity.
Bundle key used to supply the password directly in options to
confirmCredentials(Account, Bundle, Activity, AccountManagerCallback
, rather than prompting the user with
the standard password prompt.
Action sent as a broadcast Intent by the AccountsService when accounts are added, accounts are removed, or an account's credentials (saved password, etc) are changed.
Asks the user to add an account of a specified type. The authenticator for this account type processes this request with the appropriate user interface. If the user does elect to create a new account, the account name is returned.
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
MANAGE_ACCOUNTS
.
accountType | The type of account to add; must not be null |
---|---|
authTokenType | The type of auth token (see getAuthToken(Account, String, Bundle, Activity, AccountManagerCallback )
this account will need to be able to generate, null for none |
requiredFeatures | The features (see hasFeatures(Account, String[], AccountManagerCallback ) this
account must have, null for none |
addAccountOptions | Authenticator-specific options for the request, may be null or empty |
activity | The Activity context to use for launching a new
authenticator-defined sub-Activity to prompt the user to create an
account; used only to call startActivity(); if null, the prompt
will not be launched directly, but the necessary Intent
will be returned to the caller instead |
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to a Bundle with
these fields if activity was specified and an account was created:
KEY_ACCOUNT_NAME
- the name of the account created
KEY_ACCOUNT_TYPE
- the type of the account
KEY_INTENT
with the Intent
needed to launch the
actual account creation process. If an error occurred,
getResult()
throws:
AuthenticatorException
if no authenticator was registered for
this account type or the authenticator failed to respond
OperationCanceledException
if the operation was canceled for
any reason, including the user canceling the creation process
IOException
if the authenticator experienced an I/O problem
creating a new account, usually because of network trouble
Adds an account directly to the AccountManager. Normally used by sign-up wizards associated with authenticators, not directly by applications.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
AUTHENTICATE_ACCOUNTS
and to have the same UID as the added account's authenticator.
account | The Account to add |
---|---|
password | The password to associate with the account, null for none |
userdata | String values to use for the account's userdata, null for none |
Adds an OnAccountsUpdateListener
to this instance of the
AccountManager
. This listener will be notified whenever the
list of accounts on the device changes.
As long as this listener is present, the AccountManager instance
will not be garbage-collected, and neither will the Context
used to retrieve it, which may be a large Activity instance. To avoid
memory leaks, you must remove this listener before then. Normally
listeners are added in an Activity or Service's onCreate(Bundle)
and removed in onDestroy()
.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
GET_ACCOUNTS
.
listener | The listener to send notifications to |
---|---|
handler | Handler identifying the thread to use
for notifications, null for the main thread |
updateImmediately | If true, the listener will be invoked (on the handler thread) right away with the current account list |
IllegalArgumentException | if listener is null |
---|---|
IllegalStateException | if listener was already added |
This convenience helper synchronously gets an auth token with
getAuthToken(Account, String, boolean, AccountManagerCallback, Handler)
.
This method may block while a network request completes, and must never be made from the main thread.
This method requires the caller to hold the permission
USE_CREDENTIALS
.
account | The account to fetch an auth token for |
---|---|
authTokenType | The auth token type, see getAuthToken() |
notifyAuthFailure | If true, display a notification and return null if authentication fails; if false, prompt and wait for the user to re-enter correct credentials before returning |
AuthenticatorException | if the authenticator failed to respond |
---|---|
OperationCanceledException | if the request was canceled for any reason, including the user canceling a credential request |
IOException | if the authenticator experienced an I/O problem creating a new auth token, usually because of network trouble |
Forgets a saved password. This erases the local copy of the password; it does not change the user's account password on the server. Has the same effect as setPassword(account, null) but requires fewer permissions, and may be used by applications or management interfaces to "sign out" from an account.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
MANAGE_ACCOUNTS
account | The account whose password to clear |
---|
Confirms that the user knows the password for an account to make extra sure they are the owner of the account. The user-entered password can be supplied directly, otherwise the authenticator for this account type prompts the user with the appropriate interface. This method is intended for applications which want extra assurance; for example, the phone lock screen uses this to let the user unlock the phone with an account password if they forget the lock pattern.
If the user-entered password matches a saved password for this account, the request is considered valid; otherwise the authenticator verifies the password (usually by contacting the server).
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
MANAGE_ACCOUNTS
.
account | The account to confirm password knowledge for |
---|---|
options | Authenticator-specific options for the request;
if the KEY_PASSWORD string field is present, the
authenticator may use it directly rather than prompting the user;
may be null or empty |
activity | The Activity context to use for launching a new
authenticator-defined sub-Activity to prompt the user to enter a
password; used only to call startActivity(); if null, the prompt
will not be launched directly, but the necessary Intent
will be returned to the caller instead |
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to a Bundle
with these fields if activity or password was supplied and
the account was successfully verified:
KEY_ACCOUNT_NAME
- the name of the account created
KEY_ACCOUNT_TYPE
- the type of the account
KEY_BOOLEAN_RESULT
- true to indicate success
KEY_INTENT
with the Intent
needed to launch the
password prompt. If an error occurred,
getResult()
throws:
AuthenticatorException
if the authenticator failed to respond
OperationCanceledException
if the operation was canceled for
any reason, including the user canceling the password prompt
IOException
if the authenticator experienced an I/O problem
verifying the password, usually because of network trouble
Offers the user an opportunity to change an authenticator's settings. These properties are for the authenticator in general, not a particular account. Not all authenticators support this method.
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
MANAGE_ACCOUNTS
.
accountType | The account type associated with the authenticator to adjust |
---|---|
activity | The Activity context to use for launching a new
authenticator-defined sub-Activity to adjust authenticator settings;
used only to call startActivity(); if null, the settings dialog will
not be launched directly, but the necessary Intent will be
returned to the caller instead |
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to a Bundle
which is empty if properties were edited successfully, or
if no activity was specified, contains only KEY_INTENT
needed to launch the authenticator's settings dialog.
If an error occurred, getResult()
throws:
AuthenticatorException
if no authenticator was registered for
this account type or the authenticator failed to respond
OperationCanceledException
if the operation was canceled for
any reason, including the user canceling the settings dialog
IOException
if the authenticator experienced an I/O problem
updating settings, usually because of network trouble
Gets an AccountManager instance associated with a Context.
The Context
will be used as long as the AccountManager is
active, so make sure to use a Context
whose lifetime is
commensurate with any listeners registered to
addOnAccountsUpdatedListener(OnAccountsUpdateListener, Handler, boolean)
or similar methods.
It is safe to call this method from the main thread.
No permission is required to call this method.
context | The Context to use when necessary |
---|
AccountManager
instance
Lists all accounts of any type registered on the device. Equivalent to getAccountsByType(null).
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
GET_ACCOUNTS
.
Account
, one for each account. Empty
(never null) if no accounts have been added.
Lists all accounts of a particular type. The account type is a string token corresponding to the authenticator and useful domain of the account. For example, there are types corresponding to Google and Facebook. The exact string token to use will be published somewhere associated with the authenticator in question.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
GET_ACCOUNTS
.
type | The type of accounts to return, null to retrieve all accounts |
---|
Account
, one per matching account. Empty
(never null) if no accounts of the specified type have been added.
Lists all accounts of a type which have certain features. The account
type identifies the authenticator (see getAccountsByType(String)
).
Account features are authenticator-specific string tokens identifying
boolean account properties (see hasFeatures(Account, String[], AccountManagerCallback
).
Unlike getAccountsByType(String)
, this method calls the authenticator,
which may contact the server or do other work to check account features,
so the method returns an AccountManagerFuture
.
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
GET_ACCOUNTS
.
type | The type of accounts to return, must not be null |
---|---|
features | An array of the account features to require, may be null or empty |
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to an array of
Account
, one per account of the specified type which
matches the requested features.
Returns the accounts visible to the specified package, in an environment where some apps are not authorized to view all accounts. This method can only be called by system apps.
type | The type of accounts to return, null to retrieve all accounts |
---|---|
packageName | The package name of the app for which the accounts are to be returned |
Account
, one per matching account. Empty
(never null) if no accounts of the specified type have been added.
Gets an auth token of the specified type for a particular account, prompting the user for credentials if necessary. This method is intended for applications running in the foreground where it makes sense to ask the user directly for a password.
If a previously generated auth token is cached for this account and type, then it is returned. Otherwise, if a saved password is available, it is sent to the server to generate a new auth token. Otherwise, the user is prompted to enter a password.
Some authenticators have auth token types, whose value is authenticator-dependent. Some services use different token types to access different functionality -- for example, Google uses different auth tokens to access Gmail and Google Calendar for the same account.
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
USE_CREDENTIALS
.
account | The account to fetch an auth token for |
---|---|
authTokenType | The auth token type, an authenticator-dependent string token, must not be null |
options | Authenticator-specific options for the request, may be null or empty |
activity | The Activity context to use for launching a new
authenticator-defined sub-Activity to prompt the user for a password
if necessary; used only to call startActivity(); must not be null. |
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to a Bundle with
at least the following fields:
KEY_ACCOUNT_NAME
- the name of the account you supplied
KEY_ACCOUNT_TYPE
- the type of the account
KEY_AUTHTOKEN
- the auth token you wanted
getResult()
throws:
AuthenticatorException
if the authenticator failed to respond
OperationCanceledException
if the operation is canceled for
any reason, incluidng the user canceling a credential request
IOException
if the authenticator experienced an I/O problem
creating a new auth token, usually because of network trouble
This method was deprecated
in API level 14.
use getAuthToken(Account, String, android.os.Bundle, boolean, AccountManagerCallback, android.os.Handler)
instead
Gets an auth token of the specified type for a particular account, optionally raising a notification if the user must enter credentials. This method is intended for background tasks and services where the user should not be immediately interrupted with a password prompt.
If a previously generated auth token is cached for this account and
type, then it is returned. Otherwise, if a saved password is
available, it is sent to the server to generate a new auth token.
Otherwise, an Intent
is returned which, when started, will
prompt the user for a password. If the notifyAuthFailure parameter is
set, a status bar notification is also created with the same Intent,
alerting the user that they need to enter a password at some point.
In that case, you may need to wait until the user responds, which
could take hours or days or forever. When the user does respond and
supply a new password, the account manager will broadcast the
LOGIN_ACCOUNTS_CHANGED_ACTION
Intent, which applications can
use to try again.
If notifyAuthFailure is not set, it is the application's responsibility to launch the returned Intent at some point. Either way, the result from this call will not wait for user action.
Some authenticators have auth token types, whose value is authenticator-dependent. Some services use different token types to access different functionality -- for example, Google uses different auth tokens to access Gmail and Google Calendar for the same account.
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
USE_CREDENTIALS
.
account | The account to fetch an auth token for |
---|---|
authTokenType | The auth token type, an authenticator-dependent string token, must not be null |
notifyAuthFailure | True to add a notification to prompt the user for a password if necessary, false to leave that to the caller |
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to a Bundle with
at least the following fields on success:
KEY_ACCOUNT_NAME
- the name of the account you supplied
KEY_ACCOUNT_TYPE
- the type of the account
KEY_AUTHTOKEN
- the auth token you wanted
KEY_INTENT
with the Intent
needed to launch a prompt.
If an error occurred, getResult()
throws:
AuthenticatorException
if the authenticator failed to respond
OperationCanceledException
if the operation is canceled for
any reason, incluidng the user canceling a credential request
IOException
if the authenticator experienced an I/O problem
creating a new auth token, usually because of network trouble
Gets an auth token of the specified type for a particular account, optionally raising a notification if the user must enter credentials. This method is intended for background tasks and services where the user should not be immediately interrupted with a password prompt.
If a previously generated auth token is cached for this account and
type, then it is returned. Otherwise, if a saved password is
available, it is sent to the server to generate a new auth token.
Otherwise, an Intent
is returned which, when started, will
prompt the user for a password. If the notifyAuthFailure parameter is
set, a status bar notification is also created with the same Intent,
alerting the user that they need to enter a password at some point.
In that case, you may need to wait until the user responds, which
could take hours or days or forever. When the user does respond and
supply a new password, the account manager will broadcast the
LOGIN_ACCOUNTS_CHANGED_ACTION
Intent, which applications can
use to try again.
If notifyAuthFailure is not set, it is the application's responsibility to launch the returned Intent at some point. Either way, the result from this call will not wait for user action.
Some authenticators have auth token types, whose value is authenticator-dependent. Some services use different token types to access different functionality -- for example, Google uses different auth tokens to access Gmail and Google Calendar for the same account.
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
USE_CREDENTIALS
.
account | The account to fetch an auth token for |
---|---|
authTokenType | The auth token type, an authenticator-dependent string token, must not be null |
options | Authenticator-specific options for the request, may be null or empty |
notifyAuthFailure | True to add a notification to prompt the user for a password if necessary, false to leave that to the caller |
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to a Bundle with
at least the following fields on success:
KEY_ACCOUNT_NAME
- the name of the account you supplied
KEY_ACCOUNT_TYPE
- the type of the account
KEY_AUTHTOKEN
- the auth token you wanted
KEY_INTENT
with the Intent
needed to launch a prompt.
If an error occurred, getResult()
throws:
AuthenticatorException
if the authenticator failed to respond
OperationCanceledException
if the operation is canceled for
any reason, incluidng the user canceling a credential request
IOException
if the authenticator experienced an I/O problem
creating a new auth token, usually because of network trouble
This convenience helper combines the functionality of
getAccountsByTypeAndFeatures(String, String[], AccountManagerCallback
, getAuthToken(Account, String, Bundle, Activity, AccountManagerCallback
, and
addAccount(String, String, String[], Bundle, Activity, AccountManagerCallback
.
This method gets a list of the accounts matching the specified type and feature set; if there is exactly one, it is used; if there are more than one, the user is prompted to pick one; if there are none, the user is prompted to add one. Finally, an auth token is acquired for the chosen account.
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
MANAGE_ACCOUNTS
.
accountType | The account type required
(see getAccountsByType(String) ), must not be null |
---|---|
authTokenType | The desired auth token type
(see getAuthToken(Account, String, Bundle, Activity, AccountManagerCallback ), must not be null |
features | Required features for the account
(see getAccountsByTypeAndFeatures(String, String[], AccountManagerCallback ), may be null or empty |
activity | The Activity context to use for launching new
sub-Activities to prompt to add an account, select an account,
and/or enter a password, as necessary; used only to call
startActivity(); should not be null |
addAccountOptions | Authenticator-specific options to use for adding new accounts; may be null or empty |
getAuthTokenOptions | Authenticator-specific options to use for getting auth tokens; may be null or empty |
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to a Bundle with
at least the following fields:
KEY_ACCOUNT_NAME
- the name of the account
KEY_ACCOUNT_TYPE
- the type of the account
KEY_AUTHTOKEN
- the auth token you wanted
getResult()
throws:
AuthenticatorException
if no authenticator was registered for
this account type or the authenticator failed to respond
OperationCanceledException
if the operation was canceled for
any reason, including the user canceling any operation
IOException
if the authenticator experienced an I/O problem
updating settings, usually because of network trouble
Lists the currently registered authenticators.
It is safe to call this method from the main thread.
No permission is required to call this method.
AuthenticatorDescription
for every
authenticator known to the AccountManager service. Empty (never
null) if no authenticators are known.
Gets the saved password associated with the account. This is intended for authenticators and related code; applications should get an auth token instead.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
AUTHENTICATE_ACCOUNTS
and to have the same UID as the account's authenticator.
account | The account to query for a password |
---|
Gets the user data named by "key" associated with the account. This is intended for authenticators and related code to store arbitrary metadata along with accounts. The meaning of the keys and values is up to the authenticator for the account.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
AUTHENTICATE_ACCOUNTS
and to have the same UID as the account's authenticator.
account | The account to query for user data |
---|
Finds out whether a particular account has all the specified features. Account features are authenticator-specific string tokens identifying boolean account properties. For example, features are used to tell whether Google accounts have a particular service (such as Google Calendar or Google Talk) enabled. The feature names and their meanings are published somewhere associated with the authenticator in question.
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
GET_ACCOUNTS
.
account | The Account to test |
---|---|
features | An array of the account features to check |
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to a Boolean,
true if the account exists and has all of the specified features.
Removes an auth token from the AccountManager's cache. Does nothing if the auth token is not currently in the cache. Applications must call this method when the auth token is found to have expired or otherwise become invalid for authenticating requests. The AccountManager does not validate or expire cached auth tokens otherwise.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
MANAGE_ACCOUNTS
or
USE_CREDENTIALS
accountType | The account type of the auth token to invalidate, must not be null |
---|---|
authToken | The auth token to invalidate, may be null |
Returns an intent to an Activity
that prompts the user to choose from a list of
accounts.
The caller will then typically start the activity by calling
startActivityForResult(intent, ...);
.
On success the activity returns a Bundle with the account name and type specified using
keys KEY_ACCOUNT_NAME
and KEY_ACCOUNT_TYPE
.
The most common case is to call this with one account type, e.g.:
newChooseAccountIntent(null, null, new String[]{"com.google"}, false, null, null, null, null);
selectedAccount | if specified, indicates that the Account is the currently
selected one, according to the caller's definition of selected. |
---|---|
allowableAccounts | an optional ArrayList of accounts that are allowed to be
shown. If not specified then this field will not limit the displayed accounts. |
allowableAccountTypes | an optional string array of account types. These are used both to filter the shown accounts and to filter the list of account types that are shown when adding an account. |
alwaysPromptForAccount | if set the account chooser screen is always shown, otherwise it is only shown when there is more than one account from which to choose |
descriptionOverrideText | if non-null this string is used as the description in the accounts chooser screen rather than the default |
addAccountAuthTokenType | this string is passed as the addAccount(String, String, String[], Bundle, Activity, AccountManagerCallback
authTokenType parameter |
addAccountRequiredFeatures | this string array is passed as the addAccount(String, String, String[], Bundle, Activity, AccountManagerCallback
requiredFeatures parameter |
addAccountOptions | This Bundle is passed as the addAccount(String, String, String[], Bundle, Activity, AccountManagerCallback options
parameter |
Intent
that can be used to launch the ChooseAccount activity flow.
Gets an auth token from the AccountManager's cache. If no auth token is cached for this account, null will be returned -- a new auth token will not be generated, and the server will not be contacted. Intended for use by the authenticator, not directly by applications.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
AUTHENTICATE_ACCOUNTS
and to have the same UID as the account's authenticator.
account | The account to fetch an auth token for |
---|---|
authTokenType | The type of auth token to fetch, see {#getAuthToken} |
Removes an account from the AccountManager. Does nothing if the account does not exist. Does not delete the account from the server. The authenticator may have its own policies preventing account deletion, in which case the account will not be deleted.
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
MANAGE_ACCOUNTS
.
account | The Account to remove |
---|---|
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to a Boolean,
true if the account has been successfully removed,
false if the authenticator forbids deleting this account.
Removes an OnAccountsUpdateListener
previously registered with
addOnAccountsUpdatedListener(OnAccountsUpdateListener, Handler, boolean)
. The listener will no longer
receive notifications of account changes.
It is safe to call this method from the main thread.
No permission is required to call this method.
listener | The previously added listener to remove |
---|
IllegalArgumentException | if listener is null |
---|---|
IllegalStateException | if listener was not already added |
Adds an auth token to the AccountManager cache for an account. If the account does not exist then this call has no effect. Replaces any previous auth token for this account and auth token type. Intended for use by the authenticator, not directly by applications.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
AUTHENTICATE_ACCOUNTS
and to have the same UID as the account's authenticator.
account | The account to set an auth token for |
---|---|
authTokenType | The type of the auth token, see {#getAuthToken} |
authToken | The auth token to add to the cache |
Sets or forgets a saved password. This modifies the local copy of the password used to automatically authenticate the user; it does not change the user's account password on the server. Intended for use by the authenticator, not directly by applications.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
AUTHENTICATE_ACCOUNTS
and have the same UID as the account's authenticator.
account | The account to set a password for |
---|---|
password | The password to set, null to clear the password |
Sets one userdata key for an account. Intended by use for the authenticator to stash state for itself, not directly by applications. The meaning of the keys and values is up to the authenticator.
It is safe to call this method from the main thread.
This method requires the caller to hold the permission
AUTHENTICATE_ACCOUNTS
and to have the same UID as the account's authenticator.
account | The account to set the userdata for |
---|---|
key | The userdata key to set. Must not be null |
value | The value to set, null to clear this userdata key |
Asks the user to enter a new password for an account, updating the saved credentials for the account. Normally this happens automatically when the server rejects credentials during an auth token fetch, but this can be invoked directly to ensure we have the correct credentials stored.
This method may be called from any thread, but the returned
AccountManagerFuture
must not be used on the main thread.
This method requires the caller to hold the permission
MANAGE_ACCOUNTS
.
account | The account to update credentials for |
---|---|
authTokenType | The credentials entered must allow an auth token of this type to be created (but no actual auth token is returned); may be null |
options | Authenticator-specific options for the request; may be null or empty |
activity | The Activity context to use for launching a new
authenticator-defined sub-Activity to prompt the user to enter a
password; used only to call startActivity(); if null, the prompt
will not be launched directly, but the necessary Intent
will be returned to the caller instead |
callback | Callback to invoke when the request completes, null for no callback |
handler | Handler identifying the callback thread,
null for the main thread |
AccountManagerFuture
which resolves to a Bundle
with these fields if an activity was supplied and the account
credentials were successfully updated:
KEY_ACCOUNT_NAME
- the name of the account created
KEY_ACCOUNT_TYPE
- the type of the account
KEY_INTENT
with the Intent
needed to launch the
password prompt. If an error occurred,
getResult()
throws:
AuthenticatorException
if the authenticator failed to respond
OperationCanceledException
if the operation was canceled for
any reason, including the user canceling the password prompt
IOException
if the authenticator experienced an I/O problem
verifying the password, usually because of network trouble