All Classes and Interfaces
Class
Description
A client that offers a simple stateless API to interact directly with Ably's REST API.
A collection of Channels associated with an Ably instance.
Bridges the path-based LiveObjects implementation to the core Ably client, exposing the
client configuration, connection and channel state it needs without coupling it to the
concrete
AblyRealtime type.An exception type encapsulating an Ably error code
A client that extends the functionality of the
AblyRest and provides additional realtime-specific features.A collection of Channels associated with this Ably Realtime instance.
A client that offers a simple stateless API to interact directly with Ably's REST API.
Default
AblyClientAdapter implementation backed by an AblyRealtime client.Enumerates the possible values of the
Annotation.action field of an Annotation
An interface allowing a client to be notified of the outcome
of an asynchronous operation.
A HttpScheduler that uses a thread pool to run HTTP operations.
An object that encapsulates parameters of a REST query with a paginated response
A type that represents a page of results from a paginated query.
Token-generation and authentication operations for the Ably API.
Authentication methods
Passes authentication-specific properties in authentication requests to Ably.
An interface providing update result for onAuthUpdated
An interface providing completion callbackk for renewAuth
An interface implemented by a callback that provides either tokens,
or signed token requests, in response to a request with given token params.
Contains an Ably Token and its associated metadata.
Defines the properties of an Ably Token.
Contains the properties of a request for a token to Ably.
A Base64 encoder/decoder.
A paginated query base implementation that can be used sync or asynchronously.
Wraps a Http.Request<BasePaginatedResult> to fixate on either a sync or an async interface.
A ResultRequest that has already failed due to a previous condition.
A type that represents a page of results from a paginated query.
A read-only
Instance bound to a binary primitive value
(a byte[]).A
PathObject whose underlying value is expected to be a binary blob
(a byte[]).A read-only
Instance bound to a Boolean primitive value.A
PathObject whose underlying value is expected to be a Boolean.An interface allowing a client to be notified of the outcome
of an asynchronous operation.
A class representing an Ably Capability, providing
convenience methods to simplify creation of token requests
Enables messages to be published and subscribed to.
A class representing a Channel in the Ably REST API.
An interface whereby a client maybe notified of message on a channel.
Describes the events emitted by a
Channel object.Describes the possible flags used to configure client capabilities, using
ChannelOptions.Passes additional properties to a
Channel or Channel object,
such as encryption, ChannelMode and channel parameters.Describes the properties of the channel state.
Describes the possible states of a
Channel object.An interface whereby a client may be notified of state changes for a channel.
Contains state change information emitted by
Channel objects.Passes additional client-specific properties to the
AblyRest or the AblyRealtime.Abstraction over time-related operations used throughout the SDK.
An interface allowing a client to be notified of the outcome
of an asynchronous operation.
A Multicaster instance is used in the Ably library to manage a list
of client listeners against certain operations.
Enables the management of a connection to Ably.
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.Describes the events emitted by a
Connection object.Methods on the channels map owned by the
AblyRealtime instance
which the ConnectionManager needs access to.event queueing
a class encapsulating information
associated with a currentState change
request or notification
Describes the realtime
Connection object states.An interface whereby a client may be notified of state changes for a connection.
Contains
ConnectionState change information emitted by the Connection object.Payload of a
ObjectOperationAction.COUNTER_CREATE operation, describing the
initial state of the created LiveCounter object.Payload of a
ObjectOperationAction.COUNTER_INC operation, describing an amount
by which a LiveCounter object is incremented.Contains the properties required to configure the encryption of
Message payloads.Internal; a cipher used to decrypt plaintext from ciphertext, for a channel.
Internal; a cipher used to encrypt plaintext to ciphertext, for a channel.
Contains the properties of a device registered for push notifications.
Contains the details of the push registration of a device.
A generic Ably error object that contains an Ably-specific status code, and a generic status code.
A generic interface for event registration and delivery used in a number of the types in the Realtime client library.
An annotation indicating an experimental API.
Object to encapsulate primary host name and shuffled fallback host names.
A high level wrapper of both a sync and an async HttpScheduler.
HttpCore performs authenticated HTTP synchronously.
Exception signifying that an httpCore request failed with a WWW-Authenticate response
Interface for an entity that performs type-specific processing on an httpCore response body
Interface for an entity that supplies an httpCore request body
A type encapsulating an httpCore response
Interface for an entity that performs type-specific processing on an httpCore response
A superset of
PaginatedResult which represents a page of results plus metadata indicating the relative queries available to it.HttpScheduler schedules HttpCore operations to an Executor, exposing a generic async API.
HttpUtils: utility methods for Http operations
Internal
A RequestBody wrapping a byte array
A RequestBody wrapping a JSON-serialisable object
A direct-reference view of a single resolved LiveObject (
LiveMap or
LiveCounter) or primitive value.Listener interface for instance subscriptions created via
LiveMapInstance.subscribe(InstanceListener) or
LiveCounterInstance.subscribe(InstanceListener).Event delivered to
InstanceListener.onUpdated(InstanceSubscriptionEvent) when
the LiveObject wrapped by a subscribed LiveMapInstance or
LiveCounterInstance is updated.A map implemented using a
ConcurrentHashMap.A read-only
Instance bound to a JsonArray primitive value.A
PathObject whose underlying value is expected to be a JsonArray.A read-only
Instance bound to a JsonObject primitive value.A
PathObject whose underlying value is expected to be a JsonObject.An immutable value type representing the intent to create a new
LiveCounter object with a specific initial count.A
Instance bound to a LiveCounter.A
PathObject whose underlying value is expected to be a LiveCounter.An immutable value type representing the intent to create a new
LiveMap object with specific initial entries.A
Instance bound to a LiveMap.A
PathObject whose underlying value is expected to be a LiveMap.The union of values assignable to a
LiveMap key:
Boolean | Binary | Number | String | JsonArray | JsonObject |
LiveCounter | LiveMap.The LiveObjectsPlugin interface provides a mechanism for managing and interacting with
live data objects in a real-time environment.
Reflectively constructs the LiveObjects plugin implementation.
Default log handler class that sends output to System.out.
Payload of a
ObjectOperationAction.MAP_CLEAR operation.Payload of a
ObjectOperationAction.MAP_CREATE operation, describing the
initial state of the created LiveMap object.Payload of a
ObjectOperationAction.MAP_REMOVE operation, describing a key
being removed from a LiveMap object.Payload of a
ObjectOperationAction.MAP_SET operation, describing a key being
set on a LiveMap object.Contains an individual message that is sent to, or received from, Ably.
Sets the channel names and message contents to
AblyBase.publishBatch(io.ably.lib.types.Message.Batch[], io.ably.lib.types.ChannelOptions).Contains information about annotations associated with a particular message.
Special AblyException for message decoding problems
Represents metadata about a message operation (update/delete).
MessageReader: internal
Utility class to convert response bodies in different formats to Message
and Message arrays.
Contains the details regarding the current version of the message - including when it was updated and by whom.
Collection of members who are listeners, with methods that are safe to be called from any thread.
Implement this marker interface in your exception class if the token auth operation should not be retried.
A read-only
Instance bound to a Number primitive value.A
PathObject whose underlying value is expected to be a Number.Represents a value in an object on a channel.
Payload of an
ObjectOperationAction.OBJECT_DELETE operation.The user-facing representation of an inbound object message that carried an operation.
The user-facing representation of an operation applied to an object on a channel.
The action of an
ObjectOperation, defining the type of operation that was
applied to an object on a channel.Serializer interface for converting between objects and their MessagePack or JSON representations.
Holds the lazily-initialized
ObjectSerializer singleton.Represents the value at a given key in a
LiveMap object.The conflict-resolution semantics used by a
LiveMap object.Interface for receiving notifications about Objects synchronization state changes.
Represents the synchronization state of Ably Objects.
An object that encapsulates parameters of a REST query with a paginated response
Contains a page of results for message or presence history, stats, or REST presence requests.
A class encapsulating a key/value pair
A lazy, path-based reference into the LiveObjects graph rooted at the channel's root
LiveMap.Listener interface for path-based subscriptions created via
PathObject.subscribe(PathObjectListener) or
PathObject.subscribe(PathObjectListener, PathObjectSubscriptionOptions).Event delivered to
PathObjectListener.onUpdated(PathObjectSubscriptionEvent)
when a change affects the subscribed path.Optional subscription options accepted by
PathObject.subscribe(PathObjectListener, PathObjectSubscriptionOptions).Enables the presence set to be entered and subscribed to, and the historic presence set to be retrieved for a channel.
An interface allowing a listener to be notified of arrival of a presence message.
A class representing an individual presence update to be sent or received
via the Ably Realtime service.
Describes the possible actions members in the presence set can emit.
PresenceSerializer: internal
Utility class to convert response bodies in different formats to PresenceMessage
and PresenceMessage arrays.
A message sent and received over the Realtime protocol.
Contains the token string used to authenticate a client with Ably.
Contains the responses from a
PublishResponse PublishResponse#publish request.Contains the result of a publish operation.
Enables a device to be registered and deregistered from receiving push notifications.
Enables a device to be registered and deregistered from receiving push notifications.
Contains the subscriptions of a device, or a group of devices sharing the same clientId,
has to a channel in order to receive push notifications.
Enables device push channel subscriptions.
Enables the management of push notification registrations with Ably.
Exposes a subset of the Map interface, providing read only access only, removing mutating interfaces.
RealtimeAnnotation provides subscription capabilities for annotations received on a channel.
The RealtimeObject interface is the entry point to the strongly-typed, path-based
LiveObjects API on a channel.
Null-Object guard for
RealtimeObject, used as the value of channel.object
when the LiveObjects plugin is not installed.The RestAnnotation class provides methods to manage and interact with annotations
associated with messages in a specific channel.
This is a decorator for the
SSLSocketFactory which modifies the enabled TLS protocols
for each created SSLSocket to only use the protocols which are considered to be safe.Contains application statistics for a specified time interval and time period.
Contains a breakdown of summary stats data for different (TLS vs non-TLS) connection types.
Describes the interval unit over which statistics are gathered.
Contains the aggregate counts for messages and data transferred.
Contains a breakdown of summary stats data for traffic over various transport types.
Contains a breakdown of summary stats data for different (channel vs presence) message types.
Details the stats on push notifications.
Contains the aggregate counts for requests made.
Contains the aggregate data for usage of a resource in a specific scope.
StatsReader: internal
Utility class to convert response bodies in different formats to Stats data.
Interface for an entity that supplies key value store
A read-only
Instance bound to a String primitive value.A
PathObject whose underlying value is expected to be a String.Represents a registration for receiving events from a subscribe operation.
A summary of all the annotations that have been made to the message.
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.
A HttpScheduler that runs everything in the current thread.
Contains the result of an update or delete message operation.
The type of a value resolved by a
PathObject or wrapped by an
Instance in the LiveObjects graph.public factory API