AWSMobileClient (AWS SDK for Android - AWS Mobile Client 2.16.13 API)

java.lang.Object
- com.amazonaws.mobile.client.AWSMobileClient

All Implemented Interfaces:: com.amazonaws.auth.AWSCredentialsProvider

public final class AWSMobileClient
extends Object
implements com.amazonaws.auth.AWSCredentialsProvider

The AWSMobileClient provides client APIs and building blocks for developers who want to create user authentication experiences. This includes declarative methods for performing authentication actions, a simple “drop-in auth” UI for performing common tasks, automatic token and credentials management, and state tracking with notifications for performing workflows in your application when users have authenticated. The following demonstrates a simple sample usage inside of MainActivity.java onCreate method.

 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     public void onResult(UserStateDetails userStateDetails) {
         switch (userStateDetails.getUserState()) {
             case SIGNED_IN:
                 break;
             case SIGNED_OUT:
                 try {
                     AWSMobileClient.getInstance().showSignIn(MainActivity.this);
                 } catch (Exception e) {
                     Log.e("TAG", "", e);
                 }
                 break;
             default:
                 Log.w("Unhandled state see UserState for a list of states");
                 break;
         }
     }
 })
 }

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`AWSMobileClient.InitializeBuilder` Deprecated. Since 2.8.0 This method will be removed in the next minor version. Please update to use AWSMobileClient using `initialize`. Please visit https://aws-amplify.github.io for the latest Android documentation.
`class`	`AWSMobileClient.SignInProviderConfig` Deprecated. Since 2.8.0 This method will be removed in the next minor version. Please update to use AWSMobileClient using `initialize`. Please visit https://aws-amplify.github.io for the latest Android documentation.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHALLENGE_RESPONSE_NEW_PASSWORD_KEY`
`static String`	`CHALLENGE_RESPONSE_USER_ATTRIBUTES_PREFIX_KEY`
`static String`	`HOSTED_UI_KEY`
`static String`	`USER_AGENT`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Runnable`	`_initialize(android.content.Context context, com.amazonaws.mobile.config.AWSConfiguration awsConfiguration, Callback<UserStateDetails> callback)`
`void`	`addUserStateListener(UserStateListener listener)` Adds a listener to be notified of state changes.
`void`	`changePassword(String oldPassword, String newPassword)`
`void`	`changePassword(String oldPassword, String newPassword, Callback<Void> callback)`
`ForgotPasswordResult`	`confirmForgotPassword(String password, Map<String,String> clientMetadata, String forgotPasswordChallengeResponse)` Second method to call after `forgotPassword(String)` to respond to any challenges that the service may request.
`ForgotPasswordResult`	`confirmForgotPassword(String password, String forgotPasswordChallengeResponse)` Second method to call after `forgotPassword(String)` to respond to any challenges that the service may request.
`void`	`confirmForgotPassword(String password, String forgotPasswordChallengeResponse, Callback<ForgotPasswordResult> callback)` Second method to call after `forgotPassword(String)` to respond to any challenges that the service may request.
`void`	`confirmForgotPassword(String password, String forgotPasswordChallengeResponse, Map<String,String> clientMetadata, Callback<ForgotPasswordResult> callback)` Second method to call after `forgotPassword(String)` to respond to any challenges that the service may request.
`SignInResult`	`confirmSignIn(Map<String,String> signInChallengeResponse)` The counter part to `signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>)`.
`void`	`confirmSignIn(Map<String,String> signInChallengeResponse, Callback<SignInResult> callback)` The counter part to `signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>)`.
`SignInResult`	`confirmSignIn(Map<String,String> signInChallengeResponse, Map<String,String> clientMetaData)` The counter part to `signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>)`.
`void`	`confirmSignIn(Map<String,String> signInChallengeResponse, Map<String,String> clientMetaData, Callback<SignInResult> callback)` The counter part to `signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>)`.
`SignInResult`	`confirmSignIn(String signInChallengeResponse)`
`void`	`confirmSignIn(String signInChallengeResponse, Callback<SignInResult> callback)`
`SignUpResult`	`confirmSignUp(String username, String signUpChallengeResponse)` Confirm the sign-up request with follow-up information
`void`	`confirmSignUp(String username, String signUpChallengeResponse, Callback<SignUpResult> callback)` Confirm the sign-up request with follow-up information
`SignUpResult`	`confirmSignUp(String username, String signUpChallengeResponse, Map<String,String> clientMetadata)` Confirm the sign-up request with follow-up information
`void`	`confirmSignUp(String username, String signUpChallengeResponse, Map<String,String> clientMetadata, Callback<SignUpResult> callback)` Confirm the sign-up request with follow-up information
`void`	`confirmUpdateUserAttribute(String attributeName, String updateUserAttributeChallengeResponse)` Confirm the attribute with the code provided by user.
`void`	`confirmUpdateUserAttribute(String attributeName, String updateUserAttributeChallengeResponse, Callback<Void> callback)` Confirm the attribute with the code provided by user.
`void`	`confirmVerifyUserAttribute(String attributeName, String updateUserAttributeChallengeResponse)` Confirm the attribute with the code provided by user.
`void`	`confirmVerifyUserAttribute(String attributeName, String updateUserAttributeChallengeResponse, Callback<Void> callback)` Confirm the attribute with the code provided by user.
`UserStateDetails`	`currentUserState()` Performs a check on the current UserState.
`void`	`currentUserState(Callback<UserStateDetails> callback)` Performs a check on the current UserState.
`UserStateDetails`	`federatedSignIn(String providerKey, String token)` Federate tokens from custom identity providers into Cognito Identity Pool by providing the logins key and token
`void`	`federatedSignIn(String providerKey, String token, Callback<UserStateDetails> callback)` Federate tokens from custom identity providers into Cognito Identity Pool by providing the logins key and token
`UserStateDetails`	`federatedSignIn(String providerKey, String token, FederatedSignInOptions options)` Federate tokens from custom identity providers by providing the logins key and token
`void`	`federatedSignIn(String providerKey, String token, FederatedSignInOptions options, Callback<UserStateDetails> callback)` Federate tokens from custom identity providers by providing the logins key and token
`protected void`	`federatedSignInWithoutAssigningState(String providerKey, String token)`
`protected void`	`federatedSignInWithoutAssigningState(String providerKey, String token, Callback<UserStateDetails> callback)`
`protected void`	`federateWithCognitoIdentity(String providerKey, String token)`
`ForgotPasswordResult`	`forgotPassword(String username)` Used to reset password if user forgot the old password.
`void`	`forgotPassword(String username, Callback<ForgotPasswordResult> callback)` Used to reset password if user forgot the old password.
`ForgotPasswordResult`	`forgotPassword(String username, Map<String,String> clientMetadata)` Used to reset password if user forgot the old password.
`void`	`forgotPassword(String username, Map<String,String> clientMetadata, Callback<ForgotPasswordResult> callback)` Used to reset password if user forgot the old password.
`com.amazonaws.auth.AWSCredentials`	`getAWSCredentials()` Returns AWSCredentials obtained from Cognito Identity
`void`	`getAWSCredentials(Callback<com.amazonaws.auth.AWSCredentials> callback)`
`com.amazonaws.mobile.config.AWSConfigurable`	`getClient(android.content.Context context, Class<? extends com.amazonaws.mobile.config.AWSConfigurable> clientClass)` Get the AWSConfigurable client if exists, else create one and add it to the clientMap and return.
`com.amazonaws.mobile.config.AWSConfiguration`	`getConfiguration()` Retrieve the AWSConfiguration object that represents the awsconfiguration.json file.
`com.amazonaws.auth.AWSCredentials`	`getCredentials()`
`DeviceOperations`	`getDeviceOperations()` Retrieve a handle to perform device related operations.
`String`	`getIdentityId()`
`static AWSMobileClient`	`getInstance()` Gets the singleton instance of this class.
`Tokens`	`getTokens()` Returns the tokens obtained from Cognito Userpools sign-in.
`protected Tokens`	`getTokens(boolean waitForSignIn)`
`void`	`getTokens(Callback<Tokens> callback)` Returns the tokens obtained from Cognito Userpools sign-in.
`Map<String,String>`	`getUserAttributes()`
`void`	`getUserAttributes(Callback<Map<String,String>> callback)`
`String`	`getUsername()` Returns the signed-in user's username obtained from the access token.
`protected UserStateDetails`	`getUserStateDetails(boolean offlineCheck)` Has side-effect of attempting to alert developer to try and sign-in user when required to be signed-in and will mutate the user's state.
`boolean`	`handleAuthResponse(android.content.Intent intent)` Pass in the Intent from the OAuth 2.0 exchange from `showSignIn(Activity)`
`void`	`initialize(android.content.Context context, com.amazonaws.mobile.config.AWSConfiguration awsConfig, Callback<UserStateDetails> callback)`
`void`	`initialize(android.content.Context context, Callback<UserStateDetails> callback)`
`protected boolean`	`isNetworkAvailable(android.content.Context context)` Uses Android system commands to determine if the device is online.
`boolean`	`isSignedIn()` A variant of `currentUserState()` that simplifies the output to a boolean.
`void`	`refresh()`
`void`	`releaseSignInWait()` Release the wait for tokens to be refreshed Doing this fails all pending operations that were waiting for sign-in.
`boolean`	`removeUserStateListener(UserStateListener listener)` Removes a listener.
`SignUpResult`	`resendSignUp(String username)` Used when a user has attempted sign-up previously and wants to continue the process.
`void`	`resendSignUp(String username, Callback<SignUpResult> callback)` Used when a user has attempted sign-up previously and wants to continue the process.
`protected void`	`setUserState(UserStateDetails details)`
`UserStateDetails`	`showSignIn(android.app.Activity callingActivity)` Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account
`void`	`showSignIn(android.app.Activity callingActivity, Callback<UserStateDetails> callback)` Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account
`UserStateDetails`	`showSignIn(android.app.Activity callingActivity, SignInUIOptions signInUIOptions)` Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account
`void`	`showSignIn(android.app.Activity callingActivity, SignInUIOptions signInUIOptions, Callback<UserStateDetails> callback)` Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account
`SignInResult`	`signIn(String username, String password, Map<String,String> validationData)`
`void`	`signIn(String username, String password, Map<String,String> validationData, Callback<SignInResult> callback)`
`void`	`signOut()` Clears local tokens so that the client is in a signed-out state.
`void`	`signOut(SignOutOptions signOutOptions)` Sign-out the user with more options.
`void`	`signOut(SignOutOptions signOutOptions, Callback<Void> callback)` Sign-out the user with more options.
`SignUpResult`	`signUp(String username, String password, Map<String,String> userAttributes, Map<String,String> validationData)` Sign-up users.
`void`	`signUp(String username, String password, Map<String,String> userAttributes, Map<String,String> validationData, Callback<SignUpResult> callback)` Sign-up users.
`SignUpResult`	`signUp(String username, String password, Map<String,String> userAttributes, Map<String,String> clientMetadata, Map<String,String> validationData)` Sign-up users.
`void`	`signUp(String username, String password, Map<String,String> userAttributes, Map<String,String> validationData, Map<String,String> clientMetadata, Callback<SignUpResult> callback)` Sign-up users.
`List<UserCodeDeliveryDetails>`	`updateUserAttributes(Map<String,String> userAttributes)` Sends a map of user attributes to update.
`void`	`updateUserAttributes(Map<String,String> userAttributes, Callback<List<UserCodeDeliveryDetails>> callback)` Sends a map of user attributes to update.
`UserCodeDeliveryDetails`	`verifyUserAttribute(String attributeName)` Verify an attribute like email.
`void`	`verifyUserAttribute(String attributeName, Callback<UserCodeDeliveryDetails> callback)` Verify an attribute like email.
`protected boolean`	`waitForSignIn()` This method checks the current state of the user.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- USER_AGENT
```
public static final String USER_AGENT
```
  See Also:
  
  Constant Field Values
- HOSTED_UI_KEY
```
public static final String HOSTED_UI_KEY
```
  See Also:
  
  Constant Field Values
- CHALLENGE_RESPONSE_NEW_PASSWORD_KEY
```
public static final String CHALLENGE_RESPONSE_NEW_PASSWORD_KEY
```
  See Also:
  
  Constant Field Values
- CHALLENGE_RESPONSE_USER_ATTRIBUTES_PREFIX_KEY
```
public static final String CHALLENGE_RESPONSE_USER_ATTRIBUTES_PREFIX_KEY
```
  See Also:
  
  Constant Field Values

Method Detail

getInstance
```
public static AWSMobileClient getInstance()
```
Gets the singleton instance of this class.

Returns:

singleton instance

getConfiguration
```
public com.amazonaws.mobile.config.AWSConfiguration getConfiguration()
```
Retrieve the AWSConfiguration object that represents the awsconfiguration.json file.

Returns:

the AWSConfiguration object

getCredentials
```
public com.amazonaws.auth.AWSCredentials getCredentials()
```
Specified by:

getCredentials in interface com.amazonaws.auth.AWSCredentialsProvider

refresh
```
public void refresh()
```
Specified by:

refresh in interface com.amazonaws.auth.AWSCredentialsProvider

getAWSCredentials

@WorkerThread
public com.amazonaws.auth.AWSCredentials getAWSCredentials()
                                                                  throws Exception

Returns AWSCredentials obtained from Cognito Identity

Returns:: AWSCredentials obtained from Cognito Identity
Throws:: Exception

getAWSCredentials

@AnyThread
public void getAWSCredentials(Callback<com.amazonaws.auth.AWSCredentials> callback)

getIdentityId

@AnyThread
public String getIdentityId()

initialize

@AnyThread
public void initialize(android.content.Context context,
                                  Callback<UserStateDetails> callback)

initialize

@AnyThread
public void initialize(android.content.Context context,
                                  com.amazonaws.mobile.config.AWSConfiguration awsConfig,
                                  Callback<UserStateDetails> callback)

_initialize

protected Runnable _initialize(android.content.Context context,
                               com.amazonaws.mobile.config.AWSConfiguration awsConfiguration,
                               Callback<UserStateDetails> callback)

getDeviceOperations
```
@AnyThread
public DeviceOperations getDeviceOperations()
```
Retrieve a handle to perform device related operations. This is only available for Cognito User Pools and it must be configured in the client.

Returns:

a handle for device operations

releaseSignInWait
```
@AnyThread
public void releaseSignInWait()
```
Release the wait for tokens to be refreshed Doing this fails all pending operations that were waiting for sign-in.

setUserState

protected void setUserState(UserStateDetails details)

isNetworkAvailable
```
protected boolean isNetworkAvailable(android.content.Context context)
```
Uses Android system commands to determine if the device is online. Requires ACCESS_NETWORK_STATE.

Parameters:

context - application context

Returns:

true if permission to access network state is granted and network is connected.

getUsername
```
@AnyThread
public String getUsername()
```
Returns the signed-in user's username obtained from the access token.

Returns:

signed-in user's username

currentUserState
```
@WorkerThread
public UserStateDetails currentUserState()
```
Performs a check on the current UserState. When online, this method will attempt to refresh tokens when they expired. Failing a refresh may cause the UserState to change.

Returns:

details about the user's state

currentUserState
```
@AnyThread
public void currentUserState(Callback<UserStateDetails> callback)
```
Performs a check on the current UserState. When online, this method will attempt to refresh tokens when they expired. Failing a refresh may cause the UserState to change.

addUserStateListener
```
@AnyThread
public void addUserStateListener(UserStateListener listener)
```
Adds a listener to be notified of state changes. When encountering SIGNED_OUT_FEDERATED_TOKENS_INVALID or SIGNED_OUT_USER_POOLS_TOKENS_INVALID releaseSignInWait() or any form of sign-in can be called to prevent blocking getCredentials(), getTokens(), or other methods requiring a sign-in.

Parameters:

listener -

removeUserStateListener
```
@AnyThread
public boolean removeUserStateListener(UserStateListener listener)
```
Removes a listener. This will hold onto references. Remove when a lifecycle ends to prevent memory leaks.

Parameters:

listener -

Returns:

true if removed

isSignedIn
```
@AnyThread
public boolean isSignedIn()
```
A variant of currentUserState() that simplifies the output to a boolean. True if SIGNED_IN, SIGNED_OUT_USER_POOLS_TOKENS_INVALID, SIGNED_OUT_FEDERATED_TOKENS_INVALID. False if GUEST, SIGNED_OUT.

Returns:

see above

waitForSignIn
```
protected boolean waitForSignIn()
```
This method checks the current state of the user. If the user's session is determined to be expired, then the UserStateListener will be notified with @UserState.SIGNED_OUT_USER_POOLS_TOKENS_INVALID or

Returns:

true if user is signed-in, false otherwise

getUserStateDetails
```
protected UserStateDetails getUserStateDetails(boolean offlineCheck)
```
Has side-effect of attempting to alert developer to try and sign-in user when required to be signed-in and will mutate the user's state.

Parameters:

offlineCheck - true, will determine if the tokens are expired or the credentials are expired and block for refresh

Returns:

the current state of the user

signIn

@AnyThread
public void signIn(String username,
                              String password,
                              Map<String,String> validationData,
                              Callback<SignInResult> callback)

signIn

@WorkerThread
public SignInResult signIn(String username,
                                         String password,
                                         Map<String,String> validationData)
                                  throws Exception

Throws:: Exception

confirmSignIn

@AnyThread
public void confirmSignIn(String signInChallengeResponse,
                                     Callback<SignInResult> callback)

confirmSignIn

@WorkerThread
public SignInResult confirmSignIn(String signInChallengeResponse)
                                         throws Exception

Throws:: Exception

confirmSignIn
```
@AnyThread
public void confirmSignIn(Map<String,String> signInChallengeResponse,
                                     Map<String,String> clientMetaData,
                                     Callback<SignInResult> callback)
