com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations

Class NewPasswordContinuation

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.ChallengeContinuation

com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.NewPasswordContinuation

All Implemented Interfaces:

CognitoIdentityProviderContinuation<Map<String,String>>

public class NewPasswordContinuation
extends ChallengeContinuation

Defines continuation for new user set-up. This is used to set the password and user attributes after first sign-in after admin created this user. Depending the attributes, for the user, set by the admin, user will have the set the other required attributes during the first sign-in. During the first sign-in, the user will also be able to change some of the attributes which were set by the admin.

Field Summary

Fields inherited from class com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.ChallengeContinuation

challengeResponses, RUN_IN_BACKGROUND, RUN_IN_CURRENT

Constructor Summary

Constructors

Constructor and Description
NewPasswordContinuation(CognitoUser user, android.content.Context context, String username, String clientId, String secretHash, RespondToAuthChallengeResult challengeResult, boolean runInBackground, AuthenticationHandler callback) Constructs a new continuation for new user sign-in.

Method Summary

Modifier and Type	Method and Description
void	continueTask() Calls of the parent after checking if all the required attributes have been set.
Map<String,String>	getCurrentUserAttributes() Returns all current user attributes.
List<String>	getRequiredAttributes() Returns all required attributes to complete user sign-up.
void	setPassword(String userPassword) Set new user password, must not be null.
void	setUserAttribute(String attributeName, String attributeValue) Add a user attribute, will override current value.

Methods inherited from class com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.ChallengeContinuation

getChallengeName, getParameters, setChallengeResponse, setResponseSessionCode

Methods inherited from class java.lang.Object

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

Constructor Detail

NewPasswordContinuation

public NewPasswordContinuation(CognitoUser user,
                               android.content.Context context,
                               String username,
                               String clientId,
                               String secretHash,
                               RespondToAuthChallengeResult challengeResult,
                               boolean runInBackground,
                               AuthenticationHandler callback)

Constructs a new continuation for new user sign-in.

Parameters:

user - REQUIRED: Reference to the CognitoUser object.

runInBackground - REQUIRED: Represents where this continuation has to run.

callback - REQUIRED: Callback to interact with the app.

context - REQUIRED: The android context.

username - REQUIRED: the username.

clientId - REQUIRED: the clientId.

secretHash - REQUIRED: the secreth hash.

challengeResult - REQUIRED: The response to respond to the authentication challenge.

Method Detail

getRequiredAttributes

public List<String> getRequiredAttributes()

Returns all required attributes to complete user sign-up. All these user attributes have to be set to complete the user sign-up.

Returns:

A List<String> of all required user attributes.

getCurrentUserAttributes

public Map<String,String> getCurrentUserAttributes()

Returns all current user attributes. These attributes are set by the Admin when creating a new user.

Returns:

A Map<String, String> containing all current values of user attributes.

setUserAttribute

public void setUserAttribute(String attributeName,
                             String attributeValue)

Add a user attribute, will override current value.

Parameters:

attributeName - REQUIRED: The attribute name.

attributeValue - REQUIRED: The attribute value.

setPassword

public void setPassword(String userPassword)

Set new user password, must not be null. This is required to complete the user sign-up.

Parameters:

userPassword - REQUIRED: New user password.

continueTask

public void continueTask()

Calls of the parent after checking if all the required attributes have been set.

Specified by:

continueTask in interface CognitoIdentityProviderContinuation<Map<String,String>>

Overrides:

continueTask in class ChallengeContinuation