ZIMConnectionState enum

Connection state.

Description: The state machine that identifies the current connection state.

Use cases: It can be used to determine whether the login/logout is successful, and to handle abnormal situations such as network disconnection.

Caution: Please use it with the connection event parameter.

Inheritance

Constructors

ZIMConnectionState()
const

Values

disconnected → const ZIMConnectionState

Description: Unconnected state, enter this state before logging in and after logging out.

Use cases: If there is a steady state abnormality in the process of logging in, such as AppID or Token are incorrect, or if the same user name is logged in elsewhere and the local end is kicked out, it will enter this state.

connecting → const ZIMConnectionState

Description: The state that the connection is being requested. It will enter this state after successful execution login function.

Use cases: The display of the UI is usually performed using this state. If the connection is interrupted due to poor network quality, the SDK will perform an internal retry and will return to this state.

connected → const ZIMConnectionState

Description: The state that is successfully connected.

Use cases: Entering this state indicates that login successfully and the user can use the SDK functions normally.

reconnecting → const ZIMConnectionState

Description: The state that the reconnection is being requested. It will enter this state after successful execution login function.

Use cases: The display of the UI is usually performed using this state. If the connection is interrupted due to poor network quality, the SDK will perform an internal retry and will return to this state.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
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<ZIMConnectionState>
A constant List of the values in this enum, in order of their declaration.