```
The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>). Call with the user's response to the sign-in challenge.

Parameters:

signInChallengeResponse - obtained from user

clientMetaData - Meta data for lambda triggers

callback - callback

confirmSignIn
```
@WorkerThread
public SignInResult confirmSignIn(Map<String,String> signInChallengeResponse,
                                                Map<String,String> clientMetaData)
                                         throws Exception
```
The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>). Call with the user's response to the sign-in challenge.

Parameters:

signInChallengeResponse - obtained from user

clientMetaData - Meta data for lambda triggers

Returns:

the result containing next steps or done.

Throws:

Exception

confirmSignIn
```
@AnyThread
public void confirmSignIn(Map<String,String> signInChallengeResponse,
                                     Callback<SignInResult> callback)
```
The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>). Call with the user's response to the sign-in challenge.

Parameters:

signInChallengeResponse - obtained from user

callback - callback

confirmSignIn
```
@WorkerThread
public SignInResult confirmSignIn(Map<String,String> signInChallengeResponse)
                                         throws Exception
```
The counter part to signIn(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>, com.amazonaws.mobile.client.Callback<com.amazonaws.mobile.client.results.SignInResult>). Call with the user's response to the sign-in challenge.

Parameters:

signInChallengeResponse - obtained from user

Returns:

the result containing next steps or done.

Throws:

Exception

signOut
```
@AnyThread
public void signOut()
```
Clears local tokens so that the client is in a signed-out state.

signOut

@WorkerThread
public void signOut(SignOutOptions signOutOptions)
                           throws Exception

Sign-out the user with more options.

 
 SignOutOptions.builder()
                  .signOutGlobally(true) // Sign-out user from all sessions across devices
                  .build();

Parameters:: signOutOptions - options
Throws:: Exception

signOut

@AnyThread
public void signOut(SignOutOptions signOutOptions,
                               Callback<Void> callback)

Sign-out the user with more options.

 
 SignOutOptions.builder()
                  .signOutGlobally(true) // Sign-out user from all sessions across devices
                  .build();

Parameters:: signOutOptions - options

federatedSignIn
```
@AnyThread
public void federatedSignIn(String providerKey,
                                       String token,
                                       Callback<UserStateDetails> callback)
