SDKState enum
Represents the various states of the SDK during its lifecycle.
The SDK transitions through these states based on its lifecycle, such as initialization, authentication, connection, and running tasks.
- Inheritance
- Available extensions
Values
- uninitialized → const SDKState
-
The SDK has not yet been initialized. This is the initial state before any configuration is done.
- initializing → const SDKState
-
The SDK is in the process of initializing components like OAuth.
- initialized → const SDKState
-
The SDK has successfully initialized but the WebSocket connection is not yet established.
- authenticating → const SDKState
-
The SDK is authenticating (retrieving an access token).
- authenticated → const SDKState
-
The SDK has successfully retrieved a valid access token.
- connecting → const SDKState
-
The SDK is connecting to the WebSocket. OAuth setup is complete.
- running → const SDKState
-
The SDK is fully connected and running.
- error → const SDKState
-
The SDK encountered an error during initialization, WebSocket connection, or task execution.
- stopped → const SDKState
-
The SDK has been stopped, and the WebSocket connection is disconnected.
- paused → const SDKState
-
The SDK is paused due to unmet conditions (e.g., network or feature flags).
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
-
toReadableString(
) → String -
Available on SDKState, provided by the SDKStateExtension extension
Converts theSDKStateenum to its corresponding string value. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited