com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations

Class ChooseMfaContinuation

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.ChallengeContinuation

com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.ChooseMfaContinuation

All Implemented Interfaces:

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

public class ChooseMfaContinuation
extends ChallengeContinuation

Defines continuation for challenge to pick an MFA.

These challenges are presented when the user has multiple MFA's setup (registered) and enabled, and none of them are set as preferred.

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
ChooseMfaContinuation(CognitoUser user, android.content.Context context, java.lang.String username, java.lang.String clientId, java.lang.String secretHash, 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 with the set MFA option.
java.util.List<java.lang.String>	getMfaOptions() Returns MFA options for a user to continue to authenticate.
void	setMfaOption(java.lang.String option) Set the response to the MFA select request.

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

getChallengeName, getClientMetaData, getParameters, setChallengeResponse, setClientMetaData, setResponseSessionCode

Methods inherited from class java.lang.Object

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

Constructor Detail

ChooseMfaContinuation

public ChooseMfaContinuation(CognitoUser user,
                             android.content.Context context,
                             java.lang.String username,
                             java.lang.String clientId,
                             java.lang.String secretHash,
                             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 continue to authenticate.

Returns:

options as a list.

setMfaOption

public void setMfaOption(java.lang.String option)

Set the response to the MFA select request.

Parameters:

option - MFA option picked by the user.

continueTask

public void continueTask()

Continue the authentication process with the set MFA option.

Specified by:

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

Overrides:

continueTask in class ChallengeContinuation