CognitoUser (AWS SDK for Android - Amazon Cognito Identity Provider 2.4.4 API)

java.lang.Object
- com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUser

```
public class CognitoUser
extends Object
```
Represents a single Cognito User.
This class encapsulates all operations possible on a user and all tokens belonging to the user. The user tokens, as CognitoUserSession, are stored in SharedPreferences. Only the tokens belonging to the last successfully authenticated user are stored.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`CognitoUser(CognitoUserPool pool, String userId, String clientId, String clientSecret, String secretHash, AmazonCognitoIdentityProvider client, android.content.Context context)` Constructs a new Cognito User from a Cognito user identity pool `CognitoUserPool` and userId.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changePassword(String oldUserPassword, String newUserPassword, GenericHandler callback)` Request to change password for this user, in current thread.
`void`	`changePasswordInBackground(String oldUserPassword, String newUserPassword, GenericHandler callback)` Request to change password for this user, in background.
`void`	`confirmPassword(String verificationCode, String newPassword, ForgotPasswordHandler callback)` Sends the new password and the verification code to Cognito Identity Provider service, in background.
`void`	`confirmPasswordInBackground(String verificationCode, String newPassword, ForgotPasswordHandler callback)` Set new password and send verification code to Cognito Identity Provider service, in background.
`void`	`confirmSignUp(String confirmationCode, boolean forcedAliasCreation, GenericHandler callback)` Confirms user registration in current thread.
`void`	`confirmSignUpInBackground(String confirmationCode, boolean forcedAliasCreation, GenericHandler callback)` Confirms user registration in background.
`void`	`deleteAttributes(List<String> attributeNamesToDelete, GenericHandler callback)` Deletes user attributes, in current thread.
`void`	`deleteAttributesInBackground(List<String> attributeNamesToDelete, GenericHandler callback)` Deletes user attributes, in background.
`void`	`deleteUser(GenericHandler callback)` Deletes this user, in current thread.
`void`	`deleteUserInBackground(GenericHandler callback)` Deletes this user, in background.
`RespondToAuthChallengeRequest`	`deviceSrpAuthRequest(RespondToAuthChallengeResult challenge, String deviceSecret, String deviceGroupKey, com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUser.AuthenticationHelper authenticationHelper)` Creates request for device SRP verification.
`void`	`forgotPassword(ForgotPasswordHandler callback)` Starts the process to set a new new password for forgotten password case, in current thread.
`void`	`forgotPasswordInBackground(ForgotPasswordHandler callback)` Starts the process to set a new password for forgotten password case, in background.
`void`	`getAttributeVerificationCode(String attributeName, VerificationHandler callback)` Requests code to verify a user attribute, in current thread.
`void`	`getAttributeVerificationCodeInBackground(String attributeName, VerificationHandler callback)` Requests code to verify a user attribute, in background.
`protected CognitoUserSession`	`getCachedSession()` Call this method for valid, cached tokens for this user.
`protected AmazonCognitoIdentityProvider`	`getCognitoIdentityProviderClient()` Method low-level client for Amazon Cognito Identity Provider.
`void`	`getDetails(GetDetailsHandler callback)` Retrieves the current user attributes.
`void`	`getDetailsInBackground(GetDetailsHandler callback)` Retrieves the current user attributes.
`void`	`getSession(AuthenticationHandler callback)` Returns a valid tokens for a user through the callback method.
`void`	`getSessionInBackground(AuthenticationHandler callback)` Returns a valid tokens for a user through the callback method.
`String`	`getUserId()` Returns the userId of this user.
`String`	`getUserPoolId()` Returns the pool Id of this user.
`void`	`globalSignOut(GenericHandler callback)` Sign-out from all devices associated with this user, in current thread.
`void`	`globalSignOutInBackground(GenericHandler callback)` Sign-out from all devices associated with this user, in background.
`Runnable`	`initiateUserAuthentication(AuthenticationDetails authenticationDetails, AuthenticationHandler callback, boolean runInBackground)` Initiates user authentication through the generic auth flow (also called as Enhanced or Custom authentication).
`void`	`listDevices(int limit, String paginationToken, DevicesHandler callback)` Fetches the list of all remembered devices for this user, runs in current thread.
`void`	`listDevicesInBackground(int limit, String paginationToken, DevicesHandler callback)` Fetches the list of all remembered devices for this user.
`void`	`resendConfirmationCode(VerificationHandler callback)` Request to resend registration confirmation code for a user, in current thread.
`void`	`resendConfirmationCodeInBackground(VerificationHandler callback)` Request to resend registration confirmation code for a user, in background.
`Runnable`	`respondToChallenge(RespondToAuthChallengeRequest challengeResponse, AuthenticationHandler callback, boolean runInBackground)` This method sends the challenge response to the Cognito IDP service.
`Runnable`	`respondToMfaChallenge(String mfaCode, RespondToAuthChallengeResult challenge, AuthenticationHandler callback, boolean runInBackground)` Responds to an MFA challenge.
`void`	`setUserSettings(CognitoUserSettings cognitoUserSettings, GenericHandler callback)` Set's user settings, in current thread.
`void`	`setUserSettingsInBackground(CognitoUserSettings cognitoUserSettings, GenericHandler callback)` Set's user settings, in background.
`void`	`signOut()` Sign-Out this user by removing all cached tokens.
`CognitoDevice`	`thisDevice()` Returns the current device, if users in this pool can remember devices.
`void`	`updateAttributes(CognitoUserAttributes attributes, UpdateAttributesHandler callback)` Updates attributes for a user.
`void`	`updateAttributesInBackground(CognitoUserAttributes attributes, UpdateAttributesHandler callback)` Updates attributes for a user.
`void`	`verifyAttribute(String attributeName, String verificationCode, GenericHandler callback)` Verify an attribute with the verification code, in current thread.
`void`	`verifyAttributeInBackground(String attributeName, String verificationCode, GenericHandler callback)` Verify an attribute with the verification code, in background.

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

- Constructor Detail
  - CognitoUser
```
protected CognitoUser(CognitoUserPool pool,
                      String userId,
                      String clientId,
                      String clientSecret,
                      String secretHash,
                      AmazonCognitoIdentityProvider client,
                      android.content.Context context)
```
    Constructs a new Cognito User from a Cognito user identity pool CognitoUserPool and userId.
    
    Parameters:
    
    pool - REQUIRED: Reference to CognitoUserPool, to which this user belongs.
    
    userId - REQUIRED: userId of this user.
    
    clientId - REQUIRED: Client-Id of the android app.
    
    clientSecret - REQUIRED: Client secret assigned for this Client-Id.
    
    secretHash - REQUIRED: Secret-Hash, calculated for this android app.
    
    client - REQUIRED: Low level android client.
    
    context - REQUIRED: Application context.
- Method Detail
  - getUserId
```
public String getUserId()
```
    Returns the userId of this user.
    
    Returns:
    
    userId.
  - getUserPoolId
```
public String getUserPoolId()
```
    Returns the pool Id of this user.
    
    Returns:
    
    pool Id.
  - getCognitoIdentityProviderClient
```
protected AmazonCognitoIdentityProvider getCognitoIdentityProviderClient()
```
    Method low-level client for Amazon Cognito Identity Provider.
    
    Returns:
  - confirmSignUpInBackground
```
public void confirmSignUpInBackground(String confirmationCode,
                                      boolean forcedAliasCreation,
                                      GenericHandler callback)
```
    Confirms user registration in background.
    Confirming a user is required to complete the user's registration. Any other operations on a user. are possible only after registration confirmation.
    
    Parameters:
    
    confirmationCode - REQUIRED: Code sent to the phone-number or email used to register the user.
    
    forcedAliasCreation - REQUIRED: This flag indicates if the confirmation should go-through in case of parameter contentions.
    
    callback - REQUIRED: This is a reference to GenericHandler callback handler.
  - confirmSignUp
```
public void confirmSignUp(String confirmationCode,
                          boolean forcedAliasCreation,
                          GenericHandler callback)
