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:

com.google.api.client.http.HttpRequestInitializer

@Beta
public class GoogleAccountCredential
extends java.lang.Object
implements com.google.api.client.http.HttpRequestInitializer

Beta
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

Upgrade warning: in prior version 1.14 exponential back-off was enabled by default when I/O exception was thrown inside getToken(), but starting with version 1.15 you need to call setBackOff(com.google.api.client.util.BackOff) with ExponentialBackOff to enable it.

Since:

1.12

Author:

Yaniv Inbar

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
android.accounts.Account[]	getAllAccounts() Returns all Google accounts or null for none.
com.google.api.client.util.BackOff	getBackOff() Returns the back-off policy which is used when an I/O exception is thrown inside getToken() or null for none.
android.content.Context	getContext() Returns the context.
GoogleAccountManager	getGoogleAccountManager() Returns the Google account manager.
java.lang.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.
java.lang.String	getSelectedAccountName() Returns the selected Google account name (e-mail address), for example "johndoe@gmail.com", or null for none.
com.google.api.client.util.Sleeper	getSleeper() Returns the sleeper.
java.lang.String	getToken() Returns an OAuth 2.0 access token.
void	initialize(com.google.api.client.http.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	setBackOff(com.google.api.client.util.BackOff backOff) Sets the back-off policy which is used when an I/O exception is thrown inside getToken() or null for none.
GoogleAccountCredential	setSelectedAccount(android.accounts.Account selectedAccount) Sets the selected Google Account or null for none.
GoogleAccountCredential	setSelectedAccountName(java.lang.String accountName) Sets the selected Google account name (e-mail address) -- for example "johndoe@gmail.com" -- or null for none.
GoogleAccountCredential	setSleeper(com.google.api.client.util.Sleeper sleeper) Sets the sleeper.
static GoogleAccountCredential	usingAudience(android.content.Context context, java.lang.String audience) Sets the audience scope to use with Google Cloud Endpoints.
static GoogleAccountCredential	usingOAuth2(android.content.Context context, java.util.Collection<java.lang.String> scopes) Constructs 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,
                               java.lang.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,
                                                  java.util.Collection<java.lang.String> scopes)

Constructs a new instance using OAuth 2.0 scopes.

Parameters:

context - context

scopes - non empty OAuth 2.0 scope list

Returns:

new instance

Since:

1.15

usingAudience

public static GoogleAccountCredential usingAudience(android.content.Context context,
                                                    java.lang.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(java.lang.String accountName)

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

setSelectedAccount

public final GoogleAccountCredential setSelectedAccount(android.accounts.Account selectedAccount)

Sets the selected Google Account or null for none.

Caller must ensure the given Google account exists.

initialize

public void initialize(com.google.api.client.http.HttpRequest request)

Specified by:

initialize in interface com.google.api.client.http.HttpRequestInitializer

getContext

public final android.content.Context getContext()

Returns the context.

getScope

public final java.lang.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.

getBackOff

public com.google.api.client.util.BackOff getBackOff()

Returns the back-off policy which is used when an I/O exception is thrown inside getToken() or null for none.

Since:

1.15

setBackOff

public GoogleAccountCredential setBackOff(com.google.api.client.util.BackOff backOff)

Sets the back-off policy which is used when an I/O exception is thrown inside getToken() or null for none.

Since:

1.15

getSleeper

public final com.google.api.client.util.Sleeper getSleeper()

Returns the sleeper.

Since:

1.15

setSleeper

public final GoogleAccountCredential setSleeper(com.google.api.client.util.Sleeper sleeper)

Sets the sleeper. The default value is Sleeper.DEFAULT.

Since:

1.15

getSelectedAccountName

public final java.lang.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 java.lang.String getToken()
                          throws java.io.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:

java.io.IOException

com.google.android.gms.auth.GoogleAuthException