com.amazonaws.mobile.client

Class SignOutOptions.Builder

java.lang.Object

com.amazonaws.mobile.client.SignOutOptions.Builder

Enclosing class:

SignOutOptions

public static class SignOutOptions.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SignOutOptions.Builder	browserPackage(java.lang.String browserPackage) If invalidateTokens is true, this can optionally be used to specify which browser package should perform the sign out action (e.g.
SignOutOptions	build() Finalize the Builder and the options object will be returned.
SignOutOptions.Builder	invalidateTokens(boolean invalidateTokens) When the functionality is available, invalidate tokens on the server by making a call.
SignOutOptions.Builder	signOutGlobally(boolean signOutGlobally) Sign-out user from all active sessions across devices.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

signOutGlobally

public SignOutOptions.Builder signOutGlobally(boolean signOutGlobally)

Sign-out user from all active sessions across devices. This is currently only supported with Cognito User Pools.

Parameters:

signOutGlobally - true if the user is to be signed-out globally

Returns:

Builder object for chaining

browserPackage

public SignOutOptions.Builder browserPackage(java.lang.String browserPackage)

If invalidateTokens is true, this can optionally be used to specify which browser package should perform the sign out action (e.g. "org.mozilla.firefox"). Defaults to the Chrome package if not specified.

Parameters:

browserPackage - String specifying the browser to open custom tabs.

Returns:

Builder object for chaining

invalidateTokens

public SignOutOptions.Builder invalidateTokens(boolean invalidateTokens)

When the functionality is available, invalidate tokens on the server by making a call. This is currently only supported with OAuth sessions that support this functionality.

Parameters:

invalidateTokens - true if the user's token should be invalidated

Returns:

Builder object for chaining

build

public SignOutOptions build()

Finalize the Builder and the options object will be returned.

Returns:

the options object containing the options specified