Package-level declarations
Types
This is the core client for Ably chat. It provides access to chat rooms.
Configuration options for the chat client.
A specialized exception that represents an error occurring within a chat context.
Payload for a message event.
All chat message events.
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.
A type alias representing a listener function that reacts to changes in connection status. The listener receives a ConnectionStatusChange object, which contains details about the status transition, including the current and previous connection statuses, any associated error information, and a possible retry delay.
An interface to be implemented by objects that can emit discontinuities to listeners. Spec: CHA-RL15
Handler for discontinuity events
Http Status Codes
Represents the latest action of a message.
A listener for message events in a chat room.
A listener for individual message reaction events.
The message reaction that was received.
A listener for summary message reaction events.
Represents a raw message reaction event, such as when a reaction is added or removed from a message.
Add, delete, and subscribe to message reactions.
Represents a summary of all reactions on a 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.
Represents the message options for a chat room.
A response object that allows you to control a message subscription.
Contains the details regarding the current version of the message - including when it was updated and by whom.
Represents the occupancy of a chat room.
Represents the occupancy event.
A listener that is called when the occupancy of a chat room changes.
Represents the occupancy options for a chat room.
Represents the result of a paginated query.
Enum representing presence events.
Type for PresenceListener
Type for PresenceMember
Represents the presence options for a chat room.
Realtime chat message names.
Represents a chat room.
Represents the options for a given chat room.
Represents a room-level reaction.
Room reaction events. This is used for the realtime system since room reactions have only one event: "roomReaction".
The listener function type for room-level reactions.
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.
(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)
A function that can be called when the room status changes.
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.
The per-name value for the multiple.v1 aggregation method.
The summary entry for aggregated annotations that use the flag.v1 aggregation method; also the per-name value for some other aggregation methods.
Enum representing typing events.
A listener which listens for typing events.
Represents the typing options for a chat room.
Represents a typing event.
Enum representing the typing set event types.