```
Federate tokens from custom identity providers into Cognito Identity Pool by providing the logins key and token
The logins key can be specified with IdentityProvider#AMAZON#toString()

Parameters:

providerKey - Custom provider key i.e. Google sign-in's key is accounts.google.com

token - the JWT token vended by the third-party

federatedSignIn
```
@WorkerThread
public UserStateDetails federatedSignIn(String providerKey,
                                                      String token)
                                               throws Exception
```
Federate tokens from custom identity providers into Cognito Identity Pool by providing the logins key and token
The logins key can be specified with IdentityProvider.AMAZON

Parameters:

providerKey - Custom provider key i.e. Google sign-in's key is accounts.google.com

token - the JWT token vended by the third-party

Throws:

Exception

federatedSignIn

@AnyThread
public void federatedSignIn(String providerKey,
                                       String token,
                                       FederatedSignInOptions options,
                                       Callback<UserStateDetails> callback)

Federate tokens from custom identity providers by providing the logins key and token

The logins key can be specified with IdentityProvider#AMAZON#toString()

Parameters:: providerKey - Custom provider key i.e. Google sign-in's key is accounts.google.com; token - the JWT token vended by the third-party

federatedSignIn

@WorkerThread
public UserStateDetails federatedSignIn(String providerKey,
                                                      String token,
                                                      FederatedSignInOptions options)
                                               throws Exception

Federate tokens from custom identity providers by providing the logins key and token

The logins key can be specified with IdentityProvider.AMAZON

Parameters:: providerKey - Custom provider key i.e. Google sign-in's key is accounts.google.com; token - the JWT token vended by the third-party
Throws:: Exception

federatedSignInWithoutAssigningState

protected void federatedSignInWithoutAssigningState(String providerKey,
                                                    String token)
                                             throws Exception

Throws:: Exception

federatedSignInWithoutAssigningState

protected void federatedSignInWithoutAssigningState(String providerKey,
                                                    String token,
                                                    Callback<UserStateDetails> callback)

federateWithCognitoIdentity

protected void federateWithCognitoIdentity(String providerKey,
                                           String token)

getTokens
```
@WorkerThread
public Tokens getTokens()
                               throws Exception
