| Interface | Description |
|---|---|
| AsyncPaginatedResult<T> |
A type that represents a page of results from a paginated query.
|
| Callback<T> |
An interface allowing a client to be notified of the outcome
of an asynchronous operation.
|
| PaginatedResult<T> |
A type that represents a page of results from a paginated query.
|
| Class | Description |
|---|---|
| BaseMessage | |
| BaseMessage.Serializer | |
| Capability |
A class representing an Ably Capability, providing
convenience methods to simplify creation of token requests
|
| ChannelOptions | |
| ClientOptions |
Options: Ably library options for REST and Realtime APIs
|
| ConnectionDetails | |
| ErrorInfo |
An exception type encapsulating error information containing
an Ably-specific error code and generic status code.
|
| ErrorResponse | |
| Message |
A class representing an individual message to be sent or received
via the Ably Realtime service.
|
| Message.Serializer | |
| MessageSerializer |
MessageReader: internal
Utility class to convert response bodies in different formats to Message
and Message arrays.
|
| Param |
A class encapsulating a key/value pair
|
| PresenceMessage |
A class representing an individual presence update to be sent or received
via the Ably Realtime service.
|
| PresenceMessage.ActionSerializer | |
| PresenceMessage.Serializer | |
| PresenceSerializer |
PresenceSerializer: internal
Utility class to convert response bodies in different formats to PresenceMessage
and PresenceMessage arrays.
|
| ProtocolMessage |
A message sent and received over the Realtime protocol.
|
| ProtocolMessage.ActionSerializer | |
| ProtocolSerializer | |
| Stats |
A class encapsulating a Stats datapoint.
|
| Stats.ConnectionTypes |
A breakdown of summary stats data for different (tls vs non-tls)
connection types.
|
| Stats.MessageCount |
A datapoint for message volume (number of messages plus aggregate data size)
|
| Stats.MessageTraffic |
A breakdown of summary stats data for traffic over various transport types.
|
| Stats.MessageTypes |
A breakdown of summary stats data for different (message vs presence)
message types.
|
| Stats.RequestCount |
Aggregate data for numbers of requests in a specific scope.
|
| Stats.ResourceCount |
Aggregate data for usage of a resource in a specific scope.
|
| StatsReader |
StatsReader: internal
Utility class to convert response bodies in different formats to Stats data.
|
| Enum | Description |
|---|---|
| PresenceMessage.Action |
Presence Action: the event signified by a PresenceMessage
|
| ProtocolMessage.Action | |
| ProtocolMessage.Flag | |
| Stats.Granularity |
| Exception | Description |
|---|---|
| AblyException |
An exception type encapsulating an Ably error code
|