com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthSignUpOptions.CognitoBuilder

java.lang.Object

com.amplifyframework.auth.options.AuthSignUpOptions.Builder<AWSCognitoAuthSignUpOptions.CognitoBuilder>

com.amplifyframework.auth.cognito.options.AWSCognitoAuthSignUpOptions.CognitoBuilder

Enclosing class:

AWSCognitoAuthSignUpOptions

public static final class AWSCognitoAuthSignUpOptions.CognitoBuilder
extends com.amplifyframework.auth.options.AuthSignUpOptions.Builder<AWSCognitoAuthSignUpOptions.CognitoBuilder>

The builder for this class.

Constructor Summary

Constructors

Constructor and Description
CognitoBuilder() Constructs the builder.

Method Summary

Modifier and Type	Method and Description
AWSCognitoAuthSignUpOptions	build() Build the object.
AWSCognitoAuthSignUpOptions.CognitoBuilder	clientMetadata(java.util.Map<java.lang.String,java.lang.String> clientMetadata) A map of additional custom attributes to be sent to the service such as information about the client.
AWSCognitoAuthSignUpOptions.CognitoBuilder	getThis() Gets the type of builder to support proper flow with this being an extended class.
AWSCognitoAuthSignUpOptions.CognitoBuilder	validationData(java.util.Map<java.lang.String,java.lang.String> validationData) A map of custom data the user can send as part of the sign up process for validation.

Methods inherited from class com.amplifyframework.auth.options.AuthSignUpOptions.Builder

getUserAttributes, userAttribute, userAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

CognitoBuilder

public CognitoBuilder()

Constructs the builder.

Method Detail

getThis

public AWSCognitoAuthSignUpOptions.CognitoBuilder getThis()

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

Specified by:

getThis in class com.amplifyframework.auth.options.AuthSignUpOptions.Builder<AWSCognitoAuthSignUpOptions.CognitoBuilder>

Returns:

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

validationData

@NonNull
public AWSCognitoAuthSignUpOptions.CognitoBuilder validationData(@NonNull
                                                                          java.util.Map<java.lang.String,java.lang.String> validationData)

A map of custom data the user can send as part of the sign up process for validation.

Parameters:

validationData - A map of custom data the user can send as part of the sign up process for validation.

Returns:

the instance of the builder.

clientMetadata

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

A map of additional custom attributes to be sent to the service such as information about the client.

Parameters:

clientMetadata - A map of additional custom attributes to be sent to the service such as information about the client.

Returns:

the instance of the builder.

build

@NonNull
public AWSCognitoAuthSignUpOptions build()

Build the object.

Overrides:

build in class com.amplifyframework.auth.options.AuthSignUpOptions.Builder<AWSCognitoAuthSignUpOptions.CognitoBuilder>

Returns:

a new instance of AWSCognitoAuthSignUpOptions.