com.amazonaws.mobile.auth.core

Interface IdentityProvider

All Known Subinterfaces:

SignInProvider

All Known Implementing Classes:

CognitoUserPoolsSignInProvider, FacebookSignInProvider, GoogleSignInProvider

public interface IdentityProvider

Interface sign-in provider's supported by the IdentityManager must implement.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCognitoLoginKey()
java.lang.String	getDisplayName()
java.lang.String	getToken() Call getToken to retrieve the access token from successful sign-in with this provider.
void	initialize(android.content.Context context, AWSConfiguration configuration) Method called upon constructing an identity provider for it to handle its initialization.
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.
void	signOut() Call signOut to sign out of this provider.

Method Detail

initialize

void initialize(android.content.Context context,
                AWSConfiguration configuration)

Method called upon constructing an identity provider for it to handle its initialization.

Parameters:

context - the context.

configuration - the configuration.

getDisplayName

java.lang.String getDisplayName()

Returns:

the display name for this provider.

getCognitoLoginKey

java.lang.String getCognitoLoginKey()

Returns:

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

refreshUserSignInState

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.

Returns:

true if signed in with this provider, otherwise false.

getToken

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.

Returns:

the access token suitable for use with Cognito.

refreshToken

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.

Returns:

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

signOut

void signOut()

Call signOut to sign out of this provider.