com.google.api.client.googleapis.extensions.android.gms.auth

Class GoogleAccountCredential

java.lang.Object

com.google.api.client.googleapis.extensions.android.gms.auth.GoogleAccountCredential

All Implemented Interfaces:

HttpRequestInitializer

public class GoogleAccountCredential
extends Object
implements HttpRequestInitializer

Manages authorization and account selection for Google accounts.

When fetching a token, any thrown GoogleAuthException would be wrapped:

• GooglePlayServicesAvailabilityException would be wrapped inside of GooglePlayServicesAvailabilityIOException
• UserRecoverableAuthException would be wrapped inside of UserRecoverableAuthIOException
• GoogleAuthException when be wrapped inside of GoogleAuthIOException

Since:

1.12

Author:

Yaniv Inbar

Constructor Summary

Constructors

Constructor and Description
GoogleAccountCredential(android.content.Context context, String scope)

Method Summary

Methods

Modifier and Type	Method and Description
android.accounts.Account[]	getAllAccounts() Returns all Google accounts or null for none.
android.content.Context	getContext() Returns the context.
GoogleAccountManager	getGoogleAccountManager() Returns the Google account manager.
String	getScope() Returns the scope to use on GoogleAuthUtil.getToken(android.content.Context, java.lang.String, java.lang.String).
android.accounts.Account	getSelectedAccount() Returns the selected Google account or null for none.
String	getSelectedAccountName() Returns the selected Google account name (e-mail address), for example "johndoe@gmail.com", or null for none.
String	getToken() Returns an OAuth 2.0 access token.
void	initialize(HttpRequest request)
android.content.Intent	newChooseAccountIntent() Returns an intent to show the user to select a Google account, or create a new one if there are none on the device yet.
GoogleAccountCredential	setSelectedAccountName(String accountName) Sets the selected Google account name (e-mail address) -- for example "johndoe@gmail.com" -- or null for none.
static GoogleAccountCredential	usingAudience(android.content.Context context, String audience) Sets the audience scope to use with Google Cloud Endpoints.
static GoogleAccountCredential	usingOAuth2(android.content.Context context, String scope, String... extraScopes) Constructor a new instance using OAuth 2.0 scopes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GoogleAccountCredential

public GoogleAccountCredential(android.content.Context context,
                       String scope)

Parameters:

context - context

scope - scope to use on GoogleAuthUtil.getToken(android.content.Context, java.lang.String, java.lang.String)

Method Detail

usingOAuth2

public static GoogleAccountCredential usingOAuth2(android.content.Context context,
                                  String scope,
                                  String... extraScopes)

Constructor a new instance using OAuth 2.0 scopes.

Parameters:

context - context

scope - first OAuth 2.0 scope

extraScopes - any additional OAuth 2.0 scopes

Returns:

new instance

usingAudience

public static GoogleAccountCredential usingAudience(android.content.Context context,
                                    String audience)

Sets the audience scope to use with Google Cloud Endpoints.

Parameters:

context - context

audience - audience

Returns:

new instance

setSelectedAccountName

public final GoogleAccountCredential setSelectedAccountName(String accountName)

Sets the selected Google account name (e-mail address) -- for example "johndoe@gmail.com" -- or null for none.

initialize

public void initialize(HttpRequest request)

Specified by:

initialize in interface HttpRequestInitializer

getContext

public final android.content.Context getContext()

Returns the context.

getScope

public final String getScope()

Returns the scope to use on GoogleAuthUtil.getToken(android.content.Context, java.lang.String, java.lang.String).

getGoogleAccountManager

public final GoogleAccountManager getGoogleAccountManager()

Returns the Google account manager.

getAllAccounts

public final android.accounts.Account[] getAllAccounts()

Returns all Google accounts or null for none.

getSelectedAccount

public final android.accounts.Account getSelectedAccount()

Returns the selected Google account or null for none.

getSelectedAccountName

public final String getSelectedAccountName()

Returns the selected Google account name (e-mail address), for example "johndoe@gmail.com", or null for none.

newChooseAccountIntent

public final android.content.Intent newChooseAccountIntent()

Returns an intent to show the user to select a Google account, or create a new one if there are none on the device yet.

Must be run from the main UI thread.

getToken

public final String getToken()
                      throws IOException,
                             com.google.android.gms.auth.GoogleAuthException

Returns an OAuth 2.0 access token.

Must be run from a background thread, not the main UI thread.

Throws:

IOException

com.google.android.gms.auth.GoogleAuthException