com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations

Class MultiFactorAuthenticationContinuation

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.continuations.MultiFactorAuthenticationContinuation

All Implemented Interfaces:

CognitoIdentityProviderContinuation<CognitoUserCodeDeliveryDetails>

public class MultiFactorAuthenticationContinuation
extends Object
implements CognitoIdentityProviderContinuation<CognitoUserCodeDeliveryDetails>

This is a Continuation for multi-factor authentication.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	RUN_IN_BACKGROUND Run in background.
static boolean	RUN_IN_CURRENT Run on current thread.

Constructor Summary

Constructors

Constructor and Description
MultiFactorAuthenticationContinuation(CognitoUser user, android.content.Context context, RespondToAuthChallengeResult challenge, boolean runInBackground, AuthenticationHandler callback) Constructs a multi-factor authentication continuation.

Method Summary

Modifier and Type	Method and Description
void	continueTask() Call this to continue with the authentication process.
CognitoUserCodeDeliveryDetails	getParameters() This method returns the medium where this multi-factor authentication code was sent.
void	setMfaCode(String mfaCode) Add the multi-factor authentication code.

Methods inherited from class java.lang.Object

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

Field Detail

RUN_IN_BACKGROUND

public static final boolean RUN_IN_BACKGROUND

Run in background.

See Also:

Constant Field Values

RUN_IN_CURRENT

public static final boolean RUN_IN_CURRENT

Run on current thread.

See Also:

Constant Field Values

Constructor Detail

MultiFactorAuthenticationContinuation

public MultiFactorAuthenticationContinuation(CognitoUser user,
                                             android.content.Context context,
                                             RespondToAuthChallengeResult challenge,
                                             boolean runInBackground,
                                             AuthenticationHandler callback)

Constructs a multi-factor authentication continuation.

Parameters:

user - REQUIRED: Reference to the CognitoUser object.

challenge - REQUIRED: Contains the MFA Challenge.

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

callback - REQUIRED: Callback to interact with the app.

context - REQUIRED: The android context.

Method Detail

getParameters

public CognitoUserCodeDeliveryDetails getParameters()

This method returns the medium where this multi-factor authentication code was sent.

Specified by:

getParameters in interface CognitoIdentityProviderContinuation<CognitoUserCodeDeliveryDetails>

Returns:

medium where the code was sent (e.g. email, sms).

continueTask

public void continueTask()

Call this to continue with the authentication process.

Specified by:

continueTask in interface CognitoIdentityProviderContinuation<CognitoUserCodeDeliveryDetails>

setMfaCode

public void setMfaCode(String mfaCode)

Add the multi-factor authentication code. This code will be used to complete the authentication.

Parameters:

mfaCode - REQIURED: The MFA code sent to the user.