com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthSignInOptions

java.lang.Object

com.amplifyframework.auth.options.AuthSignInOptions

com.amplifyframework.auth.cognito.options.AWSCognitoAuthSignInOptions

public final class AWSCognitoAuthSignInOptions
extends com.amplifyframework.auth.options.AuthSignInOptions

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

Nested Class Summary

Nested Classes

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

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

com.amplifyframework.auth.options.AuthSignInOptions.Builder<T extends com.amplifyframework.auth.options.AuthSignInOptions.Builder<T>>, com.amplifyframework.auth.options.AuthSignInOptions.DefaultAuthSignInOptions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AWSCognitoAuthSignInOptions(java.util.Map<java.lang.String,java.lang.String> metadata, AuthFlowType authFlowType) Advanced options for signing in.

Method Summary

Modifier and Type	Method and Description
static AWSCognitoAuthSignInOptions.CognitoBuilder	builder() Get a builder object.
boolean	equals(java.lang.Object obj)
AuthFlowType	getAuthFlowType() Get authFlowType to be sent to the service.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() 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.AuthSignInOptions

defaults

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSCognitoAuthSignInOptions

protected AWSCognitoAuthSignInOptions(java.util.Map<java.lang.String,java.lang.String> metadata,
                                      AuthFlowType authFlowType)

Advanced options for signing in.

Parameters:

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

authFlowType - AuthFlowType to be used by signIn API

Method Detail

getMetadata

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

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

getAuthFlowType

@NonNull
public AuthFlowType getAuthFlowType()

Get authFlowType to be sent to the service.

Returns:

authFlowType to be sent to the signIn api

builder

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