```
    Confirms user registration in current thread.
    Confirming a user is required to complete the user's registration. Any other operations on a user are possible only after registration confirmation. Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    confirmationCode - REQUIRED: Code sent to the phone-number or email used to register the user
    
    forcedAliasCreation - REQUIRED: This flag indicates if the confirmation should go-through in case of parameter contentions.
    
    callback - REQUIRED: This is a reference to GenericHandler callback handler
  - resendConfirmationCodeInBackground
```
public void resendConfirmationCodeInBackground(VerificationHandler callback)
```
    Request to resend registration confirmation code for a user, in background.
    
    Parameters:
    
    callback - REQUIRED: VerificationHandler callback handler.
  - resendConfirmationCode
```
public void resendConfirmationCode(VerificationHandler callback)
```
    Request to resend registration confirmation code for a user, in current thread.
    Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    callback - REQUIRED: VerificationHandler callback handler.
  - forgotPasswordInBackground
```
public void forgotPasswordInBackground(ForgotPasswordHandler callback)
```
    Starts the process to set a new password for forgotten password case, in background.
    This will initiate the process to set a new password when the current password is forgotten. The new password will be successfully set only after the verification code, sent to the registered email or phone number of the user, successfully verified by Cognito Identity Provider service. This method will pass a continuation object to the callback. Use setters in the Continuation object ForgotPasswordContinuation to set the new password and verification code and call continue on the continuation object, CognitoIdentityProviderContinuation.continueTask().
    
    Parameters:
    
    callback - REQUIRED: ForgotPasswordHandler callback
  - forgotPassword
```
public void forgotPassword(ForgotPasswordHandler callback)
```
    Starts the process to set a new new password for forgotten password case, in current thread.
    This will initiate the process to set a new password when the current password is forgotten. The new password will be successfully set only after the verification code, sent to the registered email or phone number of the user, successfully verified by Cognito Identity Provider service. This method will pass a continuation object to the callback. Use setters in the Continuation object ForgotPasswordContinuation to set the new password and verification code and call continue on the continuation object, CognitoIdentityProviderContinuation.continueTask(). Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    callback - REQUIRED: ForgotPasswordHandler callback
  - confirmPasswordInBackground
```
public void confirmPasswordInBackground(String verificationCode,
                                        String newPassword,
                                        ForgotPasswordHandler callback)
```
    Set new password and send verification code to Cognito Identity Provider service, in background.
    This method will be called by ForgotPasswordContinuation continuation object.
    
    Parameters:
    
    verificationCode - REQUIRED: Code sent from Cognito Identity Provider Service.
    
    newPassword - REQUIRED: New password. On successful verification of verificationCode, this will be the new password for this user.
    
    callback - REQUIRED: ForgotPasswordHandler callback.
  - confirmPassword
```
public void confirmPassword(String verificationCode,
                            String newPassword,
                            ForgotPasswordHandler callback)
```
    Sends the new password and the verification code to Cognito Identity Provider service, in background.
    This method will be called by ForgotPasswordContinuation continuation object. Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    verificationCode - REQUIRED: Code sent from Cognito Identity Provider Service.
    
    newPassword - REQUIRED: New password. On successful verification of verificationCode, this will be the new password for this user.
    
    callback - REQUIRED: ForgotPasswordHandler callback.
  - getSessionInBackground
```
public void getSessionInBackground(AuthenticationHandler callback)
```
    Returns a valid tokens for a user through the callback method. Runs in background. AuthenticationHandler.onSuccess(CognitoUserSession, CognitoDevice) .
    Tokens are passed as instance of CognitoUserSession. Call this method to get valid tokens for a user. This method returns any valid cached tokens for the user. If no valid cached tokens are available this method initiates the process to authenticate the user and get tokens from Cognito Identity Provider service. Implement the interface AuthenticationHandler and pass it as callback to this method. This method uses the callback to interact with application at different stages of the authentication process. Continuation objects are used when the authentication process requires more data to continue. See CognitoIdentityProviderContinuation for details on continuation objects.
    
    Parameters:
    
    callback - REQUIRED: AuthenticationHandler callback
  - getSession
```
public void getSession(AuthenticationHandler callback)
```
    Returns a valid tokens for a user through the callback method. Runs in background. AuthenticationHandler.onSuccess(CognitoUserSession, CognitoDevice) .
    Tokens are passed as instance of CognitoUserSession. Call this method to get valid tokens for a user. This method returns any valid cached tokens for the user. If no valid cached tokens are available this method initiates the process to authenticate the user and get tokens from Cognito Identity Provider service. Implement the interface AuthenticationHandler and pass it as callback to this method. This method uses the callback to interact with application at different stages of the authentication process. Continuation objects are used when the authentication process requires more data to continue. See CognitoIdentityProviderContinuation for details on continuation objects. Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    callback - REQUIRED: AuthenticationHandler callback
  - initiateUserAuthentication
```
public Runnable initiateUserAuthentication(AuthenticationDetails authenticationDetails,
                                           AuthenticationHandler callback,
                                           boolean runInBackground)
