java.lang.Object | |
↳ | com.google.android.gms.auth.GoogleAuthUtil |
GoogleAuthUtil provides static utility methods to,
See Authorizing with Google for REST APIs for details.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | CHANGE_TYPE_ACCOUNT_ADDED |
Change types that can be represented in an AccountChangeEvent .
|
|||||||||
int | CHANGE_TYPE_ACCOUNT_REMOVED | ||||||||||
int | CHANGE_TYPE_ACCOUNT_RENAMED_FROM | A rename event that will contain extra data indicating the original account name. | |||||||||
int | CHANGE_TYPE_ACCOUNT_RENAMED_TO | A rename event that will contain extra data indicating the new account name. | |||||||||
String | GOOGLE_ACCOUNT_TYPE | Google Account type string. | |||||||||
String | KEY_REQUEST_ACTIONS | Bundle key for specifying which user's app activity (moment) types can be written to Google. | |||||||||
String | KEY_REQUEST_VISIBLE_ACTIVITIES |
See KEY_REQUEST_ACTIONS .
|
|||||||||
String | KEY_SUPPRESS_PROGRESS_SCREEN |
Adding KEY_SUPPRESS_PROGRESS will suppress the progress screen shown when getting a token
when added as a boolean true option while calling
getToken(Context, String, String, Bundle) .
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Clear the specified token in local cache with respect to the
Context .
| |||||||||||
Gets a list of events for the given account.
| |||||||||||
Gets a stable account id for the given account name.
| |||||||||||
This method is deprecated.
Use
getToken(Context, Account, String) instead.
| |||||||||||
Gets a token to be consumed by some specified services on behalf of a specified user account.
| |||||||||||
This method is deprecated.
Use
getToken(Context, Account, String, Bundle) instead.
| |||||||||||
This method is deprecated.
Use
getTokenWithNotification(Context, Account, String, Bundle, Intent)
instead.
| |||||||||||
This method is deprecated.
Use
getTokenWithNotification(Context, Account, String, Bundle, String, Bundle)
instead.
| |||||||||||
Authenticates the user and returns a valid Google authentication token, or throws an
Exception if there was an error while getting the token.
| |||||||||||
This method is deprecated.
Use
getTokenWithNotification(Context, Account, String, Bundle) instead.
| |||||||||||
Authenticates the user and returns a valid Google authentication token, or throws an
Exception if there was an error while getting the token.
| |||||||||||
Authenticates the user and returns a valid Google authentication token, or throws an
Exception if there was an error while getting the token.
| |||||||||||
This method is deprecated.
Deprecated because calling this function requires permissions MANAGE_ACCOUNTS and
USE_CREDENTIALS. Please use
clearToken(Context, String) instead.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Change types that can be represented in an AccountChangeEvent
.
A rename event that will contain extra data indicating the original account name.
A rename event that will contain extra data indicating the new account name.
Google Account type string. Used for various calls to AccountManager
.
Bundle key for specifying which user's app activity (moment) types can be written to Google.
The list of activity types are represented as a space-separated string passed in the extras
Bundle when calling getToken(Context, String, String, Bundle)
.
This bundle key should be included in the extras Bundle when calling
getToken(Context, String, String, Bundle)
and should only be used when
requesting the PLUS_LOGIN
OAuth 2.0 scope.
See Types of moments for the full list of valid activity types. Example usage:
Bundle bundle = new Bundle(); bundle.putString(GoogleAuthUtil.KEY_REQUEST_ACTIONS, "http://schemas.google.com/AddActivity http://schemas.google.com/BuyActivity"); String token = GoogleAuthUtil.getToken(context, account, Scopes.PLUS_LOGIN, bundle);
See KEY_REQUEST_ACTIONS
.
Adding KEY_SUPPRESS_PROGRESS will suppress the progress screen shown when getting a token
when added as a boolean true
option while calling
getToken(Context, String, String, Bundle)
. This is useful for apps that provide
their own splash screens on initialization.
Clear the specified token in local cache with respect to the Context
. Note that the
context must be the same as that used to initialize the token in a previous call to
getToken(Context, String, String)
or
getToken(Context, String, String, Bundle)
.
context | Context of the token. |
---|---|
token | The token to clear. |
Gets a list of events for the given account. The result is in reverse chronological order.
eventIndex | An event index to restrict results by. If 0 then all events will
be fetched. Otherwise, events greater than this index will be fetched. Callers can
store the last event index seen and use this field to limit results to only events
more recent than the ones seen prior. |
---|---|
accountName | The account name to restrict the event list to. |
GoogleAuthException | |
---|---|
IOException |
Gets a stable account id for the given account name. In the event of a missing id, user
intervention may be required. In such cases, a UserRecoverableAuthException
will be
thrown. To initiate the user recovery workflow, clients must start the Intent
returned by getIntent()
for result. Upon successfully
returning a client should invoke this method again to get an id.
GooglePlayServicesAvailabilityException | containing the appropriate connection status error code. |
---|---|
UserRecoverableAuthException | wrapping an Intent for initiating user intervention.
The wrapped intent must be called with
startActivityForResult(Intent, int) . |
GoogleAuthException | signaling a potentially unrecoverable authentication error. |
IOException | signaling a potentially transient error. |
IllegalStateException | if the method is invoked in the main event thread. |
Gets a token to be consumed by some specified services on behalf of a specified user account.
How the token is consumed depends on the scope string provided. Note that this method
requires substantial network IO and thus should be run off the UI thread. In the event of an
error, one of several Exception
s will be thrown.
In the case of a transient (typically network related) error a IOException
will be
thrown. It is left to clients to implement a backoff/abandonment strategy appropriate to
their latency requirements. If user intervention is required to provide consent, enter
a password, etc, a UserRecoverableAuthException
will be thrown.
To initiate the user recovery workflow, clients must start the Intent
returned by
getIntent()
for result. Upon successfully returning a
client should invoke this method again to get a token. In the cases of errors that are
neither transient nor recoverable by the the user, a GoogleAuthException
will be
thrown. These errors will typically result from client errors (e.g. providing an invalid
scope).
Clients that have their own splash screens may wish to suppress the progress screen provided
by Google Play services. The "Signing in..." progress screen provided by Google Play services
by including setting KEY_SUPPRESS_PROGRESS_SCREEN
to true in the supplied options
Bundle
.
See Authorizing with Google for REST APIs for details.
context | Context associated with the desired token. |
---|---|
account | Authenticating user account. |
scope | String representing the authentication scope. To specify multiple scopes, separate them with a space (for example, "oauth2:scope1 scope2 scope3"). |
extras | Bundle containing additional information that may be relevant to the authentication scope. |
GooglePlayServicesAvailabilityException | containing the appropriate connection status error code. |
---|---|
UserRecoverableAuthException | wrapping an Intent for initiating user intervention.
The wrapped intent must be called with
startActivityForResult(Intent, int) . |
GoogleAuthException | signaling a potentially unrecoverable authentication error. |
IOException | signaling a potentially transient error. |
IllegalStateException | if the method is invoked in the main event thread. |
This method is deprecated.
Use getTokenWithNotification(Context, Account, String, Bundle, Intent)
instead.
This method is deprecated.
Use
getTokenWithNotification(Context, Account, String, Bundle, String, Bundle)
instead.
Authenticates the user and returns a valid Google authentication token, or throws an
Exception
if there was an error while getting the token.
This method is specifically provided for sync adaptors. In the event of an error that needs user intervention, this method takes care of pushing relevant notification. After the user addresses the notification, a sync request will be kicked off using the given params. If the user cancels then the sync is not fired.
The exception thrown depends upon the underlying error and support for recovery.
UserRecoverableNotifiedException
will be thrown if the error can be resolved by user
intervention and a notification has already been posted to address it. IOException
s
will be thrown if the underlying error might be solved by some intelligent retry strategy.
Alternatively, GoogleAuthException
s represent a broad class of Exception
s
that cannot be recovered programmatically.
See Authorizing with Google for REST APIs for details.
context | Context associated with the desired token. |
---|---|
account | Authenticating user account. |
scope | String representing the authentication scope. To specify multiple scopes, separate them with a space (for example, "oauth2:scope1 scope2 scope3"). |
extras | Bundle containing additional information that may be relevant to the authentication scope. |
authority | Authority for firing a sync request. Must not be empty or null. |
syncBundle | extras for firing a sync request. This bundle must pass ContentResolver.validateSyncExtrasBundle(). If no extras are needed can a null value can be passed. |
UserRecoverableNotifiedException | if a user addressable error occurred and a notification was pushed. |
---|---|
GoogleAuthException | signaling a potentially unrecoverable authentication error. |
IOException | signaling a potentially transient error. |
IllegalStateException | if the method is invoked in the main event thread. |
Authenticates the user and returns a valid Google authentication token, or throws an
Exception
if there was an error while getting the token.
This method is specifically provided for background tasks. In the event of an error that needs user intervention, this method takes care of pushing relevant notification.
The exception thrown depends upon the underlying error and support for recovery.
UserRecoverableNotifiedException
will be thrown if the error can be resolved by user
intervention and a notification has already been posted to address it. IOException
s
will be thrown if the underlying error might be solved by some intelligent retry strategy.
Alternatively, GoogleAuthException
s represent a broad class of Exception
s
that cannot be recovered programmatically.
See Authorizing with Google for REST APIs for details.
context | Context associated with the desired token. |
---|---|
account | Authenticating user account. |
scope | String representing the authentication scope. To specify multiple scopes, separate them with a space (for example, "oauth2:scope1 scope2 scope3"). |
extras | Bundle containing additional information that may be relevant to the authentication scope. |
UserRecoverableNotifiedException | if a user addressable error occurred and a notification was pushed. |
---|---|
GoogleAuthException | signaling a potentially unrecoverable authentication error. |
IOException | signaling a potentially transient error. |
IllegalStateException | if the method is invoked in the main event thread. |
Authenticates the user and returns a valid Google authentication token, or throws an
Exception
if there was an error while getting the token.
This method is specifically provided for background tasks. In the event of an error that needs user intervention, this method takes care of pushing relevant notification. After the user addresses the notification, the callback is broadcasted. If the user cancels then the callback is not fired.
The exception thrown depends upon the underlying error and support for recovery.
UserRecoverableNotifiedException
will be thrown if the error can be resolved by user
intervention and a notification has already been posted to address it. IOException
s
will be thrown if the underlying error might be solved by some intelligent retry strategy.
Alternatively, GoogleAuthException
s represent a broad class of Exception
s
that cannot be recovered programmatically.
See Authorizing with Google for REST APIs for details.
context | Context associated with the desired token. |
---|---|
account | Authenticating user account. |
scope | String representing the authentication scope. To specify multiple scopes, separate them with a space (for example, "oauth2:scope1 scope2 scope3"). |
extras | Bundle containing additional information that may be relevant to the authentication scope. |
callback | A broadcast intent with a valid receiver that has been exported for other apps to send broadcasts to it. This intent must be serializable using toUri(Intent.URI_INTENT_SCHEME) and Intent.parseUri(intentUri, Intent.URI_INTENT_SCHEME). Cannot be null. |
UserRecoverableNotifiedException | if a user addressable error occurred and a notification was pushed. |
---|---|
GoogleAuthException | signaling a potentially unrecoverable authentication error. |
IOException | signaling a potentially transient error. |
IllegalStateException | if the method is invoked in the main event thread. |
This method is deprecated.
Deprecated because calling this function requires permissions MANAGE_ACCOUNTS and
USE_CREDENTIALS. Please use clearToken(Context, String)
instead.