```
Returns the tokens obtained from Cognito Userpools sign-in. Federated sign-in tokens are not supported.

Returns:

tokens from Cognito Userpools

Throws:

Exception - when the tokens cannot be retrieved successfully.

getTokens
```
@AnyThread
public void getTokens(Callback<Tokens> callback)
```
Returns the tokens obtained from Cognito Userpools sign-in. Federated sign-in tokens are not supported.

Throws:

Exception - when the tokens cannot be retrieved successfully.

getTokens

protected Tokens getTokens(boolean waitForSignIn)
                    throws Exception

Throws:: Exception

signUp
```
@AnyThread
public void signUp(String username,
                              String password,
                              Map<String,String> userAttributes,
                              Map<String,String> validationData,
                              Map<String,String> clientMetadata,
                              Callback<SignUpResult> callback)
```
Sign-up users. The SignUpResult will contain next steps if necessary. Call confirmSignUp(String, String, Callback) with the necessary next step code obtained from user.

Parameters:

username - username/email address/handle

password - user's password

userAttributes - attributes associated with user

validationData - optional, set of data to validate the sign-up request

clientMetadata - meta data to be passed to the lambdas invoked by sign up operation.

callback - callback will be invoked to notify the success or failure of the SignUp operation

signUp

@WorkerThread
public SignUpResult signUp(String username,
                                         String password,
                                         Map<String,String> userAttributes,
                                         Map<String,String> clientMetadata,
                                         Map<String,String> validationData)
                                  throws Exception

Sign-up users. The SignUpResult will contain next steps if necessary. Call confirmSignUp(String, String) with the necessary next step code obtained from user.

Parameters:: username - username/email address/handle; password - user's password; userAttributes - attributes associated with user; validationData - optional, set of data to validate the sign-up request; clientMetadata - meta data to be passed to the lambdas invoked by sign up operation.
Returns:: result of the operation, potentially with next steps
Throws:: Exception - if there is any error generated by the client

signUp
```
@AnyThread
public void signUp(String username,
                              String password,
                              Map<String,String> userAttributes,
                              Map<String,String> validationData,
                              Callback<SignUpResult> callback)
