com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthConfirmSignUpOptions.CognitoBuilder

java.lang.Object

com.amplifyframework.auth.options.AuthConfirmSignUpOptions.Builder<AWSCognitoAuthConfirmSignUpOptions.CognitoBuilder>

com.amplifyframework.auth.cognito.options.AWSCognitoAuthConfirmSignUpOptions.CognitoBuilder

Enclosing class:

AWSCognitoAuthConfirmSignUpOptions

public static final class AWSCognitoAuthConfirmSignUpOptions.CognitoBuilder
extends com.amplifyframework.auth.options.AuthConfirmSignUpOptions.Builder<AWSCognitoAuthConfirmSignUpOptions.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
AWSCognitoAuthConfirmSignUpOptions	build() Construct and return the object with the values set in the builder.
AWSCognitoAuthConfirmSignUpOptions.CognitoBuilder	clientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata) Set the metadata field for the object being built.
AWSCognitoAuthConfirmSignUpOptions.CognitoBuilder	getThis() Returns the type of builder this is to support proper flow with it being an extended class.

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 AWSCognitoAuthConfirmSignUpOptions.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.AuthConfirmSignUpOptions.Builder<AWSCognitoAuthConfirmSignUpOptions.CognitoBuilder>

Returns:

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

clientMetadata

@NonNull
public AWSCognitoAuthConfirmSignUpOptions.CognitoBuilder clientMetadata(@NonNull
                                                                                 java.util.Map<java.lang.String,java.lang.String> clientMetadata)

Set the metadata field for the object being built.

Parameters:

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

Returns:

The builder object to continue building.

build

@NonNull
public AWSCognitoAuthConfirmSignUpOptions build()

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

Specified by:

build in class com.amplifyframework.auth.options.AuthConfirmSignUpOptions.Builder<AWSCognitoAuthConfirmSignUpOptions.CognitoBuilder>

Returns:

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