com.amazonaws.mobile.auth.google

Class GoogleSignInProvider

java.lang.Object

com.amazonaws.mobile.auth.google.GoogleSignInProvider

All Implemented Interfaces:

IdentityProvider, SignInPermissionsHandler, SignInProvider

public class GoogleSignInProvider
extends java.lang.Object
implements SignInProvider, SignInPermissionsHandler

Sign in Provider for Google.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COGNITO_LOGIN_KEY_GOOGLE The Cognito login key for Google+ to be used in the Cognito login Map.

Constructor Summary

Constructors

Constructor and Description
GoogleSignInProvider()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCognitoLoginKey()
java.lang.String	getDisplayName()
int	getPermissionRequestCode()
GoogleSignInAccount	getSignedInAccount() Get reference to the SignedIn Account.
java.lang.String	getToken() Call getToken to retrieve the access token from successful sign-in with this provider.
void	handleActivityResult(int requestCode, int resultCode, android.content.Intent data) Call handleActivityResult to handle the activity result.
void	handleRequestPermissionsResult(int requestCode, java.lang.String[] permissions, int[] grantResults) Handler for permissions results.
void	initialize(android.content.Context activityContext, AWSConfiguration awsConfig) Constructor.
android.view.View.OnClickListener	initializeSignInButton(android.app.Activity signInActivity, android.view.View buttonView, SignInProviderResultHandler providerResultsHandler) Initialize the sign-in button for the sign-in activity.
boolean	isRequestCodeOurs(int requestCode) Call isRequestCodeOurs to determine if this provider should handle an activity result.
java.lang.String	refreshToken() Refreshes the token if it has expired.
boolean	refreshUserSignInState() Refreshes the state of whether the user is signed-in and returns the updated state.
static void	setPermissions(java.lang.String... loginScopes) Add the login permisisons needed by the application.
void	signOut() Call signOut to sign out of this provider.

Methods inherited from class java.lang.Object

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

Field Detail

COGNITO_LOGIN_KEY_GOOGLE

public static final java.lang.String COGNITO_LOGIN_KEY_GOOGLE

The Cognito login key for Google+ to be used in the Cognito login Map.

See Also:

Constant Field Values

Constructor Detail

GoogleSignInProvider

public GoogleSignInProvider()

Method Detail

initialize

public void initialize(android.content.Context activityContext,
                       AWSConfiguration awsConfig)

Constructor. Builds the Google Api Client.

Specified by:

initialize in interface IdentityProvider

Parameters:

activityContext - context.

awsConfig - the AWS Configuration.

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface IdentityProvider

Returns:

the display name for this provider.

refreshUserSignInState

public boolean refreshUserSignInState()

Refreshes the state of whether the user is signed-in and returns the updated state. Note: This call may block, so it must not be called from the main thread.

Specified by:

refreshUserSignInState in interface IdentityProvider

Returns:

true if signed in with this provider, otherwise false.

setPermissions

public static void setPermissions(java.lang.String... loginScopes)

Add the login permisisons needed by the application. The input has to be a list of strings, where each string represents a permisison. Eg: GoogleSignInProvider.setPermissions(Scopes.EMAIL); GoogleSignInProvider.setPermissions(Scopes.EMAIL, Scopes.PROFILE);

Parameters:

loginScopes - The list of permissions required

getCognitoLoginKey

public java.lang.String getCognitoLoginKey()

Specified by:

getCognitoLoginKey in interface IdentityProvider

Returns:

the key used by Cognito in its login map when refreshing credentials.

getToken

public java.lang.String getToken()

Call getToken to retrieve the access token from successful sign-in with this provider. Note: This call may block if the access token is not already cached.

Specified by:

getToken in interface IdentityProvider

Returns:

the access token suitable for use with Cognito.

refreshToken

public java.lang.String refreshToken()

Refreshes the token if it has expired. Note: this call may block due to network access, and must be called from a background thread.

Specified by:

refreshToken in interface IdentityProvider

Returns:

the refreshed access token, or null if the token cannot be refreshed.

signOut

public void signOut()

Call signOut to sign out of this provider.

Specified by:

signOut in interface IdentityProvider

isRequestCodeOurs

public boolean isRequestCodeOurs(int requestCode)

Call isRequestCodeOurs to determine if this provider should handle an activity result.

Specified by:

isRequestCodeOurs in interface SignInProvider

Parameters:

requestCode - the requestCode from a previous call to onActivityResult.

Returns:

true if the request code is from this provider, otherwise false.

handleActivityResult

public void handleActivityResult(int requestCode,
                                 int resultCode,
                                 android.content.Intent data)

Call handleActivityResult to handle the activity result.

Specified by:

handleActivityResult in interface SignInProvider

Parameters:

requestCode - the request code.

resultCode - the result code.

data - the result intent.

initializeSignInButton

public android.view.View.OnClickListener initializeSignInButton(android.app.Activity signInActivity,
                                                                android.view.View buttonView,
                                                                SignInProviderResultHandler providerResultsHandler)

Initialize the sign-in button for the sign-in activity.

Specified by:

initializeSignInButton in interface SignInProvider

Parameters:

signInActivity - the activity for sign-in.

buttonView - the view for the sign-in button to initialize.

providerResultsHandler - the resultsHandler for provider sign-in.

Returns:

the onClickListener for the button to be able to override the listener, and null if the button cannot be initialized.

getSignedInAccount

public GoogleSignInAccount getSignedInAccount()

Get reference to the SignedIn Account.

Returns:

the Google SignIn Account

getPermissionRequestCode

public int getPermissionRequestCode()

Specified by:

getPermissionRequestCode in interface SignInPermissionsHandler

Returns:

the permission request code that will be used by this provider.

handleRequestPermissionsResult

public void handleRequestPermissionsResult(int requestCode,
                                           java.lang.String[] permissions,
                                           int[] grantResults)

Handler for permissions results.

Specified by:

handleRequestPermissionsResult in interface SignInPermissionsHandler

Parameters:

requestCode - the permissions request code

permissions - the permissions requested

grantResults - the results.