AccountPicker

class AccountPicker

Common account picker similar to the standard framework account picker introduced in ICS: newChooseAccountIntent.

Summary

Nested types

Options for building an appropriate intent to launch the Account Picker.

The builder for creating an instance of the AccountChooserOptions.

Public functions
java-static Intent!

Returns an intent to an Activity that prompts the user to choose from a list of accounts.
java-static Intent!
newChooseAccountIntent(
    selectedAccount: Account?,
    allowableAccounts: ArrayList<Account!>?,
    allowableAccountTypes: Array<String!>?,
    alwaysPromptForAccount: Boolean,
    descriptionOverrideText: String?,
    addAccountAuthTokenType: String?,
    addAccountRequiredFeatures: Array<String!>?,
    addAccountOptions: Bundle?
)

This function is deprecated.

use newChooseAccountIntent

Public functions

newChooseAccountIntent

java-static fun newChooseAccountIntent(options: AccountPicker.AccountChooserOptions!): Intent!

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.

NOTE: for API level O: The activity only shows accounts visible to Google Play services as opposed to newChooseAccountIntent. If chosen account has Google type it is marked as visible to the caller and will be returned by getAccountsByType.

The most common case is to call this with one account type, e.g.: 

Intent intent =
    AccountPicker.newChooseAccountIntent(
        new AccountChooserOptions.Builder()
            .setAllowableAccountsTypes(Arrays.asList("com.google"))
            .build());
startActivityForResult(intent, SOME_REQUEST_CODE);
 The account picker activity will return when the user has selected and/or created an account, and the resulting account name can be retrieved as follows: 
protected void onActivityResult(final int requestCode, final int resultCode,
        final Intent data) {
    if (requestCode == SOME_REQUEST_CODE && resultCode == RESULT_OK) {
        String accountName = data.getStringExtra(AccountManager.KEY_ACCOUNT_NAME);
  }
}
Parameters
options: AccountPicker.AccountChooserOptions!

that controls the behavior and style of the AccountPicker.

newChooseAccountIntent

java-static fun newChooseAccountIntent(
    selectedAccount: Account?,
    allowableAccounts: ArrayList<Account!>?,
    allowableAccountTypes: Array<String!>?,
    alwaysPromptForAccount: Boolean,
    descriptionOverrideText: String?,
    addAccountAuthTokenType: String?,
    addAccountRequiredFeatures: Array<String!>?,
    addAccountOptions: Bundle?
): Intent!

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.

NOTE: for API level O: The activity only shows accounts visible to Google Play services as opposed to newChooseAccountIntent. If chosen account has Google type it is marked as visible to the caller and will be returned by getAccountsByType.

The most common case is to call this with one account type, e.g.: 

Intent intent = AccountPicker.newChooseAccountIntent(null, null, new String[]{"com.google"},
        false, null, null, null, null);
startActivityForResult(intent, SOME_REQUEST_CODE);
 The account picker activity will return when the user has selected and/or created an account, and the resulting account name can be retrieved as follows: 
protected void onActivityResult(final int requestCode, final int resultCode,
        final Intent data) {
    if (requestCode == SOME_REQUEST_CODE && resultCode == RESULT_OK) {
        String accountName = data.getStringExtra(AccountManager.KEY_ACCOUNT_NAME);
  }
}
Parameters
selectedAccount: Account?

if specified, indicates that the Account is the currently selected one, according to the caller's definition of selected.
allowableAccounts: ArrayList<Account!>?

an optional ArrayList of accounts that are allowed to be shown. If not specified then this field will not limit the displayed accounts.
allowableAccountTypes: Array<String!>?

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: Boolean

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 or the calling app doesn't have the GET_ACCOUNTS permission.
descriptionOverrideText: String?

if non-null this string is used as the description in the accounts chooser screen rather than the default.
addAccountAuthTokenType: String?

this optional string is passed as the addAccount authTokenType parameter. Current implementation does not check this value.
addAccountRequiredFeatures: Array<String!>?

this optional string array is passed as the addAccount requiredFeatures parameter. Current implementation does not check this value.
addAccountOptions: Bundle?

This optional Bundle is passed as the addAccount options parameter. Can be null if sending no extra options.
Returns
Intent!

an Intent that can be used to launch the ChooseAccount activity flow.