com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthSignUpOptions

java.lang.Object

com.amplifyframework.auth.options.AuthSignUpOptions

com.amplifyframework.auth.cognito.options.AWSCognitoAuthSignUpOptions

public final class AWSCognitoAuthSignUpOptions
extends com.amplifyframework.auth.options.AuthSignUpOptions

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

Nested Class Summary

Nested Classes

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

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

com.amplifyframework.auth.options.AuthSignUpOptions.Builder<T extends com.amplifyframework.auth.options.AuthSignUpOptions.Builder<T>>, com.amplifyframework.auth.options.AuthSignUpOptions.CoreBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AWSCognitoAuthSignUpOptions(java.util.List<com.amplifyframework.auth.AuthUserAttribute> userAttributes, java.util.Map<java.lang.String,java.lang.String> validationData, java.util.Map<java.lang.String,java.lang.String> clientMetadata) Advanced options for signing in.

Method Summary

Modifier and Type	Method and Description
static AWSCognitoAuthSignUpOptions.CognitoBuilder	builder() Returns a builder for this object.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getClientMetadata() Get additional custom attributes to be sent to the service such as information about the client.
java.util.Map<java.lang.String,java.lang.String>	getValidationData() Get a map of custom key/values to be sent as part of the sign up process.
int	hashCode()
java.lang.String	toString()

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

getUserAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSCognitoAuthSignUpOptions

protected AWSCognitoAuthSignUpOptions(java.util.List<com.amplifyframework.auth.AuthUserAttribute> userAttributes,
                                      java.util.Map<java.lang.String,java.lang.String> validationData,
                                      java.util.Map<java.lang.String,java.lang.String> clientMetadata)

Advanced options for signing in.

Parameters:

userAttributes - Additional user attributes which should be associated with this user on registration

validationData - A map of custom key/values to be sent as part of the sign up process

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

Method Detail

getValidationData

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

Get a map of custom key/values to be sent as part of the sign up process.

Returns:

a map of custom key/values to be sent as part of the sign up process

getClientMetadata

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

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

Returns:

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

builder

@NonNull
public static AWSCognitoAuthSignUpOptions.CognitoBuilder builder()

Returns a builder for this object.

Returns:

a builder for this object.

hashCode

public int hashCode()

Overrides:

hashCode in class com.amplifyframework.auth.options.AuthSignUpOptions

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class com.amplifyframework.auth.options.AuthSignUpOptions

toString

public java.lang.String toString()

Overrides:

toString in class com.amplifyframework.auth.options.AuthSignUpOptions