com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthConfirmSignInOptions

java.lang.Object

com.amplifyframework.auth.options.AuthConfirmSignInOptions

com.amplifyframework.auth.cognito.options.AWSCognitoAuthConfirmSignInOptions

public final class AWSCognitoAuthConfirmSignInOptions
extends com.amplifyframework.auth.options.AuthConfirmSignInOptions

Cognito extension of confirm sign in options to add the platform specific fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AWSCognitoAuthConfirmSignInOptions.CognitoBuilder The builder for this class.

Nested classes/interfaces inherited from class com.amplifyframework.auth.options.AuthConfirmSignInOptions

com.amplifyframework.auth.options.AuthConfirmSignInOptions.Builder<T extends com.amplifyframework.auth.options.AuthConfirmSignInOptions.Builder<T>>, com.amplifyframework.auth.options.AuthConfirmSignInOptions.DefaultAuthConfirmSignInOptions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AWSCognitoAuthConfirmSignInOptions(java.util.Map<java.lang.String,java.lang.String> metadata, java.util.List<com.amplifyframework.auth.AuthUserAttribute> userAttributes) Advanced options for confirming sign in.

Method Summary

Modifier and Type	Method and Description
static AWSCognitoAuthConfirmSignInOptions.CognitoBuilder	builder() Get a builder object.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Get custom attributes to be sent to the service such as information about the client.
java.util.List<com.amplifyframework.auth.AuthUserAttribute>	getUserAttributes() Get additional user attributes which should be associated with this user on confirmSignIn.
int	hashCode()
java.lang.String	toString()

Methods inherited from class com.amplifyframework.auth.options.AuthConfirmSignInOptions

defaults

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AWSCognitoAuthConfirmSignInOptions

protected AWSCognitoAuthConfirmSignInOptions(java.util.Map<java.lang.String,java.lang.String> metadata,
                                             java.util.List<com.amplifyframework.auth.AuthUserAttribute> userAttributes)

Advanced options for confirming sign in.

Parameters:

metadata - Additional custom attributes to be sent to the service such as information about the client

userAttributes - A list of additional user attributes which should be associated with this user on confirmSignIn.

Method Detail

getMetadata

@NonNull
public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Get custom attributes to be sent to the service such as information about the client.

Returns:

custom attributes to be sent to the service such as information about the client

getUserAttributes

@NonNull
public java.util.List<com.amplifyframework.auth.AuthUserAttribute> getUserAttributes()

Get additional user attributes which should be associated with this user on confirmSignIn.

Returns:

additional user attributes which should be associated with this user on confirmSignIn

builder

@NonNull
public static AWSCognitoAuthConfirmSignInOptions.CognitoBuilder builder()

Get a builder object.

Returns:

a builder object.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object