SignOutReason enum
The reason why an AuthChangeEvent.signedOut event was emitted.
Available on AuthState.signOutReason and lets listeners distinguish an explicit sign out from an involuntary one, such as an expired session, without inspecting error messages.
Values
- userInitiated → const SignOutReason
-
The user explicitly signed out by calling GoTrueClient.signOut.
- sessionExpired → const SignOutReason
-
The session could no longer be refreshed because its refresh token was rejected (invalid or expired), so the session was removed.
Matches the ErrorCode.sessionExpired thrown on the stream.
- sessionMissing → const SignOutReason
-
A stored session could not be recovered because it was missing required data, so the session was removed.
Matches the ErrorCode.sessionMissing thrown on the stream.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- index → int
-
A numeric identifier for the enumerated value.
no setterinherited
- name → String
-
Available on Enum, provided by the EnumName extension
The name of the enum value.no setter - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
-
values
→ const List<
SignOutReason> - A constant List of the values in this enum, in order of their declaration.