com.amplifyframework.auth.cognito.options

Class AWSCognitoAuthSignOutOptions

java.lang.Object

com.amplifyframework.auth.options.AuthSignOutOptions

com.amplifyframework.auth.cognito.options.AWSCognitoAuthSignOutOptions

public final class AWSCognitoAuthSignOutOptions
extends com.amplifyframework.auth.options.AuthSignOutOptions

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

Nested Class Summary

Nested Classes

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

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AWSCognitoAuthSignOutOptions(boolean globalSignOut, java.lang.String browserPackage) Advanced options for signing out.

Method Summary

Modifier and Type	Method and Description
static AWSCognitoAuthSignOutOptions.CognitoBuilder	builder() Get a builder 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 out.
int	hashCode()
java.lang.String	toString()

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

isGlobalSignOut

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSCognitoAuthSignOutOptions

protected AWSCognitoAuthSignOutOptions(boolean globalSignOut,
                                       java.lang.String browserPackage)

Advanced options for signing out.

Parameters:

globalSignOut - Sign out of all devices (do not use when signing out of a WebUI experience)

browserPackage - Specify which browser package should be used for signing out of an account which was signed into with a web UI experience (example value: "org.mozilla.firefox"). Defaults to the Chrome package if not specified.

Method Detail

getBrowserPackage

@Nullable
public java.lang.String getBrowserPackage()

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

Returns:

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

builder

@NonNull
public static AWSCognitoAuthSignOutOptions.CognitoBuilder builder()

Get a builder object.

Returns:

a builder object.

hashCode

public int hashCode()

Overrides:

hashCode in class com.amplifyframework.auth.options.AuthSignOutOptions

equals

public boolean equals(java.lang.Object obj)

Overrides:

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

toString

public java.lang.String toString()

Overrides:

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