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 java.lang.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, com.amazonaws.services.cognitoidentityprovider.model.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.
java.util.Map<java.lang.String,java.lang.String>	getClientMetaData() clientMetadata is a map of custom key-value pairs that you can provide as input for any custom work flows.
CognitoUserCodeDeliveryDetails	getParameters() This method returns the medium where this multi-factor authentication code was sent.
void	setClientMetaData(java.util.Map<java.lang.String,java.lang.String> clientMetadata) Mutator for clientMetadata.
void	setMfaCode(java.lang.String mfaCode) Add the multi-factor authentication code.

Methods inherited from class java.lang.Object

equals, 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,
                                             com.amazonaws.services.cognitoidentityprovider.model.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

getClientMetaData

public java.util.Map<java.lang.String,java.lang.String> getClientMetaData()

clientMetadata is a map of custom key-value pairs that you can provide as input for any custom work flows. Accessor method for clientMetadata.

Returns:

ClientMetadata

setClientMetaData

public void setClientMetaData(java.util.Map<java.lang.String,java.lang.String> clientMetadata)

Mutator for clientMetadata.

Parameters:

clientMetadata - Metadata to be passed as input to the lambda triggers.

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(java.lang.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.