chat-android/com.ably.chat/ConnectionStatus

ConnectionStatus

enum ConnectionStatus : Enum<ConnectionStatus>

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

Entries

Initialized

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

Connecting

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

Connected

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

Disconnected

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

Suspended

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

Failed

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

Properties

entries

val entries: EnumEntries<ConnectionStatus>

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

name

val name: String

ordinal

val ordinal: Int

stateName

val stateName: String

Functions

valueOf

fun valueOf(value: String): ConnectionStatus

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.)

values

fun values(): Array<ConnectionStatus>

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