```
Sign-up users. The SignUpResult will contain next steps if necessary. Call confirmSignUp(String, String, Callback) with the necessary next step code obtained from user.

Parameters:

username - username/email address/handle

password - user's password

userAttributes - attributes associated with user

validationData - optional, set of data to validate the sign-up request

callback - callback will be invoked to notify the success or failure of the SignUp operation

signUp
```
@WorkerThread
public SignUpResult signUp(String username,
                                         String password,
                                         Map<String,String> userAttributes,
                                         Map<String,String> validationData)
                                  throws Exception
```
Sign-up users. The SignUpResult will contain next steps if necessary. Call confirmSignUp(String, String) with the necessary next step code obtained from user.

Parameters:

username - username/email address/handle

password - user's password

userAttributes - attributes associated with user

validationData - optional, set of data to validate the sign-up request

Returns:

result of the operation, potentially with next steps

Throws:

Exception - if there is any error generated by the client

confirmSignUp
```
@AnyThread
public void confirmSignUp(String username,
                                     String signUpChallengeResponse,
                                     Map<String,String> clientMetadata,
                                     Callback<SignUpResult> callback)
```
Confirm the sign-up request with follow-up information

Parameters:

username - username/email address/handle of the user who is signing up

signUpChallengeResponse - response to the signUp challenge posted

clientMetadata - meta data to be passed to the lambdas invoked by confirm sign up operation.

callback - the callback will be invoked to notify the success or failure of the confirmSignUp operation

confirmSignUp

@WorkerThread
public SignUpResult confirmSignUp(String username,
                                                String signUpChallengeResponse,
                                                Map<String,String> clientMetadata)
                                         throws Exception

Confirm the sign-up request with follow-up information

Parameters:: username - username of the user who is signing up; signUpChallengeResponse - response to the signUp challenge posted; clientMetadata - meta data to be passed to the lambdas invoked by confirm sign up operation.
Throws:: Exception

confirmSignUp
```
@AnyThread
public void confirmSignUp(String username,
                                     String signUpChallengeResponse,
                                     Callback<SignUpResult> callback)
