ConnectionStatus

(CHA-CS1) The different states that the connection can be in through its lifecycle.

Entries

Link copied to clipboard

(CHA-CS1a) A temporary state for when the library is first initialized.

Link copied to clipboard

(CHA-CS1b) The library is currently connecting to Ably.

Link copied to clipboard

(CHA-CS1c) The library is currently connected to Ably.

Link copied to clipboard

(CHA-CS1d) The library is currently disconnected from Ably, but will attempt to reconnect.

Link copied to clipboard

(CHA-CS1e) The library is in an extended state of disconnection, but will attempt to reconnect.

Link copied to clipboard

(CHA-CS1f) The library is currently disconnected from Ably and will not attempt to reconnect.

Link copied to clipboard

(CHA-CS1g) An explicit request by the developer to close the connection has been sent to the Ably service. If a reply is not received from Ably within a short period of time, the connection is forcibly terminated and the connection status becomes Closed.

Link copied to clipboard

(CHA-CS1h) The connection has been explicitly closed by the client. In the closed state, no reconnection attempts are made automatically. No connection state is preserved by the service or the library.

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.