com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthSignInOptions.CognitoBuilder

java.lang.Object

com.amplifyframework.auth.options.AuthSignInOptions.Builder<AWSCognitoAuthSignInOptions.CognitoBuilder>

com.amplifyframework.auth.cognito.options.AWSCognitoAuthSignInOptions.CognitoBuilder

Enclosing class:

AWSCognitoAuthSignInOptions

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

Returns:

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

metadata

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

authFlowType

@NonNull
public AWSCognitoAuthSignInOptions.CognitoBuilder authFlowType(@NonNull
                                                                        AuthFlowType authFlowType)

Set the authFlowType for the object being built.

Parameters:

authFlowType - authFlowType to be sent to sign in request.

Returns:

The builder object to continue building.

build

@NonNull
public AWSCognitoAuthSignInOptions build()

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

Specified by:

build in class com.amplifyframework.auth.options.AuthSignInOptions.Builder<AWSCognitoAuthSignInOptions.CognitoBuilder>

Returns:

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