Package-level declarations

This is the core client for Ably chat. It provides access to chat rooms.

Configuration options for the chat client.

Represents a connection to Ably.

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

Represents a change in the status of the connection.

An interface to be implemented by objects that can emit discontinuities to listeners. Spec: CHA-RL15

Error codes for the Chat SDK.

Headers are a flat key-value map that can be attached to chat messages.

Http Status Codes

Represents the different levels of logging that can be used.

Represents a single message in a chat room.

Payload for a message event.

All chat message events.

[Headers type for chat messages.

Metadata type for chat messages.

Represents the message options for a chat room.

The message reaction that was received.

Represents a summary of all reactions on a message.

Represents a summary of reactions associated with a particular message.

Event interface representing a summary of message reactions. This event aggregates different types of reactions (single, distinct, counter) for a specific message.

(CHA-MR2) Represents the type of reactions that can be applied to a message. Each reaction type defines unique rules for how reactions from clients are handled and counted towards the reaction summary.

This interface is used to interact with messages in a chat room: subscribing to new messages, fetching history, or sending messages.

Add, delete, and subscribe to message reactions.

A response object that allows you to control a message subscription.

Metadata is a map of extra information that can be attached to chat messages. It is not used by Ably and is sent as part of the realtime message payload. Example use cases are setting custom styling like background or text colors or fonts, adding links to external images, emojis, etc.

This interface is used to interact with occupancy in a chat room: subscribing to occupancy updates and fetching the current room occupancy metrics.

Represents the occupancy of a chat room.

Represents the occupancy options for a chat room.

The type for metadata contained in the operations field of a chat message. This is a key-value pair where the key is a string, and the value is a string, it represents the metadata supplied to a message update or deletion request.

Represents direction to query messages in.

Represents the result of a paginated query.

This interface is used to interact with presence in a chat room: subscribing to presence events, fetching presence members, or sending presence events (join,update,leave).

Type for PresenceEvent

Enum representing presence events.

Type for PresenceMember

Represents the presence options for a chat room.

Realtime chat message names.

Represents a room-level reaction.

Headers type for chat messages.

Metadata type for chat messages.

Represents a chat room.

Room events.

Represents the options for a given chat room.

Room reaction events. This is used for the realtime system since room reactions have only one event: "roomReaction".

This interface is used to interact with room-level reactions in a chat room: subscribing to reactions and sending them.

Represents the reactions options for a chat room.

Manages the lifecycle of chat rooms.

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

Represents a change in the status of the room. (CHA-RS4)

Represents a subscription that can be unsubscribed from. This interface provides a way to clean up and remove subscriptions when they are no longer needed.

This interface is used to interact with typing in a chat room including subscribing to typing events and fetching the current set of typing clients.

Enum representing typing events.

Represents the typing options for a chat room.

Represents a typing event.

Enum representing the typing set event types.

Spec: CHA-RC4