All Classes

Class	Description
AblyBase	AblyBase The top-level class to be instanced for the Ably REST library.
AblyException	An exception type encapsulating an Ably error code
AblyException.HostFailedException
AblyRealtime	AblyRealtime The top-level class to be instanced for the Ably Realtime library.
AblyRest
AsyncHttpPaginatedQuery
AsyncHttpPaginatedResponse
AsyncHttpPaginatedResponse.Callback	An interface allowing a client to be notified of the outcome of an asynchronous operation.
AsyncHttpScheduler	A HttpScheduler that uses a thread pool to run HTTP operations.
AsyncPaginatedQuery<T>	An object that encapsulates parameters of a REST query with a paginated response
AsyncPaginatedResult<T>	A type that represents a page of results from a paginated query.
Auth	Token-generation and authentication operations for the Ably API.
Auth.AuthMethod	Authentication methods
Auth.AuthOptions	Authentication options when instancing the Ably library
Auth.TokenCallback	An interface implemented by a callback that provides either tokens, or signed token requests, in response to a request with given token params.
Auth.TokenDetails	A class providing details of a token and its associated metadata, provided when the system successfully requests a token from the system.
Auth.TokenParams	A class providing parameters of a token request.
Auth.TokenRequest	A class providing parameters of a token request.
Base64Coder	A Base64 encoder/decoder.
BaseMessage
BaseMessage.Serializer
BasePaginatedQuery<T>	A paginated query base implementation that can be used sync or asynchronously.
BasePaginatedQuery.ResultRequest<T>	Wraps a Http.Request> to fixate on either a sync or an async interface.
BasePaginatedQuery.ResultRequest.Failed<T>	A ResultRequest that has already failed due to a previous condition.
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.
Callback.Map<T,U>
Capability	A class representing an Ably Capability, providing convenience methods to simplify creation of token requests
Channel
Channel
Channel.MessageListener
ChannelBase	A class representing a Channel belonging to this application.
ChannelBase	A class representing a Channel in the Ably REST API.
ChannelBase.MessageListener	An interface whereby a client maybe notified of messages changes on a channel.
ChannelEvent	Channel event
ChannelOptions
ChannelProperties	(RTL15) Channel#properties attribute is a ChannelProperties object representing properties of the channel state
ChannelState	Channel states.
ChannelStateListener	An interface whereby a client may be notified of state changes for a channel.
ChannelStateListener.ChannelStateChange	Channel state change.
ChannelStateListener.Filter
ChannelStateListener.Multicaster
ClientOptions	Options: Ably library options for REST and Realtime APIs
CompletionListener	An interface allowing a client to be notified of the outcome of an asynchronous operation.
CompletionListener.FromCallback
CompletionListener.Multicaster	A Multicaster instance is used in the Ably library to manage a list of client listeners against certain operations.
CompletionListener.ToCallback
Connection	A class representing the connection associated with an AblyRealtime instance.
ConnectionDetails
ConnectionEvent	Connection event
ConnectionManager
ConnectionManager.QueuedMessage	event queueing
ConnectionManager.StateIndication	a class encapsulating information associated with a currentState change request or notification
ConnectionState	Connection states.
ConnectionStateListener
ConnectionStateListener.ConnectionStateChange
ConnectionStateListener.Filter
ConnectionStateListener.Multicaster
Crypto	Utility classes and interfaces for message payload encryption.
Crypto.ChannelCipher	Interface for a ChannelCipher instance that may be associated with a Channel.
Crypto.CipherParams	A class encapsulating the client-specifiable parameters for the cipher.
CurrentThreadExecutor
DebugOptions
DebugOptions.RawHttpListener
DebugOptions.RawProtocolListener
Defaults
DeviceDetails
DeviceDetails.Push
DeviceDetails.Push.State
ErrorInfo	An exception type encapsulating error information containing an Ably-specific error code and generic status code.
ErrorResponse
EventEmitter<Event,Listener>	An interface exposing the ability to register listeners for a class of events
Experimental	An annotation indicating an experimental API.
Hosts	Object to encapsulate primary host name and shuffled fallback host names.
Http	A high level wrapper of both a sync and an async HttpScheduler.
Http.Execute<Result>
HttpAuth
HttpAuth.Type
HttpConstants
HttpConstants.ContentTypes
HttpConstants.Headers
HttpConstants.Methods
HttpCore	HttpCore performs authenticated HTTP synchronously.
HttpCore.AuthRequiredException	Exception signifying that an httpCore request failed with a WWW-Authenticate response
HttpCore.BodyHandler<T>	Interface for an entity that performs type-specific processing on an httpCore response body
HttpCore.RequestBody	Interface for an entity that supplies an httpCore request body
HttpCore.Response	A type encapsulating an httpCore response
HttpCore.ResponseHandler<T>	Interface for an entity that performs type-specific processing on an httpCore response
HttpHelpers
HttpPaginatedQuery
HttpPaginatedResponse	A type that represents a page of results from a paginated http query.
HttpScheduler<Executor extends java.util.concurrent.Executor>	HttpScheduler schedules HttpCore operations to an Executor, exposing a generic async API.
HttpUtils	HttpUtils: utility methods for Http operations Internal
HttpUtils.ByteArrayRequestBody	A RequestBody wrapping a byte array
HttpUtils.FormRequestBody
HttpUtils.JsonRequestBody	A RequestBody wrapping a JSON-serialisable object
ITransport
ITransport.ConnectListener
ITransport.Factory
ITransport.Mode
ITransport.TransportParams
JsonUtils
JsonUtils.JsonUtilsObject
Log
Log.DefaultHandler	Default log handler class that sends output to System.out.
Log.LogHandler
Message	A class representing an individual message to be sent or received via the Ably Realtime service.
Message.Batch	A specification for a collection of messages to be sent using the batch API
Message.Serializer
MessageDecodeException	Special AblyException for message decoding problems
MessageSerializer	MessageReader: internal Utility class to convert response bodies in different formats to Message and Message arrays.
Multicaster<T>
NetworkConnectivity
NetworkConnectivity.DefaultNetworkConnectivity
NetworkConnectivity.DelegatedNetworkConnectivity
NetworkConnectivity.NetworkConnectivityListener
PaginatedQuery<T>	An object that encapsulates parameters of a REST query with a paginated response
PaginatedResult<T>	A type that represents a page of results from a paginated query.
Param	A class encapsulating a key/value pair
Platform
Presence	A class that provides access to presence operations and state for the associated Channel.
Presence.PresenceListener	An interface allowing a listener to be notified of arrival of presence messages
PresenceMessage	A class representing an individual presence update to be sent or received via the Ably Realtime service.
PresenceMessage.Action	Presence Action: the event signified by a PresenceMessage
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.Action
ProtocolMessage.ActionSerializer
ProtocolMessage.AuthDetails
ProtocolMessage.Flag
ProtocolSerializer
ProxyOptions
PublishResponse	PublishResponse
Push
PushBase
PushBase.Admin
PushBase.ChannelSubscription
PushBase.ChannelSubscriptions
PushBase.DeviceRegistrations
Serialisation
Serialisation.FromJsonElement<T>
Serialisation.HttpBodyHandler<T>
Serialisation.HttpResponseHandler<T>
Stats	A class encapsulating a Stats datapoint.
Stats.ConnectionTypes	A breakdown of summary stats data for different (tls vs non-tls) connection types.
Stats.Granularity
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.
StringUtils
SyncHttpScheduler	A HttpScheduler that runs everything in the current thread.
WebSocketTransport
WebSocketTransport.Factory	public factory API