com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthConfirmSignUpOptions

java.lang.Object

com.amplifyframework.auth.options.AuthConfirmSignUpOptions

com.amplifyframework.auth.cognito.options.AWSCognitoAuthConfirmSignUpOptions

public final class AWSCognitoAuthConfirmSignUpOptions
extends com.amplifyframework.auth.options.AuthConfirmSignUpOptions

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

Nested Class Summary

Nested Classes

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

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

com.amplifyframework.auth.options.AuthConfirmSignUpOptions.Builder<T extends com.amplifyframework.auth.options.AuthConfirmSignUpOptions.Builder<T>>, com.amplifyframework.auth.options.AuthConfirmSignUpOptions.DefaultAuthConfirmSignUpOptions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AWSCognitoAuthConfirmSignUpOptions(java.util.Map<java.lang.String,java.lang.String> clientMetadata) Advanced options for confirming sign up.

Method Summary

Modifier and Type	Method and Description
static AWSCognitoAuthConfirmSignUpOptions.CognitoBuilder	builder() Get a builder object.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getClientMetadata() Get custom attributes to be sent to the service such as information about the client.
int	hashCode()
java.lang.String	toString()

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

defaults

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSCognitoAuthConfirmSignUpOptions

protected AWSCognitoAuthConfirmSignUpOptions(java.util.Map<java.lang.String,java.lang.String> clientMetadata)

Advanced options for confirming sign up.

Parameters:

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

Method Detail

getClientMetadata

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

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

builder

@NonNull
public static AWSCognitoAuthConfirmSignUpOptions.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