com.amazonaws.mobile.client.results

Enum SignInState

java.lang.Object

java.lang.Enum<SignInState>

com.amazonaws.mobile.client.results.SignInState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SignInState>

public enum SignInState
extends java.lang.Enum<SignInState>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN_NO_SRP_AUTH This is returned if you need to authenticate with USERNAME and PASSWORD directly.
CUSTOM_CHALLENGE This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.
DEVICE_PASSWORD_VERIFIER Similar to PASSWORD_VERIFIER, but for devices only.
DEVICE_SRP_AUTH If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.
DONE The flow is completed and no further steps are possible.
NEW_PASSWORD_REQUIRED For users which are required to change their passwords after successful first login.
PASSWORD_VERIFIER Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
SMS_MFA Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
UNKNOWN Unknown sign-in state, potentially unsupported state

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.String serviceText)
static SignInState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SignInState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SMS_MFA

public static final SignInState SMS_MFA

Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.

PASSWORD_VERIFIER

public static final SignInState PASSWORD_VERIFIER

Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.

CUSTOM_CHALLENGE

public static final SignInState CUSTOM_CHALLENGE

This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

DEVICE_SRP_AUTH

public static final SignInState DEVICE_SRP_AUTH

If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

DEVICE_PASSWORD_VERIFIER

public static final SignInState DEVICE_PASSWORD_VERIFIER

Similar to PASSWORD_VERIFIER, but for devices only.

ADMIN_NO_SRP_AUTH

public static final SignInState ADMIN_NO_SRP_AUTH

This is returned if you need to authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow.

NEW_PASSWORD_REQUIRED

public static final SignInState NEW_PASSWORD_REQUIRED

For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.

DONE

public static final SignInState DONE

The flow is completed and no further steps are possible.

UNKNOWN

public static final SignInState UNKNOWN

Unknown sign-in state, potentially unsupported state

Method Detail

values

public static SignInState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SignInState c : SignInState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SignInState valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

equals

public boolean equals(java.lang.String serviceText)