```
Confirm the sign-up request with follow-up information

Parameters:

username - username/email address/handle of the user who is signing up

signUpChallengeResponse - response to the signUp challenge posted

callback - the callback will be invoked to notify the success or failure of the confirmSignUp operation

confirmSignUp

@WorkerThread
public SignUpResult confirmSignUp(String username,
                                                String signUpChallengeResponse)
                                         throws Exception

Confirm the sign-up request with follow-up information

Parameters:: username - username of the user who is signing up; signUpChallengeResponse - response to the signUp challenge posted
Throws:: Exception

resendSignUp
```
@AnyThread
public void resendSignUp(String username,
                                    Callback<SignUpResult> callback)
```
Used when a user has attempted sign-up previously and wants to continue the process. Note: If the user tries through the normal process with the same username, then it will fail and this method is required.

Parameters:

username -

callback -

resendSignUp
```
@WorkerThread
public SignUpResult resendSignUp(String username)
                                        throws Exception
```
Used when a user has attempted sign-up previously and wants to continue the process. Note: If the user tries through the normal process with the same username, then it will fail and this method is required.

Parameters:

username -

Throws:

Exception

forgotPassword
```
@AnyThread
public void forgotPassword(String username,
                                      Map<String,String> clientMetadata,
                                      Callback<ForgotPasswordResult> callback)
```
Used to reset password if user forgot the old password.

Parameters:

username - username of the user trying to reset password.

clientMetadata - meta data to be passed to the lambdas invoked by confirm sign up operation.

callback - callback will be invoked to notify the success or failure of the forgot password operation

forgotPassword

@WorkerThread
public ForgotPasswordResult forgotPassword(String username,
                                                         Map<String,String> clientMetadata)
                                                  throws Exception

Used to reset password if user forgot the old password.

Parameters:: username - username of the user trying to reset password.
Throws:: Exception

forgotPassword
```
@AnyThread
public void forgotPassword(String username,
                                      Callback<ForgotPasswordResult> callback)
```
Used to reset password if user forgot the old password.

Parameters:

username - username of the user trying to reset password.

callback - callback will be invoked to notify the success or failure of the forgot password operation

forgotPassword
```
@WorkerThread
public ForgotPasswordResult forgotPassword(String username)
                                                  throws Exception
```
Used to reset password if user forgot the old password.

Parameters:

username - username of the user trying to reset password.

Throws:

Exception

confirmForgotPassword

@AnyThread
public void confirmForgotPassword(String password,
                                             String forgotPasswordChallengeResponse,
                                             Map<String,String> clientMetadata,
                                             Callback<ForgotPasswordResult> callback)

Second method to call after forgotPassword(String) to respond to any challenges that the service may request.

Parameters:: password - new password; forgotPasswordChallengeResponse - response to the forgot password challenge posted; clientMetadata - metadata to be passed to the lambda invoked by this operation.; callback - callback will be invoked to notify the success or failure of the confirm forgot password operation

confirmForgotPassword

@WorkerThread
public ForgotPasswordResult confirmForgotPassword(String password,
                                                                Map<String,String> clientMetadata,
                                                                String forgotPasswordChallengeResponse)
                                                         throws Exception

Second method to call after forgotPassword(String) to respond to any challenges that the service may request.

Parameters:: password - new password.; clientMetadata - metadata to be passed to the lambda invoked by this operation.; forgotPasswordChallengeResponse - response to the forgot password challenge posted.
Throws:: Exception

confirmForgotPassword
```
@AnyThread
public void confirmForgotPassword(String password,
                                             String forgotPasswordChallengeResponse,
                                             Callback<ForgotPasswordResult> callback)
```
Second method to call after forgotPassword(String) to respond to any challenges that the service may request.

Parameters:

password - new password.

forgotPasswordChallengeResponse - response to the forgot password challenge posted.

callback - callback will be invoked to notify the success or failure of the confirm forgot password operation

confirmForgotPassword

@WorkerThread
public ForgotPasswordResult confirmForgotPassword(String password,
                                                                String forgotPasswordChallengeResponse)
                                                         throws Exception

Second method to call after forgotPassword(String) to respond to any challenges that the service may request.

Parameters:: password - new password.; forgotPasswordChallengeResponse - response to the forgot password challenge posted.
Throws:: Exception

changePassword

@AnyThread
public void changePassword(String oldPassword,
                                      String newPassword,
                                      Callback<Void> callback)

changePassword

@WorkerThread
public void changePassword(String oldPassword,
                                         String newPassword)
                                  throws Exception

Throws:: Exception

getUserAttributes

@AnyThread
public void getUserAttributes(Callback<Map<String,String>> callback)

getUserAttributes

@WorkerThread
public Map<String,String> getUserAttributes()
                                                   throws Exception

Throws:: Exception

updateUserAttributes
```
@AnyThread
public void updateUserAttributes(Map<String,String> userAttributes,
                                            Callback<List<UserCodeDeliveryDetails>> callback)
```
Sends a map of user attributes to update. If an attribute needs to be verified, then the verification delivery information is returned.

Parameters:

userAttributes - the attributes i.e. email

callback - verification delivery information

updateUserAttributes
```
@WorkerThread
public List<UserCodeDeliveryDetails> updateUserAttributes(Map<String,String> userAttributes)
                                                                 throws Exception
