chat-android/com.ably.chat/RoomStatus

RoomStatus

enum RoomStatus : Enum<RoomStatus>

(CHA-RS1) The different states that a room can be in throughout its lifecycle.

Entries

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

(CHA-RS1b) The library is currently attempting to attach the room.

(CHA-RS1c) The room is currently attached and receiving events.

(CHA-RS1d) The room is currently detaching and will not receive events.

(CHA-RS1e) The room is currently detached and will not receive events.

(CHA-RS1f) The room is in an extended state of detachment, but will attempt to re-attach when able.

(CHA-RS1g) The room is currently detached and will not attempt to re-attach. User intervention is required.

(CHA-RS1h) The room is in the process of releasing. Attempting to use a room in this state may result in undefined behavior.

(CHA-RS1i) The room has been released and is no longer usable.

Properties

val entries: EnumEntries<RoomStatus>

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

val name: String

val ordinal: Int

val stateName: String

Functions

fun valueOf(value: String): RoomStatus

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

fun values(): Array<RoomStatus>

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