com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthWebUISignInOptions.CognitoBuilder

java.lang.Object

com.amplifyframework.auth.options.AuthWebUISignInOptions.Builder<AWSCognitoAuthWebUISignInOptions.CognitoBuilder>

com.amplifyframework.auth.cognito.options.AWSCognitoAuthWebUISignInOptions.CognitoBuilder

Enclosing class:

AWSCognitoAuthWebUISignInOptions

public static final class AWSCognitoAuthWebUISignInOptions.CognitoBuilder
extends com.amplifyframework.auth.options.AuthWebUISignInOptions.Builder<AWSCognitoAuthWebUISignInOptions.CognitoBuilder>

The builder for this class.

Constructor Summary

Constructors

Constructor and Description
CognitoBuilder() Constructs the builder.

Method Summary

Modifier and Type	Method and Description
AWSCognitoAuthWebUISignInOptions.CognitoBuilder	browserPackage(java.lang.String browserPackage) This can optionally be set to specify which browser package should perform the sign in action (e.g.
AWSCognitoAuthWebUISignInOptions	build() Build the object.
AWSCognitoAuthWebUISignInOptions.CognitoBuilder	federationProviderName(java.lang.String federationProviderName) If federating with Cognito Identity and using a provider lik Auth0 specify the provider name.
AWSCognitoAuthWebUISignInOptions.CognitoBuilder	getThis() Gets the type of builder to support proper flow with this being an extended class.
AWSCognitoAuthWebUISignInOptions.CognitoBuilder	idpIdentifier(java.lang.String idpIdentifier) The IdentityProvider identifier if using multiple instances of same identity provider.

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

getScopes, getSignInQueryParameters, getSignOutQueryParameters, getTokenQueryParameters, scopes, signInQueryParameters, signOutQueryParameters, tokenQueryParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CognitoBuilder

public CognitoBuilder()

Constructs the builder.

Method Detail

getThis

public AWSCognitoAuthWebUISignInOptions.CognitoBuilder getThis()

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

Specified by:

getThis in class com.amplifyframework.auth.options.AuthWebUISignInOptions.Builder<AWSCognitoAuthWebUISignInOptions.CognitoBuilder>

Returns:

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

idpIdentifier

@NonNull
public AWSCognitoAuthWebUISignInOptions.CognitoBuilder idpIdentifier(@NonNull
                                                                              java.lang.String idpIdentifier)

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

Parameters:

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

Returns:

the instance of the builder.

federationProviderName

@NonNull
public AWSCognitoAuthWebUISignInOptions.CognitoBuilder federationProviderName(@NonNull
                                                                                       java.lang.String federationProviderName)

If federating with Cognito Identity and using a provider lik Auth0 specify the provider name.

Parameters:

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

Returns:

the instance of the builder.

browserPackage

public AWSCognitoAuthWebUISignInOptions.CognitoBuilder browserPackage(@NonNull
                                                                      java.lang.String browserPackage)

This can optionally be set to specify which browser package should perform the sign in action (e.g. "org.mozilla.firefox"). Defaults to the Chrome package if not set.

Parameters:

browserPackage - String specifying the browser package to perform the web sign in action.

Returns:

the instance of the builder.

build

@NonNull
public AWSCognitoAuthWebUISignInOptions build()

Build the object.

Overrides:

build in class com.amplifyframework.auth.options.AuthWebUISignInOptions.Builder<AWSCognitoAuthWebUISignInOptions.CognitoBuilder>

Returns:

a new instance of AWSCognitoAuthWebUISignInOptions.