com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthSignOutOptions.CognitoBuilder

java.lang.Object

com.amplifyframework.auth.options.AuthSignOutOptions.Builder<AWSCognitoAuthSignOutOptions.CognitoBuilder>

com.amplifyframework.auth.cognito.options.AWSCognitoAuthSignOutOptions.CognitoBuilder

Enclosing class:

AWSCognitoAuthSignOutOptions

public static final class AWSCognitoAuthSignOutOptions.CognitoBuilder
extends com.amplifyframework.auth.options.AuthSignOutOptions.Builder<AWSCognitoAuthSignOutOptions.CognitoBuilder>

The builder for this class.

Constructor Summary

Constructors

Constructor and Description
CognitoBuilder()

Method Summary

Modifier and Type	Method and Description
AWSCognitoAuthSignOutOptions.CognitoBuilder	browserPackage(java.lang.String browserPackage) This can optionally be set to specify which browser package should perform the sign out action (e.g.
AWSCognitoAuthSignOutOptions	build() Construct and return the object with the values set in the builder.
AWSCognitoAuthSignOutOptions.CognitoBuilder	getThis() Returns the type of builder this is to support proper flow with it being an extended class.

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

globalSignOut, isGlobalSignOut

Methods inherited from class java.lang.Object

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

Constructor Detail

CognitoBuilder

public CognitoBuilder()

Method Detail

getThis

public AWSCognitoAuthSignOutOptions.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.AuthSignOutOptions.Builder<AWSCognitoAuthSignOutOptions.CognitoBuilder>

Returns:

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

browserPackage

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

This can optionally be set to specify which browser package should perform the sign out action (e.g. "org.mozilla.firefox") in the case of an account which was signed in to from a web UI experience. Defaults to the Chrome package if not set.

Parameters:

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

Returns:

the instance of the builder.

build

@NonNull
public AWSCognitoAuthSignOutOptions build()

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

Overrides:

build in class com.amplifyframework.auth.options.AuthSignOutOptions.Builder<AWSCognitoAuthSignOutOptions.CognitoBuilder>

Returns:

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