ChannelEvent enum

Describes the events emitted by a RestChannel or RealtimeChannel object.

An event is either an UPDATE or a ChannelState.

Inheritance

Constructors

ChannelEvent()
const

Values

initialized → const ChannelEvent

The channel has been initialized but no attach has yet been attempted.

attaching → const ChannelEvent

An attach has been initiated by sending a request to Ably.

This is a transient state, followed either by a transition to ATTACHED, SUSPENDED, or FAILED.

attached → const ChannelEvent

The attach has succeeded.

In the ATTACHED state a client may publish and subscribe to messages, or be present on the channel.

detaching → const ChannelEvent

A detach has been initiated on an ATTACHED channel by sending a request to Ably.

This is a transient state, followed either by a transition to DETACHED or FAILED.

detached → const ChannelEvent

The channel, having previously been ATTACHED, has been detached by the user.

suspended → const ChannelEvent

The channel, having previously been ATTACHED, has lost continuity, usually due to the client being disconnected from Ably for longer than two minutes.

It will automatically attempt to reattach as soon as connectivity is restored.

failed → const ChannelEvent

An indefinite failure condition.

This state is entered if a channel error has been received from the Ably service, such as an attempt to attach without the necessary access rights.

update → const ChannelEvent

An event for changes to channel conditions that do not result in a change in ChannelState.

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<ChannelEvent>
A constant List of the values in this enum, in order of their declaration.