```
Sends a map of user attributes to update. If an attribute needs to be verified, then the verification delivery information is returned.

Parameters:

userAttributes - the attributes i.e. email

Returns:

verification delivery information

Throws:

Exception

verifyUserAttribute

@AnyThread
public void verifyUserAttribute(String attributeName,
                                           Callback<UserCodeDeliveryDetails> callback)

Verify an attribute like email.

Parameters:: attributeName - i.e. email; callback - verification delivery information

verifyUserAttribute

@WorkerThread
public UserCodeDeliveryDetails verifyUserAttribute(String attributeName)
                                                          throws Exception

Verify an attribute like email.

Parameters:: attributeName - i.e. email
Returns:: verification delivery information
Throws:: Exception

confirmUpdateUserAttribute

@AnyThread
public void confirmUpdateUserAttribute(String attributeName,
                                                  String updateUserAttributeChallengeResponse,
                                                  Callback<Void> callback)

Confirm the attribute with the code provided by user.

Parameters:: attributeName - i.e. email; updateUserAttributeChallengeResponse - i.e. 123456; callback - callback

confirmUpdateUserAttribute

@WorkerThread
public void confirmUpdateUserAttribute(String attributeName,
                                                     String updateUserAttributeChallengeResponse)
                                              throws Exception

Confirm the attribute with the code provided by user.

Parameters:: attributeName - i.e. email; updateUserAttributeChallengeResponse - i.e. 123456
Throws:: Exception

confirmVerifyUserAttribute

@AnyThread
public void confirmVerifyUserAttribute(String attributeName,
                                                  String updateUserAttributeChallengeResponse,
                                                  Callback<Void> callback)

Confirm the attribute with the code provided by user.

Parameters:: attributeName - i.e. email; updateUserAttributeChallengeResponse - i.e. 123456; callback - callback

confirmVerifyUserAttribute

@WorkerThread
public void confirmVerifyUserAttribute(String attributeName,
                                                     String updateUserAttributeChallengeResponse)
                                              throws Exception

Confirm the attribute with the code provided by user.

Parameters:: attributeName - i.e. email; updateUserAttributeChallengeResponse - i.e. 123456
Throws:: Exception

handleAuthResponse
```
@AnyThread
public boolean handleAuthResponse(android.content.Intent intent)
```
Pass in the Intent from the OAuth 2.0 exchange from showSignIn(Activity)

Parameters:

intent -

Returns:

true if the intent was accepted.

showSignIn
```
@AnyThread
public void showSignIn(android.app.Activity callingActivity,
                                  Callback<UserStateDetails> callback)
```
Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account

Parameters:

callingActivity - The activity that the sign-in screen will be shown on top of.

callback - callback with UserStateDetails at end of operation

showSignIn
```
@WorkerThread
public UserStateDetails showSignIn(android.app.Activity callingActivity)
                                          throws Exception
```
Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account

Parameters:

callingActivity - The activity that the sign-in screen will be shown on top of.

Throws:

Exception

showSignIn
```
@AnyThread
public void showSignIn(android.app.Activity callingActivity,
                                  SignInUIOptions signInUIOptions,
                                  Callback<UserStateDetails> callback)
```
Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account

Parameters:

callingActivity - The activity that the sign-in screen will be shown on top of.

signInUIOptions - Override any default configuration with your preferences.

callback - callback with UserStateDetails at end of operation

showSignIn

@WorkerThread
public UserStateDetails showSignIn(android.app.Activity callingActivity,
                                                 SignInUIOptions signInUIOptions)
                                          throws Exception

Shows a sign-in UI for user's to sign-in, sign-up, forgot password, create account

Parameters:: callingActivity - The activity that the sign-in screen will be shown on top of.; signInUIOptions - Override any default configuration with your preferences.
Throws:: Exception

getClient

public com.amazonaws.mobile.config.AWSConfigurable getClient(android.content.Context context,
                                                             Class<? extends com.amazonaws.mobile.config.AWSConfigurable> clientClass)

Get the AWSConfigurable client if exists, else create one and add it to the clientMap and return.

Parameters:: context - The activity context; clientClass - SDK Client Class that confirms to the AWSConfigurable interface.

Class AWSMobileClient

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_AGENT

HOSTED_UI_KEY

CHALLENGE_RESPONSE_NEW_PASSWORD_KEY

CHALLENGE_RESPONSE_USER_ATTRIBUTES_PREFIX_KEY

Method Detail

getInstance

getConfiguration

getCredentials

refresh

getAWSCredentials

getAWSCredentials

getIdentityId

initialize

initialize

_initialize

getDeviceOperations

releaseSignInWait

setUserState

isNetworkAvailable

getUsername

currentUserState

currentUserState

addUserStateListener

removeUserStateListener

isSignedIn

waitForSignIn

getUserStateDetails

signIn

signIn

confirmSignIn

confirmSignIn

confirmSignIn

confirmSignIn

confirmSignIn

confirmSignIn

signOut

signOut

signOut

federatedSignIn

federatedSignIn

federatedSignIn

federatedSignIn

federatedSignInWithoutAssigningState

federatedSignInWithoutAssigningState

federateWithCognitoIdentity

getTokens

getTokens

getTokens

signUp

signUp

signUp

signUp

confirmSignUp

confirmSignUp

confirmSignUp

confirmSignUp

resendSignUp

resendSignUp

forgotPassword

forgotPassword

forgotPassword

forgotPassword

confirmForgotPassword

confirmForgotPassword

confirmForgotPassword

confirmForgotPassword

changePassword

changePassword

getUserAttributes

getUserAttributes

updateUserAttributes

updateUserAttributes

verifyUserAttribute

verifyUserAttribute