```
    Initiates user authentication through the generic auth flow (also called as Enhanced or Custom authentication). This is the first step in user authentication. The response to this step from the service will contain information about the next step in the authentication process.
    
    Parameters:
    
    authenticationDetails - REQUIRED: Contains details about the user authentication.
    
    runInBackground - flag indicating if the operation has to run in background
    
    callback - REQUIRED: AuthenticationHandler callback.
    
    Returns:
    
    Runnable for the next step in user authentication.
  - respondToMfaChallenge
```
public Runnable respondToMfaChallenge(String mfaCode,
                                      RespondToAuthChallengeResult challenge,
                                      AuthenticationHandler callback,
                                      boolean runInBackground)
```
    Responds to an MFA challenge. This method creates a response to the challenge and calls the internal method to respond to the authentication challenge.
    
    Parameters:
    
    mfaCode - REQUIRED: The MFA code received by the user.
    
    challenge - REQUIRED: Current challenge RespondToAuthChallengeResult.
    
    runInBackground - flag indicating if the operation has to run in background.
    
    callback - REQUIRED: AuthenticationHandler callback.
    
    Returns:
    
    Runnable for the next step in user authentication.
  - getCachedSession
```
protected CognitoUserSession getCachedSession()
```
    Call this method for valid, cached tokens for this user.
    
    Returns:
    
    Valid, cached tokens CognitoUserSession. null otherwise.
  - changePasswordInBackground
```
public void changePasswordInBackground(String oldUserPassword,
                                       String newUserPassword,
                                       GenericHandler callback)
```
    Request to change password for this user, in background.
    This operation requires a valid accessToken CognitoUserSession.accessToken. Un-authenticated users will have to be authenticated before calling this method.
    
    Parameters:
    
    oldUserPassword - REQUIRED: Current password of this user.
    
    newUserPassword - REQUIRED: New password for this user.
    
    callback - REQUIRED: GenericHandler callback handler.
  - changePassword
```
public void changePassword(String oldUserPassword,
                           String newUserPassword,
                           GenericHandler callback)
```
    Request to change password for this user, in current thread.
    This operation requires a valid accessToken CognitoUserSession.accessToken. Unauthenticated users will need to be authenticated before calling this method. Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    oldUserPassword - REQUIRED: Current password of this user.
    
    newUserPassword - REQUIRED: New password for this user.
    
    callback - REQUIRED: GenericHandler callback handler.
  - getDetailsInBackground
```
public void getDetailsInBackground(GetDetailsHandler callback)
```
    Retrieves the current user attributes. Runs in background.
    All attributes, which are set for this user, are fetched. This method requires valid accessToken.
    
    Parameters:
    
    callback - REQUIRED: GetDetailsHandler callback
  - getDetails
```
public void getDetails(GetDetailsHandler callback)
```
    Retrieves the current user attributes. Runs on current thread.
    All attributes, which are set for this user, are fetched. This method requires valid accessToken. Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    callback - REQUIRED: GetDetailsHandler callback
  - getAttributeVerificationCodeInBackground
```
public void getAttributeVerificationCodeInBackground(String attributeName,
                                                     VerificationHandler callback)
```
    Requests code to verify a user attribute, in background.
    The user attributes that can be verified are those attributes that can be used to communicate with the user, e.g. phone_number and email. The verification code is sent to the medium that is represented by the attribute. Attribute verification is required to enable the attribute to be used an attribute as alias for the user. Aliases attributes can be used in lieu of the userId to authenticate the user. If an attribute was used in the confirm the user after sign-up, then that alias is already verified and does not require re-verification.
    
    Parameters:
    
    attributeName - REQUIRED: Name of the attribute that requires verification.
    
    callback - REQUIRED: callback.
  - getAttributeVerificationCode
```
public void getAttributeVerificationCode(String attributeName,
                                         VerificationHandler callback)
```
    Requests code to verify a user attribute, in current thread.
    The user attributes that can be verified are those attributes that can be used to communicate with the user, e.g. phone_number and email. The verification code is sent to the medium that is represented by the attribute. Attribute verification is required to enable the attribute to be used an attribute as alias for the user. Aliases attributes can be used in lieu of the userId to authenticate the user. If an attribute was used in the confirm the user after sign-up, then that alias is already verified and does not require re-verification. Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    attributeName - REQUIRED: Name of the attribute that requires verification.
    
    callback - REQUIRED: callback.
  - verifyAttributeInBackground
```
public void verifyAttributeInBackground(String attributeName,
                                        String verificationCode,
                                        GenericHandler callback)
```
    Verify an attribute with the verification code, in background.
    Call this method to verify an attribute with the "verification code". To request for a "verification code" call the method getAttributeVerificationCodeInBackground(String, VerificationHandler) .
    
    Parameters:
    
    attributeName - REQUIRED: The attribute that is being verified.
    
    verificationCode - REQUIRED: The code for verification.
    
    callback - REQUIRED: Callback
  - verifyAttribute
```
public void verifyAttribute(String attributeName,
                            String verificationCode,
                            GenericHandler callback)
```
    Verify an attribute with the verification code, in current thread.
    Call this method to verify an attribute with the "verification code". To request for a "verification code" call the method getAttributeVerificationCodeInBackground(String, VerificationHandler) . Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    attributeName - REQUIRED: The attribute that is being verified.
    
    verificationCode - REQUIRED: The code for verification.
    
    callback - REQUIRED: Callback
  - updateAttributesInBackground
```
public void updateAttributesInBackground(CognitoUserAttributes attributes,
                                         UpdateAttributesHandler callback)
```
    Updates attributes for a user. Runs in background.
    Requires valid accessToken.
    
    Parameters:
    
    attributes - REQUIRED: All attributes and values that need to be updated for this user.
    
    callback - REQUIRED: UpdateAttributesHandler callback.
  - updateAttributes
```
public void updateAttributes(CognitoUserAttributes attributes,
                             UpdateAttributesHandler callback)
```
    Updates attributes for a user. Runs in background.
    Requires valid accessToken. Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    attributes - REQUIRED: All attributes and values that need to be updated for this user.
    
    callback - REQUIRED: UpdateAttributesHandler callback.
  - deleteAttributesInBackground
```
public void deleteAttributesInBackground(List<String> attributeNamesToDelete,
                                         GenericHandler callback)
```
    Deletes user attributes, in background.
    
    Parameters:
    
    attributeNamesToDelete - REQUIRED: List of user attributes that have to be deleted.
    
    callback - REQUIRED: GenericHandler callback
  - deleteAttributes
```
public void deleteAttributes(List<String> attributeNamesToDelete,
                             GenericHandler callback)
```
    Deletes user attributes, in current thread.
    Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    attributeNamesToDelete - REQUIRED: List of user attributes that have to be deleted.
    
    callback - REQUIRED: GenericHandler callback
  - signOut
```
public void signOut()
```
    Sign-Out this user by removing all cached tokens.
  - globalSignOutInBackground
```
public void globalSignOutInBackground(GenericHandler callback)
```
    Sign-out from all devices associated with this user, in background.
    
    Parameters:
    
    callback - REQUIRED: GenericHandler callback.
  - globalSignOut
```
public void globalSignOut(GenericHandler callback)
```
    Sign-out from all devices associated with this user, in current thread.
    Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    callback - REQUIRED: GenericHandler callback.
  - deleteUserInBackground
```
public void deleteUserInBackground(GenericHandler callback)
```
    Deletes this user, in background.
    
    Parameters:
    
    callback - REQUIRED: @link GenericHandler} callback.
  - deleteUser
```
public void deleteUser(GenericHandler callback)
```
    Deletes this user, in current thread.
    Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    callback - REQUIRED: @link GenericHandler} callback.
  - setUserSettingsInBackground
```
public void setUserSettingsInBackground(CognitoUserSettings cognitoUserSettings,
                                        GenericHandler callback)
```
    Set's user settings, in background.
    
    Parameters:
    
    cognitoUserSettings - REQUIRED: User settings as CognitoUserSettings.
    
    callback - REQUIRED: GenericHandler callback.
  - setUserSettings
```
public void setUserSettings(CognitoUserSettings cognitoUserSettings,
                            GenericHandler callback)
```
    Set's user settings, in current thread.
    Note: This method will perform network operations. Calling this method in applications' main thread will cause Android to throw NetworkOnMainThreadException.
    
    Parameters:
    
    cognitoUserSettings - REQUIRED: User settings as CognitoUserSettings.
    
    callback - REQUIRED: GenericHandler callback.
  - respondToChallenge
```
public Runnable respondToChallenge(RespondToAuthChallengeRequest challengeResponse,
                                   AuthenticationHandler callback,
                                   boolean runInBackground)
```
    This method sends the challenge response to the Cognito IDP service. The call to the Cognito IDP service returns a new challenge and a different method is called to process the challenge. Restarts authentication if the service cannot find a device-key.
    
    Parameters:
    
    challengeResponse - REQUIRED: RespondToAuthChallengeRequest contains response for the current challenge.
    
    callback - REQUIRED: AuthenticationHandler callback.
    
    runInBackground - REQUIRED: Boolean to indicate the current threading.
    
    Returns:
    
    Runnable for the next step in user authentication.
  - deviceSrpAuthRequest
```
public RespondToAuthChallengeRequest deviceSrpAuthRequest(RespondToAuthChallengeResult challenge,
                                                          String deviceSecret,
                                                          String deviceGroupKey,
                                                          com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoUser.AuthenticationHelper authenticationHelper)
```
    Creates request for device SRP verification.
    
    Parameters:
    
    challenge - REQUIRED: RespondToAuthChallengeResult contains next challenge.
    
    deviceSecret - REQUIRED: Device secret verifier.
    
    authenticationHelper - REQUIRED: Internal helper class for SRP calculations.
    
    deviceGroupKey - the device group key
    
    Returns:
    
    RespondToAuthChallengeRequest.
  - listDevicesInBackground
```
public void listDevicesInBackground(int limit,
                                    String paginationToken,
                                    DevicesHandler callback)
```
    Fetches the list of all remembered devices for this user.
    
    Parameters:
    
    limit - REQUIRED: Maximum number of devices to be returned in this call, defaults to 10.
    
    paginationToken - REQUIRED: Token to continue an earlier search.
    
    callback - REQUIRED: DevicesHandler callback.
  - listDevices
```
public void listDevices(int limit,
                        String paginationToken,
                        DevicesHandler callback)
```
    Fetches the list of all remembered devices for this user, runs in current thread.
    
    Parameters:
    
    limit - REQUIRED: Maximum number of devices to be returned in this call, defaults to 10.
    
    paginationToken - REQUIRED: Token to continue an earlier search.
    
    callback - REQUIRED: DevicesHandler callback.
  - thisDevice
```
public CognitoDevice thisDevice()
```
    Returns the current device, if users in this pool can remember devices.
    
    Returns:
    
    CognitoDevice if the device is available, null otherwise.

Class CognitoUser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CognitoUser

Method Detail

getUserId

getUserPoolId

getCognitoIdentityProviderClient

confirmSignUpInBackground

confirmSignUp

resendConfirmationCodeInBackground

resendConfirmationCode

forgotPasswordInBackground

forgotPassword

confirmPasswordInBackground

confirmPassword

getSessionInBackground

getSession

initiateUserAuthentication

respondToMfaChallenge

getCachedSession

changePasswordInBackground

changePassword

getDetailsInBackground

getDetails

getAttributeVerificationCodeInBackground

getAttributeVerificationCode

verifyAttributeInBackground

verifyAttribute

updateAttributesInBackground

updateAttributes

deleteAttributesInBackground

deleteAttributes

signOut

globalSignOutInBackground

globalSignOut

deleteUserInBackground

deleteUser

setUserSettingsInBackground

setUserSettings

respondToChallenge

deviceSrpAuthRequest

listDevicesInBackground

listDevices

thisDevice