com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthConfirmSignInOptions.CognitoBuilder

java.lang.Object

com.amplifyframework.auth.options.AuthConfirmSignInOptions.Builder<AWSCognitoAuthConfirmSignInOptions.CognitoBuilder>

com.amplifyframework.auth.cognito.options.AWSCognitoAuthConfirmSignInOptions.CognitoBuilder

Enclosing class:

AWSCognitoAuthConfirmSignInOptions

public static final class AWSCognitoAuthConfirmSignInOptions.CognitoBuilder
extends com.amplifyframework.auth.options.AuthConfirmSignInOptions.Builder<AWSCognitoAuthConfirmSignInOptions.CognitoBuilder>

The builder for this class.

Constructor Summary

Constructors

Constructor and Description
CognitoBuilder() Constructor for the builder.

Method Summary

Modifier and Type	Method and Description
AWSCognitoAuthConfirmSignInOptions	build() Construct and return the object with the values set in the builder.
AWSCognitoAuthConfirmSignInOptions.CognitoBuilder	getThis() Returns the type of builder this is to support proper flow with it being an extended class.
AWSCognitoAuthConfirmSignInOptions.CognitoBuilder	metadata(java.util.Map<java.lang.String,java.lang.String> metadata) Set the metadata field for the object being built.
AWSCognitoAuthConfirmSignInOptions.CognitoBuilder	userAttributes(java.util.List<com.amplifyframework.auth.AuthUserAttribute> userAttributes) Set the userAttributes field for the object being built.

Methods inherited from class java.lang.Object

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

Constructor Detail

CognitoBuilder

public CognitoBuilder()

Constructor for the builder.

Method Detail

getThis

public AWSCognitoAuthConfirmSignInOptions.CognitoBuilder getThis()

Returns the type of builder this is to support proper flow with it being an extended class.

Specified by:

getThis in class com.amplifyframework.auth.options.AuthConfirmSignInOptions.Builder<AWSCognitoAuthConfirmSignInOptions.CognitoBuilder>

Returns:

the type of builder this is to support proper flow with it being an extended class.

metadata

@NonNull
public AWSCognitoAuthConfirmSignInOptions.CognitoBuilder metadata(@NonNull
                                                                           java.util.Map<java.lang.String,java.lang.String> metadata)

Set the metadata field for the object being built.

Parameters:

metadata - Custom user metadata to be sent with the sign in request.

Returns:

The builder object to continue building.

userAttributes

@NonNull
public AWSCognitoAuthConfirmSignInOptions.CognitoBuilder userAttributes(@NonNull
                                                                                 java.util.List<com.amplifyframework.auth.AuthUserAttribute> userAttributes)

Set the userAttributes field for the object being built.

Parameters:

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

Returns:

the instance of the builder.

build

@NonNull
public AWSCognitoAuthConfirmSignInOptions build()

Construct and return the object with the values set in the builder.

Specified by:

build in class com.amplifyframework.auth.options.AuthConfirmSignInOptions.Builder<AWSCognitoAuthConfirmSignInOptions.CognitoBuilder>

Returns:

a new instance of AWSCognitoAuthConfirmSignInOptions with the values specified in the builder.