com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthWebUISignInOptions

java.lang.Object

com.amplifyframework.auth.options.AuthWebUISignInOptions

com.amplifyframework.auth.cognito.options.AWSCognitoAuthWebUISignInOptions

public final class AWSCognitoAuthWebUISignInOptions
extends com.amplifyframework.auth.options.AuthWebUISignInOptions

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

Nested Class Summary

Nested Classes

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

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

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

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

AWSCognitoAuthWebUISignInOptions(java.util.List<java.lang.String> scopes, java.util.Map<java.lang.String,java.lang.String> signInQueryParameters, java.util.Map<java.lang.String,java.lang.String> signOutQueryParameters, java.util.Map<java.lang.String,java.lang.String> tokenQueryParameters, java.lang.String idpIdentifier, java.lang.String federationProviderName, java.lang.String browserPackage) Advanced options for signing in via a hosted web ui.

Method Summary

Modifier and Type	Method and Description
static AWSCognitoAuthWebUISignInOptions.CognitoBuilder	builder() Returns a builder for this object.
boolean	equals(java.lang.Object obj)
java.lang.String	getBrowserPackage() Optional browser package override to choose a browser app other than Chrome to launch web sign in.
java.lang.String	getFederationProviderName() If federating with Cognito Identity and using a provider lik Auth0 specify the provider name, e.g.
java.lang.String	getIdpIdentifier() The IdentityProvider identifier if using multiple instances of same identity provider.
int	hashCode()
java.lang.String	toString()

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

getScopes, getSignInQueryParameters, getSignOutQueryParameters, getTokenQueryParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSCognitoAuthWebUISignInOptions

protected AWSCognitoAuthWebUISignInOptions(java.util.List<java.lang.String> scopes,
                                           java.util.Map<java.lang.String,java.lang.String> signInQueryParameters,
                                           java.util.Map<java.lang.String,java.lang.String> signOutQueryParameters,
                                           java.util.Map<java.lang.String,java.lang.String> tokenQueryParameters,
                                           java.lang.String idpIdentifier,
                                           java.lang.String federationProviderName,
                                           java.lang.String browserPackage)

Advanced options for signing in via a hosted web ui.

Parameters:

scopes - specify OAUTH scopes

signInQueryParameters - map of custom parameters to send associated with sign in process

signOutQueryParameters - map of custom parameters to send associated with sign out process

tokenQueryParameters - map of custom parameters to send associated with token

idpIdentifier - The IdentityProvider identifier if using multiple instances of same identity provider.

federationProviderName - If federating with Cognito Identity and using a provider lik Auth0 specify the provider name, e.g. .auth0.com

browserPackage - Specify which browser package should be used for web sign in (e.g. "org.mozilla.firefox"). Defaults to the Chrome package if not specified.

Method Detail

getIdpIdentifier

@Nullable
public java.lang.String getIdpIdentifier()

The IdentityProvider identifier if using multiple instances of same identity provider.

Returns:

the IdentityProvider identifier

getFederationProviderName

@Nullable
public java.lang.String getFederationProviderName()

If federating with Cognito Identity and using a provider lik Auth0 specify the provider name, e.g. .auth0.com

Returns:

the provider name

getBrowserPackage

@Nullable
public java.lang.String getBrowserPackage()

Optional browser package override to choose a browser app other than Chrome to launch web sign in.

Returns:

optional browser package override to choose a browser app other than Chrome to launch web sign in.

builder

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

equals

public boolean equals(java.lang.Object obj)

Overrides:

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

toString

public java.lang.String toString()

Overrides:

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