CallState enum
Represents the state of a call.
Values
- newCall → const CallState
-
newCall The call has been created but not yet connected.
- connecting → const CallState
-
connecting the call is being connected to the remote client
- ringing → const CallState
-
ringing the call invitation has been extended, we are waiting for an answer.
- active → const CallState
-
active the call is active and the two clients are fully connected.
- held → const CallState
-
held the user has put the call on hold.
- reconnecting → const CallState
-
reconnecting The call is reconnecting - for this state a NetworkReason is provided. A call will remain in this state for the time specified within the configuration used to log in. The default value is 60 seconds, transitioning to dropped if the reconnection is not successful.
- dropped → const CallState
-
dropped The call has been dropped - for this state a NetworkReason is provided.
- done → const CallState
-
done the call is finished - for this state a CallTerminationReason may be provided.
- error → const CallState
-
error there was an issue creating the call.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- index → int
-
A numeric identifier for the enumerated value.
no setterinherited
- isActive → bool
-
Returns true if the call is actively attempting to reconnect to the remote client.
no setter
- isDone → bool
-
Returns true if the call is completed.
no setter
- isDropped → bool
-
Returns true if the call has been dropped.
no setter
- isReconnecting → bool
-
Returns true if the call is actively attempting to reconnect to the remote client.
no setter
- name → String
-
Available on Enum, provided by the EnumName extension
The name of the enum value.no setter - networkReason → NetworkReason?
-
Get the network reason for reconnecting or dropped states.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- terminationReason → CallTerminationReason?
-
Get the termination reason for done state.
no setter
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
withNetworkReason(
NetworkReason reason) → CallState - Set the network reason for the call state - only for reconnecting or dropped.
-
withTerminationReason(
CallTerminationReason? reason) → CallState - Set the termination reason for the call state - only for done.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited