com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations

Class RegisterMfaContinuation

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.ChallengeContinuation

com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.RegisterMfaContinuation

All Implemented Interfaces:

CognitoIdentityProviderContinuation<java.util.Map<java.lang.String,java.lang.String>>

public class RegisterMfaContinuation
extends ChallengeContinuation

Defines continuation for challenges to users to register an MFA.

When one or more MFA's have been set as required at the User-Pool level and if none of these MFA are setup (registered) by a user, then during the authentication process a challenge to setup the required MFA's is presented. The user must setup at least one of the required MFA's to successfully authenticate. This continuation allows users to authenticate after the required MFA has been setup.

Field Summary

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

RUN_IN_BACKGROUND, RUN_IN_CURRENT

Constructor Summary

Constructors

Constructor and Description
RegisterMfaContinuation(CognitoUser user, android.content.Context context, java.lang.String username, java.lang.String clientId, java.lang.String secretHash, com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeResult challengeResult, boolean runInBackground, AuthenticationHandler callback) Constructs a new continuation for multiple user MFA's.

Method Summary

Modifier and Type	Method and Description
void	continueTask() Continue the authentication process.
java.util.List<java.lang.String>	getMfaOptions() Returns MFA options for a user to register continue to authenticate.
void	setSessionToken(java.lang.String sessionToken) Adds the session token, returned on successful MFA registration, to allow user authentication to continue.

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

getChallengeName, getClientMetaData, getParameters, setChallengeResponse, setClientMetaData, setResponseSessionCode

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterMfaContinuation

public RegisterMfaContinuation(CognitoUser user,
                               android.content.Context context,
                               java.lang.String username,
                               java.lang.String clientId,
                               java.lang.String secretHash,
                               com.amazonaws.services.cognitoidentityprovider.model.RespondToAuthChallengeResult challengeResult,
                               boolean runInBackground,
                               AuthenticationHandler callback)

Constructs a new continuation for multiple user MFA's.

Parameters:

user - REQUIRED: Reference to the CognitoUser object.

context - REQUIRED: The android context.

username - REQUIRED: The username.

clientId - REQUIRED: The clientId.

secretHash - REQUIRED: The secret hash.

challengeResult - REQUIRED: The response from the previous auth step.

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

callback - REQUIRED: Callback to interact with the app.

Method Detail

getMfaOptions

public java.util.List<java.lang.String> getMfaOptions()

Returns MFA options for a user to register continue to authenticate.

Returns:

options as a list.

setSessionToken

public void setSessionToken(java.lang.String sessionToken)

Adds the session token, returned on successful MFA registration, to allow user authentication to continue.

Parameters:

sessionToken - the session token.

continueTask

public void continueTask()

Continue the authentication process.

Specified by:

continueTask in interface CognitoIdentityProviderContinuation<java.util.Map<java.lang.String,java.lang.String>>

Overrides:

continueTask in class ChallengeContinuation