CognitoSignOutResult class sealed

The result of a call to Amplify.Auth.signOut.

See also:

• CognitoCompleteSignOut
• CognitoFailedSignOut
• CognitoPartialSignOut

Inheritance

• Object
• SignOutResult
• CognitoSignOutResult

Implementers

• CognitoCompleteSignOut
• CognitoFailedSignOut
• CognitoPartialSignOut

Constructors

CognitoSignOutResult.complete()

The result of a call to Amplify.Auth.signOut.

const

factory

CognitoSignOutResult.failed(AuthException exception)

A sign out which did not complete. The user will remain signed in.

const

factory

CognitoSignOutResult.partial({HostedUiException? hostedUiException, GlobalSignOutException? globalSignOutException, RevokeTokenException? revokeTokenException})

A partial success during sign out where credentials have been cleared from the device.

const

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

props → List<Object?>

The type's equatable properties.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

runtimeTypeName → String

The string value of runtimeType, saving a runtime lookup and preventing obfuscation during web compilation.

no setter, override

signedOutLocally → bool

Whether credentials have been cleared from the local device.

no setter

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, Object?>

Serializes this as a JSON object.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited