Package io.ably.lib.types

Interface Summary

Interface	Description
AsyncHttpPaginatedResponse.Callback	An interface allowing a client to be notified of the outcome of an asynchronous operation.
AsyncPaginatedResult<T>	A type that represents a page of results from a paginated query.
BasePaginatedResult<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.
NonRetriableTokenException	Implement this marker interface in your exception class if the token auth operation should not be retried.
PaginatedResult<T>	Contains a page of results for message or presence history, stats, or REST presence requests.
ReadOnlyMap<K,V>	Exposes a subset of the Map interface, providing read only access only, removing mutating interfaces.

Class Summary

Class	Description
AsyncHttpPaginatedResponse
BaseMessage
Callback.Map<T,U>
Capability	A class representing an Ably Capability, providing convenience methods to simplify creation of token requests
ChannelOptions	Passes additional properties to a Channel or Channel object, such as encryption, ChannelMode and channel parameters.
ChannelProperties	Describes the properties of the channel state.
ClientOptions	Passes additional client-specific properties to the AblyRest or the AblyRealtime.
ConnectionDetails	Contains any constraints a client should adhere to and provides additional metadata about a Connection, such as if a request to ChannelBase.publish(java.lang.String, java.lang.Object) a message that exceeds the maximum message size should be rejected immediately without communicating with Ably.
DecodingContext
DeltaExtras
ErrorInfo	A generic Ably error object that contains an Ably-specific status code, and a generic status code.
ErrorResponse
HttpPaginatedResponse	A superset of PaginatedResult which represents a page of results plus metadata indicating the relative queries available to it.
Message	Contains an individual message that is sent to, or received from, Ably.
Message.Batch	Sets the channel names and message contents to AblyBase.publishBatch(io.ably.lib.types.Message.Batch[], io.ably.lib.types.ChannelOptions).
Message.Serializer
MessageExtras
MessageExtras.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
ProtocolMessage.AuthDetails	Contains the token string used to authenticate a client with Ably.
ProtocolSerializer
ProxyOptions
PublishResponse	Contains the responses from a PublishResponse PublishResponse#publish request.
Stats	Contains application statistics for a specified time interval and time period.
Stats.ConnectionTypes	Contains a breakdown of summary stats data for different (TLS vs non-TLS) connection types.
Stats.MessageCategory
Stats.MessageCount	Contains the aggregate counts for messages and data transferred.
Stats.MessageTraffic	Contains a breakdown of summary stats data for traffic over various transport types.
Stats.MessageTypes	Contains a breakdown of summary stats data for different (channel vs presence) message types.
Stats.ProcessedCount
Stats.ProcessedMessages
Stats.PushedMessages	Details the stats on push notifications.
Stats.RequestCount	Contains the aggregate counts for requests made.
Stats.ResourceCount	Contains the 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 Summary

Enum	Description
ChannelMode	Describes the possible flags used to configure client capabilities, using ChannelOptions.
PresenceMessage.Action	Describes the possible actions members in the presence set can emit.
ProtocolMessage.Action
ProtocolMessage.Flag
Stats.Granularity	Describes the interval unit over which statistics are gathered.

Exception Summary

Exception	Description
AblyException	An exception type encapsulating an Ably error code
AblyException.HostFailedException
MessageDecodeException	Special AblyException for message decoding problems