- ABLY_AGENT_HEADER - Static variable in class io.ably.lib.transport.Defaults
-
- ABLY_AGENT_PARAM - Static variable in class io.ably.lib.transport.Defaults
-
- ABLY_AGENT_VERSION - Static variable in class io.ably.lib.transport.Defaults
-
- ABLY_VERSION - Static variable in class io.ably.lib.transport.Defaults
-
The level of compatibility with the Ably service that this SDK supports, also referred to as the 'wire protocol version'.
- ABLY_VERSION_HEADER - Static variable in class io.ably.lib.transport.Defaults
-
- ABLY_VERSION_NUMBER - Static variable in class io.ably.lib.transport.Defaults
-
- ABLY_VERSION_PARAM - Static variable in class io.ably.lib.transport.Defaults
-
- AblyBase - Class in io.ably.lib.rest
-
A client that offers a simple stateless API to interact directly with Ably's REST API.
- AblyBase(String, PlatformAgentProvider) - Constructor for class io.ably.lib.rest.AblyBase
-
Constructs a client object using an Ably API key or token string.
- AblyBase(ClientOptions, PlatformAgentProvider) - Constructor for class io.ably.lib.rest.AblyBase
-
- AblyBase.Channels - Interface in io.ably.lib.rest
-
A collection of Channels associated with an Ably instance.
- AblyException - Exception in io.ably.lib.types
-
An exception type encapsulating an Ably error code
- AblyException(Throwable, ErrorInfo) - Constructor for exception io.ably.lib.types.AblyException
-
Constructor for use where there is an ErrorInfo available
- AblyException.HostFailedException - Exception in io.ably.lib.types
-
- ablyHttpExecute(Http, String, String, Param[], Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>, boolean) - Static method in class io.ably.lib.http.HttpHelpers
-
Make a synchronous HTTP request to an Ably endpoint, using the Ably auth credentials and fallback hosts if necessary
- ablyHttpExecuteWithFallback(String, String, Param[], Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>, boolean, Callback<T>) - Method in class io.ably.lib.http.HttpScheduler
-
Make an asynchronous HTTP request to an Ably endpoint, using the Ably auth credentials and fallback hosts if necessary
- ablyHttpExecuteWithRetry(String, String, String, Param[], Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>, boolean, Callback<T>) - Method in class io.ably.lib.http.HttpScheduler
-
Make an asynchronous HTTP request to an Ably endpoint, using the Ably auth credentials and reauthentication if necessary
- AblyRealtime - Class in io.ably.lib.realtime
-
A client that extends the functionality of the
AblyRest and provides additional realtime-specific features.
- AblyRealtime(String) - Constructor for class io.ably.lib.realtime.AblyRealtime
-
Constructs a Realtime client object using an Ably API key or token string.
- AblyRealtime(ClientOptions) - Constructor for class io.ably.lib.realtime.AblyRealtime
-
Constructs a RealtimeClient object using an Ably
ClientOptions object.
- AblyRealtime.Channels - Interface in io.ably.lib.realtime
-
A collection of Channels associated with this Ably Realtime instance.
- AblyRest - Class in io.ably.lib.rest
-
A client that offers a simple stateless API to interact directly with Ably's REST API.
- AblyRest(String) - Constructor for class io.ably.lib.rest.AblyRest
-
Constructs a client object using an Ably API key or token string.
- AblyRest(ClientOptions) - Constructor for class io.ably.lib.rest.AblyRest
-
- ACCEPT - Static variable in class io.ably.lib.http.HttpConstants.Headers
-
- accessToken - Variable in class io.ably.lib.types.ProtocolMessage.AuthDetails
-
The authentication token string.
- ackRequired(ProtocolMessage) - Static method in class io.ably.lib.types.ProtocolMessage
-
- action - Variable in class io.ably.lib.types.PresenceMessage
-
- action - Variable in class io.ably.lib.types.ProtocolMessage
-
- ActionSerializer() - Constructor for class io.ably.lib.types.PresenceMessage.ActionSerializer
-
- ActionSerializer() - Constructor for class io.ably.lib.types.ProtocolMessage.ActionSerializer
-
- add(String, Object) - Method in class io.ably.lib.util.JsonUtils.JsonUtilsObject
-
- add(T) - Method in class io.ably.lib.util.Multicaster
-
- addListener(NetworkConnectivity.NetworkConnectivityListener) - Method in class io.ably.lib.transport.NetworkConnectivity
-
- addOperation(String, String) - Method in class io.ably.lib.types.Capability
-
Add an operation to an existing Capability instance for a
given resource.
- addRequestIds - Variable in class io.ably.lib.types.ClientOptions
-
When true, every REST request to Ably should include a random string in the request_id query string parameter.
- addResource(String, String...) - Method in class io.ably.lib.types.Capability
-
Add a resource to an existing Capability instance with the
given set of operations.
- admin - Variable in class io.ably.lib.push.PushBase
-
- AGENT_DIVIDER - Static variable in class io.ably.lib.util.AgentHeaderCreator
-
Separates agent name from agent version.
- AgentHeaderCreator - Class in io.ably.lib.util
-
- AgentHeaderCreator() - Constructor for class io.ably.lib.util.AgentHeaderCreator
-
- agents - Variable in class io.ably.lib.types.ClientOptions
-
A set of additional entries for the Ably agent header.
- all - Variable in class io.ably.lib.types.Stats
-
- all - Variable in class io.ably.lib.types.Stats.ConnectionTypes
-
A
Stats.ResourceCount object containing a breakdown of usage by scope over TLS connections (both TLS and non-TLS).
- all - Variable in class io.ably.lib.types.Stats.MessageTraffic
-
A
Stats.MessageTypes object containing a breakdown of usage by message type
for all messages (includes realtime, rest and webhook messages).
- all - Variable in class io.ably.lib.types.Stats.MessageTypes
-
A
Stats.MessageCount object containing the count and byte value of messages and presence messages.
- apiRequests - Variable in class io.ably.lib.types.Stats
-
- apply(ChannelStateListener, ChannelEvent, Object...) - Method in class io.ably.lib.realtime.ChannelBase
-
- apply(ConnectionStateListener, ConnectionEvent, Object...) - Method in class io.ably.lib.realtime.Connection
-
- apply(Listener, Event, Object...) - Method in class io.ably.lib.util.EventEmitter
-
- apply(Event, Object...) - Method in class io.ably.lib.util.EventEmitter.Filter
-
- array(Param) - Static method in class io.ably.lib.types.Param
-
- asJson() - Method in class io.ably.lib.rest.Auth.TokenDetails
-
Convert a TokenDetails into a JSON string.
- asJson() - Method in class io.ably.lib.rest.Auth.TokenRequest
-
Convert a TokenParams into a JSON string.
- asJsonElement() - Method in class io.ably.lib.rest.Auth.TokenDetails
-
Convert a TokenDetails into a JSON object.
- asJsonElement() - Method in class io.ably.lib.rest.Auth.TokenRequest
-
Convert a TokenParams into a JSON object.
- asJsonObject() - Method in class io.ably.lib.types.MessageExtras
-
- asJsonRequest(Message) - Static method in class io.ably.lib.types.MessageSerializer
-
JSON encode
- asJsonRequest(Message[]) - Static method in class io.ably.lib.types.MessageSerializer
-
- asJSONRequest(Message.Batch[]) - Static method in class io.ably.lib.types.MessageSerializer
-
- asJsonRequest(PresenceMessage) - Static method in class io.ably.lib.types.PresenceSerializer
-
JSON encode
- asJsonRequest(PresenceMessage[]) - Static method in class io.ably.lib.types.PresenceSerializer
-
- asMap() - Method in class io.ably.lib.rest.Auth.TokenParams
-
Internal; convert a TokenParams to a collection of Params
- asMsgpackRequest(Message) - Static method in class io.ably.lib.types.MessageSerializer
-
Msgpack encode
- asMsgpackRequest(Message[]) - Static method in class io.ably.lib.types.MessageSerializer
-
- asMsgpackRequest(Message.Batch[]) - Static method in class io.ably.lib.types.MessageSerializer
-
- assertAuthorizationHeader(boolean) - Method in class io.ably.lib.rest.Auth
-
Get the Authorization header, forcing the creation of a new token if requested
- assertValidToken() - Method in class io.ably.lib.rest.Auth
-
- async(Callback<AsyncPaginatedResult<T>>) - Method in class io.ably.lib.http.BasePaginatedQuery.ResultRequest
-
- async(Callback<AsyncPaginatedResult<T>>) - Method in class io.ably.lib.http.BasePaginatedQuery.ResultRequest.Failed
-
- async(Callback<Result>) - Method in class io.ably.lib.http.Http.Request
-
- AsyncHttpPaginatedQuery - Class in io.ably.lib.http
-
- AsyncHttpPaginatedQuery(Http, String, String, Param[], Param[], HttpCore.RequestBody) - Constructor for class io.ably.lib.http.AsyncHttpPaginatedQuery
-
- AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult - Class in io.ably.lib.http
-
A private class encapsulating the result of a single page response
- AsyncHttpPaginatedResponse - Class in io.ably.lib.types
-
- AsyncHttpPaginatedResponse() - Constructor for class io.ably.lib.types.AsyncHttpPaginatedResponse
-
- AsyncHttpPaginatedResponse.Callback - Interface in io.ably.lib.types
-
An interface allowing a client to be notified of the outcome
of an asynchronous operation.
- AsyncHttpScheduler - Class in io.ably.lib.http
-
A HttpScheduler that uses a thread pool to run HTTP operations.
- AsyncHttpScheduler(HttpCore, ClientOptions) - Constructor for class io.ably.lib.http.AsyncHttpScheduler
-
- asyncHttpThreadpoolSize - Variable in class io.ably.lib.types.ClientOptions
-
Allows the caller to specify a non-default size for the asyncHttp threadpool
- AsyncPaginatedQuery<T> - Class in io.ably.lib.http
-
An object that encapsulates parameters of a REST query with a paginated response
- AsyncPaginatedQuery(Http, String, Param[], Param[], HttpCore.BodyHandler<T>) - Constructor for class io.ably.lib.http.AsyncPaginatedQuery
-
Construct a PaginatedQuery
- AsyncPaginatedQuery(Http, String, Param[], Param[], HttpCore.RequestBody, HttpCore.BodyHandler<T>) - Constructor for class io.ably.lib.http.AsyncPaginatedQuery
-
Construct a PaginatedQuery
- AsyncPaginatedResult<T> - Interface in io.ably.lib.types
-
A type that represents a page of results from a paginated query.
- attach() - Method in class io.ably.lib.realtime.ChannelBase
-
- attach(CompletionListener) - Method in class io.ably.lib.realtime.ChannelBase
-
- attachSerial - Variable in class io.ably.lib.types.ChannelProperties
-
Starts unset when a channel is instantiated, then updated with the channelSerial
from each
ChannelState.attached event that matches the channel.
- auth - Variable in class io.ably.lib.rest.AblyBase
-
- Auth - Class in io.ably.lib.rest
-
Token-generation and authentication operations for the Ably API.
- auth - Variable in class io.ably.lib.types.ProtocolMessage
-
- Auth.AuthMethod - Enum in io.ably.lib.rest
-
Authentication methods
- Auth.AuthOptions - Class in io.ably.lib.rest
-
Passes authentication-specific properties in authentication requests to Ably.
- Auth.AuthUpdateResult - Interface in io.ably.lib.rest
-
An interface providing update result for onAuthUpdated
- Auth.RenewAuthResult - Interface in io.ably.lib.rest
-
An interface providing completion callbackk for renewAuth
- Auth.TokenCallback - Interface in io.ably.lib.rest
-
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 - Class in io.ably.lib.rest
-
Contains an Ably Token and its associated metadata.
- Auth.TokenParams - Class in io.ably.lib.rest
-
Defines the properties of an Ably Token.
- Auth.TokenRequest - Class in io.ably.lib.rest
-
Contains the properties of a request for a token to Ably.
- authCallback - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
Called when a new token is required.
- authChallenge - Variable in exception io.ably.lib.http.HttpCore.AuthRequiredException
-
- AuthDetails(String) - Constructor for class io.ably.lib.types.ProtocolMessage.AuthDetails
-
Creates AuthDetails object with provided authentication token string.
- authHeaders - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
A set of key-value pair headers to be added to any request made to the authUrl.
- authMethod - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
The HTTP verb to use for any request made to the authUrl, either GET or POST.
- AuthOptions() - Constructor for class io.ably.lib.rest.Auth.AuthOptions
-
Default constructor
- AuthOptions(String) - Constructor for class io.ably.lib.rest.Auth.AuthOptions
-
Convenience constructor, to create an AuthOptions based
on the key string obtained from the application dashboard.
- authorise(Auth.TokenParams, Auth.AuthOptions) - Method in class io.ably.lib.rest.Auth
-
Deprecated.
- AUTHORIZATION - Static variable in class io.ably.lib.http.HttpConstants.Headers
-
- authorize(Auth.TokenParams, Auth.AuthOptions) - Method in class io.ably.lib.rest.Auth
-
Instructs the library to get a new token immediately.
- authParams - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
A set of key-value pair params to be added to any request made to the authUrl.
- AuthRequiredException(Throwable, ErrorInfo) - Constructor for exception io.ably.lib.http.HttpCore.AuthRequiredException
-
- authUrl - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
- autoConnect - Variable in class io.ably.lib.types.ClientOptions
-
When true, the client connects to Ably as soon as it is instantiated.
- c14n(String) - Static method in class io.ably.lib.types.Capability
-
Convenience method to canonicalise a JSON capability expression.
- Callback<T> - Interface in io.ably.lib.types
-
An interface allowing a client to be notified of the outcome
of an asynchronous operation.
- Callback.Map<T,U> - Class in io.ably.lib.types
-
- capability - Variable in class io.ably.lib.rest.Auth.TokenDetails
-
The capabilities associated with this Ably Token.
- capability - Variable in class io.ably.lib.rest.Auth.TokenParams
-
The capabilities associated with this Ably Token.
- Capability - Class in io.ably.lib.types
-
A class representing an Ably Capability, providing
convenience methods to simplify creation of token requests
- Capability() - Constructor for class io.ably.lib.types.Capability
-
Construct a new empty Capability
- category - Variable in class io.ably.lib.types.Stats.MessageCategory
-
- channel - Variable in class io.ably.lib.push.PushBase.ChannelSubscription
-
The channel the push notification subscription is for.
- Channel - Class in io.ably.lib.realtime
-
- Channel - Class in io.ably.lib.rest
-
- channel - Variable in class io.ably.lib.types.ProtocolMessage
-
- Channel.MessageListener - Interface in io.ably.lib.realtime
-
- ChannelBase - Class in io.ably.lib.realtime
-
Enables messages to be published and subscribed to.
- ChannelBase - Class in io.ably.lib.rest
-
A class representing a Channel in the Ably REST API.
- ChannelBase.MessageListener - Interface in io.ably.lib.realtime
-
An interface whereby a client maybe notified of message on a channel.
- ChannelBase.Presence - Class in io.ably.lib.rest
-
Enables the retrieval of the current and historic presence set for a channel.
- ChannelEvent - Enum in io.ably.lib.realtime
-
Describes the events emitted by a
Channel object.
- channelId - Variable in class io.ably.lib.types.PublishResponse
-
The channel name a message was successfully published to, or the channel name for which an error was returned.
- ChannelMode - Enum in io.ably.lib.types
-
Describes the possible flags used to configure client capabilities, using
ChannelOptions.
- ChannelOptions - Class in io.ably.lib.types
-
- ChannelOptions() - Constructor for class io.ably.lib.types.ChannelOptions
-
- ChannelProperties - Class in io.ably.lib.types
-
Describes the properties of the channel state.
- ChannelProperties() - Constructor for class io.ably.lib.types.ChannelProperties
-
- channelRetryTimeout - Variable in class io.ably.lib.types.ClientOptions
-
- channels - Variable in class io.ably.lib.realtime.AblyRealtime
-
- channels - Variable in class io.ably.lib.rest.AblyBase
-
- channels - Variable in class io.ably.lib.types.Message.Batch
-
An array of channel names to publish messages to.
- channels - Variable in class io.ably.lib.types.Stats
-
- channelSerial - Variable in class io.ably.lib.types.ProtocolMessage
-
- ChannelState - Enum in io.ably.lib.realtime
-
Describes the possible states of a
Channel object.
- ChannelStateListener - Interface in io.ably.lib.realtime
-
An interface whereby a client may be notified of state changes for a channel.
- ChannelStateListener.ChannelStateChange - Class in io.ably.lib.realtime
-
Contains state change information emitted by
Channel objects.
- ChannelStateListener.Filter - Class in io.ably.lib.realtime
-
- ChannelStateListener.Multicaster - Class in io.ably.lib.realtime
-
- channelSubscriptions - Variable in class io.ably.lib.push.PushBase.Admin
-
- checkCipherParams(Object) - Static method in class io.ably.lib.util.Crypto
-
Internal; if `cipherParams` is null returns default params otherwise check if params valid and returns them
- checkClientId(BaseMessage, boolean, boolean) - Method in class io.ably.lib.rest.Auth
-
Verify that a message, possibly containing a clientId,
is compatible with Auth.clientId if it is set
- checkConnectivity() - Method in class io.ably.lib.transport.ConnectionManager
-
Determine whether or not the client has connection to the network
without reference to a specific ably host.
- cipherParams - Variable in class io.ably.lib.types.ChannelOptions
-
Requests encryption for this channel when not null,
and specifies encryption-related parameters (such as algorithm, chaining mode, key length and key).
- clear(Field[]) - Method in interface io.ably.lib.push.Storage
-
Removes fields from storage
- clear() - Method in class io.ably.lib.util.Multicaster
-
- clearCachedServerTime() - Method in class io.ably.lib.rest.Auth
-
For testing purposes we need method to clear cached timeDelta
- clientId - Variable in class io.ably.lib.push.PushBase.ChannelSubscription
-
The ID of the client the device, or devices are associated to.
- clientId - Variable in class io.ably.lib.rest.Auth
-
A client ID, used for identifying this client when publishing messages or for presence purposes.
- clientId - Variable in class io.ably.lib.rest.Auth.TokenDetails
-
The client ID, if any, bound to this Ably Token.
- clientId - Variable in class io.ably.lib.rest.Auth.TokenParams
-
A client ID, used for identifying this client when publishing messages or for presence purposes.
- clientId - Variable in class io.ably.lib.rest.DeviceDetails
-
The client ID the device is connected to Ably with.
- clientId - Variable in class io.ably.lib.types.BaseMessage
-
The client ID of the publisher of this message.
- clientId - Variable in class io.ably.lib.types.ClientOptions
-
A client ID, used for identifying this client when publishing messages or for presence purposes.
- clientId - Variable in class io.ably.lib.types.ConnectionDetails
-
Contains the client ID assigned to the token.
- ClientOptions - Class in io.ably.lib.types
-
- ClientOptions() - Constructor for class io.ably.lib.types.ClientOptions
-
Creates a ClientOptions instance used to configure Rest and Realtime clients
- ClientOptions(String) - Constructor for class io.ably.lib.types.ClientOptions
-
Creates a ClientOptions instance used to configure Rest and Realtime clients
- clone() - Method in class io.ably.lib.types.PresenceMessage
-
- close() - Method in class io.ably.lib.http.Http
-
- close() - Method in class io.ably.lib.http.HttpScheduler
-
- close() - Method in class io.ably.lib.realtime.AblyRealtime
-
- close() - Method in class io.ably.lib.realtime.Connection
-
- close() - Method in class io.ably.lib.rest.AblyBase
-
- close() - Method in class io.ably.lib.transport.ConnectionManager
-
- close() - Method in interface io.ably.lib.transport.ITransport
-
Close this transport.
- close() - Method in class io.ably.lib.transport.WebSocketTransport
-
- close() - Method in class io.ably.lib.util.CurrentThreadExecutor
-
- CloseableExecutor - Interface in io.ably.lib.http
-
- code - Variable in enum io.ably.lib.rest.DeviceDetails.Push.State
-
- code - Variable in class io.ably.lib.types.ErrorInfo
-
- CollectionUtils - Class in io.ably.lib.util
-
- CompletionListener - Interface in io.ably.lib.realtime
-
An interface allowing a client to be notified of the outcome
of an asynchronous operation.
- CompletionListener.FromCallback - Class in io.ably.lib.realtime
-
- CompletionListener.Multicaster - Class in io.ably.lib.realtime
-
A Multicaster instance is used in the Ably library to manage a list
of client listeners against certain operations.
- CompletionListener.ToCallback - Class in io.ably.lib.realtime
-
- connect() - Method in class io.ably.lib.realtime.AblyRealtime
-
- connect() - Method in class io.ably.lib.realtime.Connection
-
Explicitly calling connect() is unnecessary unless the autoConnect attribute of the
ClientOptions
object is false.
- connect() - Method in class io.ably.lib.transport.ConnectionManager
-
- connect(ITransport.ConnectListener) - Method in interface io.ably.lib.transport.ITransport
-
Initiate a connection attempt; the transport will be activated,
and attempt to remain connected, until disconnect() is called.
- connect(ITransport.ConnectListener) - Method in class io.ably.lib.transport.WebSocketTransport
-
ITransport methods
- connection - Variable in class io.ably.lib.realtime.AblyRealtime
-
- Connection - Class in io.ably.lib.realtime
-
Enables the management of a connection to Ably.
- ConnectionDetails - Class in io.ably.lib.types
-
- connectionDetails - Variable in class io.ably.lib.types.ProtocolMessage
-
- ConnectionEvent - Enum in io.ably.lib.realtime
-
Describes the events emitted by a
Connection object.
- connectionId - Variable in class io.ably.lib.types.BaseMessage
-
The connection ID of the publisher of this message.
- connectionId - Variable in class io.ably.lib.types.ProtocolMessage
-
- connectionKey - Variable in class io.ably.lib.transport.ITransport.TransportParams
-
- connectionKey - Variable in class io.ably.lib.types.ConnectionDetails
-
The connection secret key string that is used to resume a connection and its state.
- connectionKey - Variable in class io.ably.lib.types.Message
-
Key needed only in case one client is publishing this message on behalf of another client.
- connectionManager - Variable in class io.ably.lib.realtime.Connection
-
- ConnectionManager - Class in io.ably.lib.transport
-
- ConnectionManager(AblyRealtime, Connection, ConnectionManager.Channels, PlatformAgentProvider) - Constructor for class io.ably.lib.transport.ConnectionManager
-
ConnectionManager
- ConnectionManager.Channels - Interface in io.ably.lib.transport
-
- ConnectionManager.QueuedMessage - Class in io.ably.lib.transport
-
event queueing
- ConnectionManager.State - Class in io.ably.lib.transport
-
a class encapsulating state machine
information for a given state
- ConnectionManager.StateIndication - Class in io.ably.lib.transport
-
a class encapsulating information
associated with a currentState change
request or notification
- connections - Variable in class io.ably.lib.types.Stats
-
A
Stats.ConnectionTypes object containing a breakdown of connection related stats, such as min, mean and peak connections.
- connectionSerial - Variable in class io.ably.lib.transport.ITransport.TransportParams
-
- connectionSerial - Variable in class io.ably.lib.types.ProtocolMessage
-
- ConnectionState - Enum in io.ably.lib.realtime
-
- ConnectionStateChange(ConnectionState, ConnectionState, long, ErrorInfo) - Constructor for class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
-
- ConnectionStateListener - Interface in io.ably.lib.realtime
-
An interface whereby a client may be notified of state changes for a connection.
- ConnectionStateListener.ConnectionStateChange - Class in io.ably.lib.realtime
-
- ConnectionStateListener.Filter - Class in io.ably.lib.realtime
-
- ConnectionStateListener.Multicaster - Class in io.ably.lib.realtime
-
- connectionStateTtl - Static variable in class io.ably.lib.transport.Defaults
-
- connectionStateTtl - Variable in class io.ably.lib.types.ConnectionDetails
-
The duration that Ably will persist the connection state for when a Realtime client is abruptly disconnected.
- ConnectionTypes() - Constructor for class io.ably.lib.types.Stats.ConnectionTypes
-
- containsKey(Param[], String) - Static method in class io.ably.lib.types.Param
-
- containsKey(Object) - Method in interface io.ably.lib.types.ReadOnlyMap
-
- containsKey(Object) - Method in class io.ably.lib.util.InternalMap
-
- containsValue(Object) - Method in interface io.ably.lib.types.ReadOnlyMap
-
- containsValue(Object) - Method in class io.ably.lib.util.InternalMap
-
- CONTENT_LENGTH - Static variable in class io.ably.lib.http.HttpConstants.Headers
-
- CONTENT_TYPE - Static variable in class io.ably.lib.http.HttpConstants.Headers
-
- contentLength - Variable in class io.ably.lib.http.HttpCore.Response
-
- contentType - Variable in class io.ably.lib.http.HttpCore.Response
-
- ContentTypes() - Constructor for class io.ably.lib.http.HttpConstants.ContentTypes
-
- copy(Map<K, V>) - Static method in class io.ably.lib.util.CollectionUtils
-
Creates a shallow copy.
- count - Variable in class io.ably.lib.types.ProtocolMessage
-
- count - Variable in class io.ably.lib.types.Stats
-
- count - Variable in class io.ably.lib.types.Stats.MessageCount
-
The count of all messages.
- countFields() - Method in class io.ably.lib.types.BaseMessage
-
- create(Map<String, String>, PlatformAgentProvider) - Static method in class io.ably.lib.util.AgentHeaderCreator
-
- createChannelDecipher(Crypto.CipherParams) - Static method in class io.ably.lib.util.Crypto
-
Internal; get a decrypting cipher instance based on the given channel options.
- createChannelEncipher(Crypto.CipherParams) - Static method in class io.ably.lib.util.Crypto
-
Internal; get an encrypting cipher instance based on the given channel options.
- createPlatformAgent() - Method in class io.ably.lib.util.JavaPlatformAgentProvider
-
- createPlatformAgent() - Method in interface io.ably.lib.util.PlatformAgentProvider
-
- createSocket() - Method in class io.ably.lib.transport.SafeSSLSocketFactory
-
- createSocket(Socket, String, int, boolean) - Method in class io.ably.lib.transport.SafeSSLSocketFactory
-
- createSocket(String, int) - Method in class io.ably.lib.transport.SafeSSLSocketFactory
-
- createSocket(String, int, InetAddress, int) - Method in class io.ably.lib.transport.SafeSSLSocketFactory
-
- createSocket(InetAddress, int) - Method in class io.ably.lib.transport.SafeSSLSocketFactory
-
- createSocket(InetAddress, int, InetAddress, int) - Method in class io.ably.lib.transport.SafeSSLSocketFactory
-
- createTokenRequest(Auth.TokenParams, Auth.AuthOptions) - Method in class io.ably.lib.rest.Auth
-
- createUpdateEvent(ErrorInfo) - Static method in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
-
- Crypto - Class in io.ably.lib.util
-
Contains the properties required to configure the encryption of
Message payloads.
- Crypto() - Constructor for class io.ably.lib.util.Crypto
-
- Crypto.CipherParams - Class in io.ably.lib.util
-
Sets the properties to configure encryption for a
Channel or
Channel object.
- Crypto.DecryptingChannelCipher - Interface in io.ably.lib.util
-
Internal; a cipher used to decrypt plaintext from ciphertext, for a channel.
- Crypto.EncryptingChannelCipher - Interface in io.ably.lib.util
-
Internal; a cipher used to encrypt plaintext to ciphertext, for a channel.
- current(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
-
- current() - Method in class io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
-
- current - Variable in class io.ably.lib.realtime.ChannelStateListener.ChannelStateChange
-
- current - Variable in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
-
- current(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
- current(Callback<AsyncPaginatedResult<T>>) - Method in interface io.ably.lib.types.AsyncPaginatedResult
-
Returns a new PaginatedResult for the current page of results.
- current() - Method in interface io.ably.lib.types.BasePaginatedResult
-
- current() - Method in class io.ably.lib.types.HttpPaginatedResponse
-
- current() - Method in interface io.ably.lib.types.PaginatedResult
-
Returns a new PaginatedResult for the current page of results.
- CurrentThreadExecutor - Class in io.ably.lib.util
-
- CurrentThreadExecutor() - Constructor for class io.ably.lib.util.CurrentThreadExecutor
-
- d(String, String) - Static method in class io.ably.lib.util.Log
-
- d(String, String, Throwable) - Static method in class io.ably.lib.util.Log
-
- data - Variable in class io.ably.lib.types.BaseMessage
-
The message payload, if provided.
- data - Variable in class io.ably.lib.types.Stats.MessageCount
-
The total number of bytes transferred for all messages.
- DEBUG - Static variable in class io.ably.lib.util.Log
-
Priority constant; use Log.d.
- DebugOptions - Class in io.ably.lib.debug
-
- DebugOptions() - Constructor for class io.ably.lib.debug.DebugOptions
-
- DebugOptions(String) - Constructor for class io.ably.lib.debug.DebugOptions
-
- DebugOptions.RawHttpListener - Interface in io.ably.lib.debug
-
- DebugOptions.RawProtocolListener - Interface in io.ably.lib.debug
-
- decode(ChannelOptions) - Method in class io.ably.lib.types.BaseMessage
-
- decode(ChannelOptions, DecodingContext) - Method in class io.ably.lib.types.BaseMessage
-
- decode(String) - Static method in class io.ably.lib.util.Base64Coder
-
Decodes a byte array from Base64 format.
- decode(char[]) - Static method in class io.ably.lib.util.Base64Coder
-
Decodes a byte array from Base64 format.
- decode(char[], int, int) - Static method in class io.ably.lib.util.Base64Coder
-
Decodes a byte array from Base64 format.
- decodeLines(String) - Static method in class io.ably.lib.util.Base64Coder
-
Decodes a byte array from Base64 format and ignores line separators, tabs and blanks.
- decodeParams(String) - Static method in class io.ably.lib.http.HttpUtils
-
- decodeString(String) - Static method in class io.ably.lib.util.Base64Coder
-
Decodes a string from Base64 format.
- DecodingContext - Class in io.ably.lib.types
-
- DecodingContext() - Constructor for class io.ably.lib.types.DecodingContext
-
- decrypt(byte[]) - Method in interface io.ably.lib.util.Crypto.DecryptingChannelCipher
-
Deciphers ciphertext.
- DEFAULT_ALGORITHM - Static variable in class io.ably.lib.util.Crypto
-
- DEFAULT_BLOCKLENGTH - Static variable in class io.ably.lib.util.Crypto
-
- DEFAULT_KEYLENGTH - Static variable in class io.ably.lib.util.Crypto
-
- defaultAcceptHeaders(boolean) - Static method in class io.ably.lib.http.HttpUtils
-
- defaultErrorInfo - Variable in class io.ably.lib.transport.ConnectionManager.State
-
- defaultHandler - Static variable in class io.ably.lib.util.Log
-
- DefaultHandler() - Constructor for class io.ably.lib.util.Log.DefaultHandler
-
- defaultLevel - Static variable in class io.ably.lib.util.Log
-
- DefaultNetworkConnectivity() - Constructor for class io.ably.lib.transport.NetworkConnectivity.DefaultNetworkConnectivity
-
- Defaults - Class in io.ably.lib.transport
-
- Defaults() - Constructor for class io.ably.lib.transport.Defaults
-
- defaultTokenParams - Variable in class io.ably.lib.types.ClientOptions
-
- del(String, Param[], Param[], HttpCore.ResponseHandler<T>, boolean, Callback<T>) - Method in class io.ably.lib.http.HttpScheduler
-
Async HTTP DEL for Ably host, with fallbacks
- DelegatedNetworkConnectivity() - Constructor for class io.ably.lib.transport.NetworkConnectivity.DelegatedNetworkConnectivity
-
- DELETE - Static variable in class io.ably.lib.http.HttpConstants.Methods
-
- delta - Variable in class io.ably.lib.types.Stats.ProcessedMessages
-
- DeltaExtras - Class in io.ably.lib.types
-
- deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class io.ably.lib.types.Message.Serializer
-
- deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class io.ably.lib.types.PresenceMessage.ActionSerializer
-
- deserialize(JsonElement, Type, JsonDeserializationContext) - Method in class io.ably.lib.types.ProtocolMessage.ActionSerializer
-
- detach() - Method in class io.ably.lib.realtime.ChannelBase
-
Detach from this channel.
- detach(CompletionListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Detach from this channel.
- DeviceDetails - Class in io.ably.lib.rest
-
Contains the properties of a device registered for push notifications.
- DeviceDetails() - Constructor for class io.ably.lib.rest.DeviceDetails
-
- DeviceDetails.Push - Class in io.ably.lib.rest
-
Contains the details of the push registration of a device.
- DeviceDetails.Push.State - Enum in io.ably.lib.rest
-
- deviceId - Variable in class io.ably.lib.push.PushBase.ChannelSubscription
-
The unique ID of the device.
- deviceRegistrations - Variable in class io.ably.lib.push.PushBase.Admin
-
- directPublishes - Variable in class io.ably.lib.types.Stats.PushedMessages
-
Total number of direct publishes.
- disconnectedRetryTimeout - Variable in class io.ably.lib.types.ClientOptions
-
When the connection enters the disconnected state, after this timeout,
if the state is still disconnected, the client library will attempt to reconnect automatically.
- e(String, String) - Static method in class io.ably.lib.util.Log
-
- e(String, String, Throwable) - Static method in class io.ably.lib.util.Log
-
- echoMessages - Variable in class io.ably.lib.types.ClientOptions
-
If false, prevents messages originating from this connection being echoed back on the same connection.
- emit(ChannelState, ChannelStateListener.ChannelStateChange) - Method in class io.ably.lib.realtime.ChannelBase
-
- emit(ConnectionState, ConnectionStateListener.ConnectionStateChange) - Method in class io.ably.lib.realtime.Connection
-
Deprecated.
- emit(Event, Object...) - Method in class io.ably.lib.util.EventEmitter
-
Emits an event, calling registered listeners with the given event name and any other given arguments.
- emitUpdate(ErrorInfo) - Method in class io.ably.lib.realtime.Connection
-
- encode(ChannelOptions) - Method in class io.ably.lib.types.BaseMessage
-
- encode(byte[]) - Static method in class io.ably.lib.util.Base64Coder
-
Encodes a byte array into Base64 format.
- encode(byte[], int) - Static method in class io.ably.lib.util.Base64Coder
-
Encodes a byte array into Base64 format.
- encode(byte[], int, int) - Static method in class io.ably.lib.util.Base64Coder
-
Encodes a byte array into Base64 format.
- encodeLines(byte[]) - Static method in class io.ably.lib.util.Base64Coder
-
Encodes a byte array into Base 64 format and breaks the output into lines of 76 characters.
- encodeLines(byte[], int, int, int, String) - Static method in class io.ably.lib.util.Base64Coder
-
Encodes a byte array into Base 64 format and breaks the output into lines.
- encodeParams(String, Param[]) - Static method in class io.ably.lib.http.HttpUtils
-
- encodeString(String) - Static method in class io.ably.lib.util.Base64Coder
-
Encodes a string into Base64 format.
- encodeToString(byte[]) - Static method in class io.ably.lib.util.Base64Coder
-
Encodes a byte array into Base64 format.
- encodeURIComponent(String) - Static method in class io.ably.lib.http.HttpUtils
-
- encoding - Variable in class io.ably.lib.types.BaseMessage
-
This is typically empty, as all messages received from Ably are automatically decoded client-side using this value.
- encrypt(byte[]) - Method in interface io.ably.lib.util.Crypto.EncryptingChannelCipher
-
Enciphers plaintext.
- encrypted - Variable in class io.ably.lib.types.ChannelOptions
-
Whether or not this ChannelOptions is encrypted.
- enrichParams(Param[], ClientOptions) - Static method in class io.ably.lib.util.ParamsUtils
-
Produce either new or extend provided array of parameters based on values in Client options
- enter(Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Enters the presence set for the channel, optionally passing a data payload.
- enterClient(String) - Method in class io.ably.lib.realtime.Presence
-
Enters the presence set of the channel for a given clientId.
- enterClient(String, Object) - Method in class io.ably.lib.realtime.Presence
-
Enters the presence set of the channel for a given clientId.
- enterClient(String, Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Enters the presence set of the channel for a given clientId.
- entrySet() - Method in interface io.ably.lib.types.ReadOnlyMap
-
- entrySet() - Method in class io.ably.lib.util.InternalMap
-
- environment - Variable in class io.ably.lib.types.ClientOptions
-
- equals(Object) - Method in class io.ably.lib.push.PushBase.ChannelSubscription
-
- equals(Object) - Method in class io.ably.lib.rest.Auth.TokenDetails
-
Check equality of a TokenDetails
- equals(Object) - Method in class io.ably.lib.rest.Auth.TokenParams
-
Check equality of a TokenParams
- equals(Object) - Method in class io.ably.lib.rest.Auth.TokenRequest
-
Check equality of a TokenRequest
- equals(Object) - Method in class io.ably.lib.rest.DeviceDetails
-
- equals(Object) - Method in class io.ably.lib.types.DeltaExtras
-
- equals(Object) - Method in class io.ably.lib.types.ErrorInfo
-
- equals(Object) - Method in class io.ably.lib.types.MessageExtras
-
- equals(Object) - Method in class io.ably.lib.types.Param
-
- error - Variable in class io.ably.lib.types.ErrorResponse
-
- error - Variable in class io.ably.lib.types.ProtocolMessage
-
- error - Variable in class io.ably.lib.types.PublishResponse
-
Describes the reason for which a message, or messages failed to publish to a channel as an
ErrorInfo object.
- ERROR - Static variable in class io.ably.lib.util.Log
-
Priority constant; use Log.e.
- errorCode - Variable in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
- errorCode - Variable in class io.ably.lib.types.HttpPaginatedResponse
-
The error code if the X-Ably-Errorcode HTTP header is sent in the response.
- errorInfo - Variable in exception io.ably.lib.types.AblyException
-
- ErrorInfo - Class in io.ably.lib.types
-
A generic Ably error object that contains an Ably-specific status code, and a generic status code.
- ErrorInfo() - Constructor for class io.ably.lib.types.ErrorInfo
-
Public no-argument constructor for msgpack
- ErrorInfo(String, int) - Constructor for class io.ably.lib.types.ErrorInfo
-
Construct an ErrorInfo from message and code
- ErrorInfo(String, int, int) - Constructor for class io.ably.lib.types.ErrorInfo
-
Construct an ErrorInfo from message, statusCode, and code
- errorMessage - Variable in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
- errorMessage - Variable in class io.ably.lib.types.HttpPaginatedResponse
-
The error message if the X-Ably-Errormessage HTTP header is sent in the response.
- errorReason - Variable in class io.ably.lib.rest.DeviceDetails.Push
-
An
ErrorInfo object describing the most recent error when the state is Failing or Failed.
- ErrorResponse - Class in io.ably.lib.types
-
- ErrorResponse() - Constructor for class io.ably.lib.types.ErrorResponse
-
- event - Variable in class io.ably.lib.realtime.ChannelStateListener.ChannelStateChange
-
- event - Variable in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
-
- EventEmitter<Event,Listener> - Class in io.ably.lib.util
-
A generic interface for event registration and delivery used in a number of the types in the Realtime client library.
- EventEmitter() - Constructor for class io.ably.lib.util.EventEmitter
-
- EventEmitter.Filter - Class in io.ably.lib.util
-
- exec(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery
-
- exec(Param[], AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery
-
- exec(String) - Method in class io.ably.lib.http.BasePaginatedQuery
-
Get the result of the first query
- exec() - Method in class io.ably.lib.http.HttpPaginatedQuery
-
Get the result of the first query
- exec(Param[]) - Method in class io.ably.lib.http.HttpPaginatedQuery
-
Get the result of the first query
- exec(String, String, Param[], Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>, boolean, Callback<T>) - Method in class io.ably.lib.http.HttpScheduler
-
Async HTTP request for Ably host, with fallbacks
- execute(HttpScheduler, Callback<Result>) - Method in interface io.ably.lib.http.Http.Execute
-
- execute(Runnable) - Method in class io.ably.lib.http.HttpScheduler
-
Adds a Runnable to the Executor used by this scheduler instance.
- execute(Runnable) - Method in class io.ably.lib.util.CurrentThreadExecutor
-
- Experimental - Annotation Type in io.ably.annotation
-
An annotation indicating an experimental API.
- expired - Variable in exception io.ably.lib.http.HttpCore.AuthRequiredException
-
- expires - Variable in class io.ably.lib.rest.Auth.TokenDetails
-
The timestamp at which this token expires as milliseconds since the Unix epoch.
- extras - Variable in class io.ably.lib.types.Message
-
A MessageExtras object of arbitrary key-value pairs that may contain metadata, and/or ancillary payloads.
- Factory() - Constructor for class io.ably.lib.transport.WebSocketTransport.Factory
-
- Failed(AblyException) - Constructor for class io.ably.lib.http.BasePaginatedQuery.ResultRequest.Failed
-
- failed - Variable in class io.ably.lib.types.Stats.ProcessedCount
-
- failed - Variable in class io.ably.lib.types.Stats.RequestCount
-
The number of requests that failed.
- failedRequest(AblyException) - Method in class io.ably.lib.http.Http
-
- fallbackHosts - Variable in class io.ably.lib.types.ClientOptions
-
An array of fallback hosts to be used in the case of an error necessitating the use of an alternative host.
- fallbackHostsRemaining(String) - Method in class io.ably.lib.transport.Hosts
-
- fallbackHostsUseDefault - Variable in class io.ably.lib.types.ClientOptions
-
Deprecated.
- fallbackRetryTimeout - Static variable in class io.ably.lib.transport.Defaults
-
- fallbackRetryTimeout - Variable in class io.ably.lib.types.ClientOptions
-
The maximum time before HTTP requests are retried against the default endpoint.
- findByValue(int) - Static method in enum io.ably.lib.types.PresenceMessage.Action
-
- findByValue(int) - Static method in enum io.ably.lib.types.ProtocolMessage.Action
-
- first(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
-
- first() - Method in class io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
-
- first(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
Obtain params required to perform the given relative query
- first(Callback<AsyncPaginatedResult<T>>) - Method in interface io.ably.lib.types.AsyncPaginatedResult
-
Returns a new PaginatedResult for the first page of results.
- first() - Method in interface io.ably.lib.types.BasePaginatedResult
-
Perform the given relative query
- first() - Method in class io.ably.lib.types.HttpPaginatedResponse
-
Perform the given relative query
- first() - Method in interface io.ably.lib.types.PaginatedResult
-
Returns a new PaginatedResult for the first page of results.
- flags - Variable in class io.ably.lib.types.ProtocolMessage
-
- flattenParams(Map<String, Param>) - Static method in class io.ably.lib.http.HttpUtils
-
- forClientId(String, String) - Static method in class io.ably.lib.push.PushBase.ChannelSubscription
-
A static factory method to create a PushChannelSubscription object for a channel and group of devices sharing the same clientId.
- forDevice(String, String) - Static method in class io.ably.lib.push.PushBase.ChannelSubscription
-
A static factory method to create a PushChannelSubscription object for a channel and single device.
- FORM_ENCODING - Static variable in class io.ably.lib.http.HttpConstants.ContentTypes
-
- FORMAT_VCDIFF - Static variable in class io.ably.lib.types.DeltaExtras
-
- formFactor - Variable in class io.ably.lib.rest.DeviceDetails
-
The device form factor associated with the device.
- FormRequestBody(Param[]) - Constructor for class io.ably.lib.http.HttpUtils.FormRequestBody
-
- FromCallback(Callback<Void>) - Constructor for class io.ably.lib.realtime.CompletionListener.FromCallback
-
- fromCipherKey(byte[]) - Static method in class io.ably.lib.types.ChannelOptions
-
Deprecated.
- fromCipherKey(String) - Static method in class io.ably.lib.types.ChannelOptions
-
Deprecated.
- fromCode(String) - Static method in enum io.ably.lib.rest.DeviceDetails.Push.State
-
- fromDescription(String) - Static method in exception io.ably.lib.types.MessageDecodeException
-
- fromEncoded(JsonObject, ChannelOptions) - Static method in class io.ably.lib.types.Message
-
A static factory method to create a Message object from a deserialized Message-like object encoded using Ably's wire protocol.
- fromEncoded(String, ChannelOptions) - Static method in class io.ably.lib.types.Message
-
A static factory method to create a Message object from a deserialized Message-like object encoded using Ably's wire protocol.
- fromEncoded(JsonObject, ChannelOptions) - Static method in class io.ably.lib.types.PresenceMessage
-
Decodes and decrypts a deserialized PresenceMessage-like object using the cipher in
ChannelOptions.
- fromEncoded(String, ChannelOptions) - Static method in class io.ably.lib.types.PresenceMessage
-
Decodes and decrypts a deserialized PresenceMessage-like object using the cipher in
ChannelOptions.
- fromEncodedArray(JsonArray, ChannelOptions) - Static method in class io.ably.lib.types.Message
-
A static factory method to create an array of Message objects from an array of deserialized
Message-like object encoded using Ably's wire protocol.
- fromEncodedArray(String, ChannelOptions) - Static method in class io.ably.lib.types.Message
-
A static factory method to create an array of Message objects from an array of deserialized
Message-like object encoded using Ably's wire protocol.
- fromEncodedArray(JsonArray, ChannelOptions) - Static method in class io.ably.lib.types.PresenceMessage
-
Decodes and decrypts an array of deserialized PresenceMessage-like object using the cipher in
ChannelOptions.
- fromEncodedArray(String, ChannelOptions) - Static method in class io.ably.lib.types.PresenceMessage
-
Decodes and decrypts an array of deserialized PresenceMessage-like object using the cipher in
ChannelOptions.
- fromErrorInfo(ErrorInfo) - Static method in exception io.ably.lib.types.AblyException
-
- fromErrorInfo(Throwable, ErrorInfo) - Static method in exception io.ably.lib.types.AblyException
-
- fromInt(int) - Static method in enum io.ably.lib.rest.DeviceDetails.Push.State
-
- fromIntervalId(String) - Static method in class io.ably.lib.types.Stats
-
- fromJSON(JsonObject) - Static method in class io.ably.lib.rest.Auth.TokenDetails
-
Deprecated.
- fromJson(String) - Static method in class io.ably.lib.rest.Auth.TokenDetails
-
A static factory method to create a TokenDetails object from a deserialized
TokenDetails-like object or a JSON stringified TokenDetails object.
- fromJSON(JsonObject) - Static method in class io.ably.lib.rest.Auth.TokenRequest
-
- fromJson(String) - Static method in class io.ably.lib.rest.Auth.TokenRequest
-
A static factory method to create a TokenRequest object from a deserialized TokenRequest-like object
or a JSON stringified TokenRequest object.
- fromJSON(String) - Static method in class io.ably.lib.types.ErrorResponse
-
Get an ErrorInfo from a response body with error details
- fromJSON(String) - Static method in class io.ably.lib.types.ProtocolSerializer
-
JSON decode
- fromJsonElement(JsonObject) - Static method in class io.ably.lib.rest.Auth.TokenDetails
-
A static factory method to create a TokenDetails object from a deserialized
TokenDetails-like object or a JSON stringified TokenDetails object.
- fromJsonElement(JsonObject) - Static method in class io.ably.lib.rest.Auth.TokenRequest
-
A static factory method to create a TokenRequest object from a deserialized TokenRequest-like object
or a JSON stringified TokenRequest object.
- fromJsonElement(JsonElement) - Method in interface io.ably.lib.util.Serialisation.FromJsonElement
-
- fromJsonElement - Static variable in class io.ably.lib.util.StringUtils
-
- fromJsonObject(JsonObject) - Static method in class io.ably.lib.push.PushBase.ChannelSubscription
-
- fromJsonObject(JsonObject) - Static method in class io.ably.lib.rest.DeviceDetails
-
- fromMsgpackBody(byte[]) - Static method in class io.ably.lib.types.ErrorInfo
-
- fromResponseStatus(String, int) - Static method in class io.ably.lib.types.ErrorInfo
-
- fromThrowable(Throwable) - Static method in exception io.ably.lib.types.AblyException
-
Get an exception from a throwable occurring locally
- fromThrowable(Throwable) - Static method in class io.ably.lib.types.ErrorInfo
-
- fromThrowableAndErrorInfo(Throwable, ErrorInfo) - Static method in exception io.ably.lib.types.MessageDecodeException
-
- generateRandomKey(int) - Static method in class io.ably.lib.util.Crypto
-
Generates a random key to be used in the encryption of the channel.
- generateRandomKey() - Static method in class io.ably.lib.util.Crypto
-
Generates a random key to be used in the encryption of the channel.
- generateRandomRequestId() - Static method in class io.ably.lib.util.Crypto
-
Returns a "request_id" query param, based on a sequence of 9 random bytes
which have been base64 encoded.
- get(Callback<AsyncPaginatedResult<T>>) - Method in class io.ably.lib.http.AsyncPaginatedQuery
-
Get the result of the first query
- get() - Method in class io.ably.lib.http.BasePaginatedQuery
-
Get the result of the first query
- GET - Static variable in class io.ably.lib.http.HttpConstants.Methods
-
- get(String, Param[], Param[], HttpCore.ResponseHandler<T>, boolean, Callback<T>) - Method in class io.ably.lib.http.HttpScheduler
-
Async HTTP GET for Ably host, with fallbacks
- get() - Method in class io.ably.lib.http.PaginatedQuery
-
Get the result of the first query
- get(String) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Retrieves the
DeviceDetails of a device registered to receive push notifications using its deviceId.
- get(String, String) - Method in interface io.ably.lib.push.Storage
-
Returns string value based on key from storage
- get(String, int) - Method in interface io.ably.lib.push.Storage
-
Returns integer value based on key from storage
- get(String) - Method in interface io.ably.lib.realtime.AblyRealtime.Channels
-
Creates a new
Channel object, or returns the existing channel object.
- get(String, ChannelOptions) - Method in interface io.ably.lib.realtime.AblyRealtime.Channels
-
- get(Param...) - Method in class io.ably.lib.realtime.Presence
-
Retrieves the current members present on the channel and the metadata for each member,
such as their
PresenceMessage.Action and ID.
- get(boolean) - Method in class io.ably.lib.realtime.Presence
-
Retrieves the current members present on the channel and the metadata for each member,
such as their
PresenceMessage.Action and ID.
- get(String, boolean) - Method in class io.ably.lib.realtime.Presence
-
Retrieves the current members present on the channel and the metadata for each member,
such as their
PresenceMessage.Action and ID.
- get(String) - Method in interface io.ably.lib.rest.AblyBase.Channels
-
- get(String, ChannelOptions) - Method in interface io.ably.lib.rest.AblyBase.Channels
-
- get(Param[]) - Method in class io.ably.lib.rest.ChannelBase.Presence
-
Retrieves the current members present on the channel and the metadata for each member,
such as their
PresenceMessage.Action and ID.
- get(Object) - Method in interface io.ably.lib.types.ReadOnlyMap
-
- get(Object) - Method in class io.ably.lib.util.InternalMap
-
- GET_CLIENTID - Static variable in class io.ably.lib.realtime.Presence
-
- GET_CONNECTIONID - Static variable in class io.ably.lib.realtime.Presence
-
- GET_WAITFORSYNC - Static variable in class io.ably.lib.realtime.Presence
-
String parameter names for get() call with Param...
- getAlgorithm() - Method in interface io.ably.lib.util.Crypto.EncryptingChannelCipher
-
- getAsync(String, Callback<DeviceDetails>) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Asynchronously retrieves the
DeviceDetails of a device registered to receive push notifications using its deviceId.
- getAsync(Param[], Callback<AsyncPaginatedResult<PresenceMessage>>) - Method in class io.ably.lib.rest.ChannelBase.Presence
-
Asynchronously retrieves the current members present on the channel and the metadata for each member,
such as their
PresenceMessage.Action and ID.
- getAuthMethod() - Method in class io.ably.lib.rest.Auth
-
Get the authentication method for this library instance.
- getAuthOptions() - Method in class io.ably.lib.rest.Auth
-
Get (a copy of) auth options currently set in this Auth.
- getAuthorizationHeader(String, String, byte[]) - Method in class io.ably.lib.http.HttpAuth
-
Get authorization header based on the last-received server nonce.
- getAuthorizationHeader() - Method in class io.ably.lib.rest.Auth
-
- getAuthParams() - Method in class io.ably.lib.rest.Auth
-
Get query params representing the current authentication method and credentials.
- getBasicCredentials() - Method in class io.ably.lib.rest.Auth
-
Get the credentials for HTTP basic auth, if available.
- getBulkPublishResponseHandler(int) - Static method in class io.ably.lib.types.PublishResponse
-
- getChannelEvent() - Method in enum io.ably.lib.realtime.ChannelState
-
- getCipherParamsOrDefault() - Method in class io.ably.lib.types.ChannelOptions
-
Internal; returns cipher params or generate default
- getClientOptions() - Method in class io.ably.lib.transport.ITransport.TransportParams
-
- getConnectionEvent() - Method in enum io.ably.lib.realtime.ConnectionState
-
- getConnectionState() - Method in class io.ably.lib.transport.ConnectionManager
-
states API
- getConnectParams(Param[]) - Method in class io.ably.lib.transport.ITransport.TransportParams
-
- getContentType() - Method in interface io.ably.lib.http.HttpCore.RequestBody
-
- getContentType() - Method in class io.ably.lib.http.HttpUtils.ByteArrayRequestBody
-
- getContentType() - Method in class io.ably.lib.http.HttpUtils.FormRequestBody
-
- getContentType() - Method in class io.ably.lib.http.HttpUtils.JsonRequestBody
-
- getDefaultCipherSuites() - Method in class io.ably.lib.transport.SafeSSLSocketFactory
-
- getDefaultParams() - Static method in class io.ably.lib.util.Crypto
-
Spec: RSE1
- getDefaultParams(byte[]) - Static method in class io.ably.lib.util.Crypto
-
Spec: RSE1
- getDefaultParams(String) - Static method in class io.ably.lib.util.Crypto
-
Spec: RSE1
- getDelta() - Method in class io.ably.lib.types.MessageExtras
-
- getDetails(StringBuilder) - Method in class io.ably.lib.types.BaseMessage
-
Generate a String summary of this BaseMessage.
- getEncoded() - Method in interface io.ably.lib.http.HttpCore.RequestBody
-
- getEncoded() - Method in class io.ably.lib.http.HttpUtils.ByteArrayRequestBody
-
- getEncoded() - Method in class io.ably.lib.http.HttpUtils.FormRequestBody
-
- getEncoded() - Method in class io.ably.lib.http.HttpUtils.JsonRequestBody
-
- getEncodedToken() - Method in class io.ably.lib.rest.Auth
-
- getEnvironmentFallbackHosts(String) - Static method in class io.ably.lib.transport.Defaults
-
- getFallback(String) - Method in class io.ably.lib.transport.Hosts
-
Get next fallback host if any
- getFirst(Param[], String) - Static method in class io.ably.lib.types.Param
-
- getFormat() - Method in class io.ably.lib.types.DeltaExtras
-
The delta format.
- getFrom() - Method in class io.ably.lib.types.DeltaExtras
-
The id of the message the delta was generated from.
- getHeaderFields(String) - Method in class io.ably.lib.http.HttpCore.Response
-
Returns the value of the named header field.
- getHost() - Method in class io.ably.lib.transport.ConnectionManager
-
host management
- getHost() - Method in interface io.ably.lib.transport.ITransport
-
- getHost() - Method in class io.ably.lib.transport.ITransport.TransportParams
-
- getHost() - Method in class io.ably.lib.transport.WebSocketTransport
-
- getImpl(String) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
- getLastMessageData() - Method in class io.ably.lib.types.DecodingContext
-
- getMask() - Method in enum io.ably.lib.types.ChannelMode
-
- getMask() - Method in enum io.ably.lib.types.ProtocolMessage.Flag
-
- getMembers() - Method in class io.ably.lib.util.Multicaster
-
Returns a snapshot of the members of this multicaster instance.
- getMessageResponseHandler(ChannelOptions) - Static method in class io.ably.lib.types.MessageSerializer
-
BodyHandler
- getModeFlags() - Method in class io.ably.lib.types.ChannelOptions
-
- getModes() - Method in class io.ably.lib.realtime.ChannelBase
-
- getNetworkConnectivity() - Method in class io.ably.lib.platform.Platform
-
- getParam(Param[], String) - Static method in class io.ably.lib.http.HttpUtils
-
- getParams() - Method in class io.ably.lib.realtime.ChannelBase
-
- getParams(String, int) - Static method in class io.ably.lib.util.Crypto
-
- getParams(String, byte[]) - Static method in class io.ably.lib.util.Crypto
-
- getParams(String, byte[], byte[]) - Static method in class io.ably.lib.util.Crypto
-
- getPendingMessages() - Method in class io.ably.lib.transport.ConnectionManager
-
- getPort(ClientOptions) - Static method in class io.ably.lib.transport.Defaults
-
- getPort() - Method in class io.ably.lib.transport.ITransport.TransportParams
-
- getPreferredHost() - Method in class io.ably.lib.http.HttpCore
-
Gets host for this HTTP client
- getPreferredHost() - Method in class io.ably.lib.transport.Hosts
-
Get preferred host name (taking into account any affinity to a fallback: see RSC15f)
- getPresenceResponseHandler(ChannelOptions) - Static method in class io.ably.lib.types.PresenceSerializer
-
BodyHandler
- getPrimaryHost() - Method in class io.ably.lib.http.HttpCore
-
Gets host for this HTTP client
- getPrimaryHost() - Method in class io.ably.lib.transport.Hosts
-
Get primary host name
- getRandomId() - Static method in class io.ably.lib.util.Crypto
-
- getRetryTime(long, int) - Static method in class io.ably.lib.util.ReconnectionStrategy
-
Spec: RTB1
- getStateErrorInfo() - Method in class io.ably.lib.transport.ConnectionManager
-
- getSupportedCipherSuites() - Method in class io.ably.lib.transport.SafeSSLSocketFactory
-
- getTokenDetails() - Method in class io.ably.lib.rest.Auth
-
- getTokenRequest(Auth.TokenParams) - Method in interface io.ably.lib.rest.Auth.TokenCallback
-
- getTransport(ITransport.TransportParams, ConnectionManager) - Method in interface io.ably.lib.transport.ITransport.Factory
-
Obtain and instance of this transport based on the specified options.
- getTransport(ITransport.TransportParams, ConnectionManager) - Method in class io.ably.lib.transport.WebSocketTransport.Factory
-
- getUri(HttpCore, String, Param[], Param[], HttpCore.ResponseHandler<T>) - Static method in class io.ably.lib.http.HttpHelpers
-
HTTP GET for non-Ably host
- getUrl(HttpCore, String) - Static method in class io.ably.lib.http.HttpHelpers
-
Simple HTTP GET; no auth, headers, returning response body as byte[]
- getURL() - Method in interface io.ably.lib.transport.ITransport
-
Get connection URL
- getURL() - Method in class io.ably.lib.transport.WebSocketTransport
-
- getUrlString(HttpCore, String) - Static method in class io.ably.lib.http.HttpHelpers
-
Simple HTTP GET; no auth, headers, returning response body as string
- getValue() - Method in enum io.ably.lib.types.PresenceMessage.Action
-
- getValue() - Method in enum io.ably.lib.types.ProtocolMessage.Action
-
- gson - Static variable in class io.ably.lib.util.Serialisation
-
- gsonBuilder - Static variable in class io.ably.lib.util.Serialisation
-
- gsonParser - Static variable in class io.ably.lib.util.Serialisation
-
- gsonToMsgpack(JsonElement) - Static method in class io.ably.lib.util.Serialisation
-
- gsonToMsgpack(JsonElement, MessagePacker) - Static method in class io.ably.lib.util.Serialisation
-
- handler - Static variable in class io.ably.lib.util.Log
-
- handleResponse(HttpCore.Response, ErrorInfo) - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery
-
- handleResponse(HttpCore.Response, ErrorInfo) - Method in class io.ably.lib.http.BasePaginatedQuery
-
- handleResponse(HttpCore.Response, ErrorInfo) - Method in interface io.ably.lib.http.HttpCore.ResponseHandler
-
- handleResponse(HttpCore.Response, ErrorInfo) - Method in class io.ably.lib.http.HttpPaginatedQuery
-
- handleResponse(HttpCore.Response, ErrorInfo) - Method in class io.ably.lib.util.Serialisation.HttpResponseHandler
-
- handleResponseBody(String, byte[]) - Method in interface io.ably.lib.http.HttpCore.BodyHandler
-
- handleResponseBody(String, byte[]) - Method in class io.ably.lib.util.Serialisation.HttpBodyHandler
-
- hasCurrent() - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
-
- hasCurrent() - Method in class io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
-
- hasCurrent() - Method in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
- hasCurrent() - Method in interface io.ably.lib.types.AsyncPaginatedResult
-
- hasCurrent() - Method in interface io.ably.lib.types.BasePaginatedResult
-
- hasCurrent() - Method in class io.ably.lib.types.HttpPaginatedResponse
-
- hasCurrent() - Method in interface io.ably.lib.types.PaginatedResult
-
- hasFirst() - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
-
- hasFirst() - Method in class io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
-
- hasFirst() - Method in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
- hasFirst() - Method in interface io.ably.lib.types.AsyncPaginatedResult
-
- hasFirst() - Method in interface io.ably.lib.types.BasePaginatedResult
-
- hasFirst() - Method in class io.ably.lib.types.HttpPaginatedResponse
-
- hasFirst() - Method in interface io.ably.lib.types.PaginatedResult
-
- hasFlag(ProtocolMessage.Flag) - Method in class io.ably.lib.types.ProtocolMessage
-
- hashCode() - Method in class io.ably.lib.rest.Auth.TokenDetails
-
- hashCode() - Method in class io.ably.lib.types.DeltaExtras
-
- hashCode() - Method in class io.ably.lib.types.MessageExtras
-
- hashCode() - Method in class io.ably.lib.types.Param
-
- hasModes() - Method in class io.ably.lib.types.ChannelOptions
-
- hasNext() - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
-
- hasNext() - Method in class io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
-
- hasNext() - Method in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
- hasNext() - Method in interface io.ably.lib.types.AsyncPaginatedResult
-
Returns true if there are more pages available by calling next and returns false if this page is the last page available.
- hasNext() - Method in interface io.ably.lib.types.BasePaginatedResult
-
- hasNext() - Method in class io.ably.lib.types.HttpPaginatedResponse
-
- hasNext() - Method in interface io.ably.lib.types.PaginatedResult
-
Returns true if there are more pages available by calling next and returns false if this page is the last page available.
- hasParams() - Method in class io.ably.lib.types.ChannelOptions
-
- Headers() - Constructor for class io.ably.lib.http.HttpConstants.Headers
-
- headers - Variable in class io.ably.lib.http.HttpCore.Response
-
- headers - Variable in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
- headers - Variable in class io.ably.lib.types.ClientOptions
-
FIXME: unused
- headers - Variable in class io.ably.lib.types.HttpPaginatedResponse
-
The headers of the response.
- heartbeats - Variable in class io.ably.lib.transport.ITransport.TransportParams
-
- history(Param[]) - Method in class io.ably.lib.realtime.ChannelBase
-
- history(Param[]) - Method in class io.ably.lib.realtime.Presence
-
- history(Param[]) - Method in class io.ably.lib.rest.ChannelBase
-
Obtain recent history for this channel using the REST API.
- history(Param[]) - Method in class io.ably.lib.rest.ChannelBase.Presence
-
- historyAsync(Param[], Callback<AsyncPaginatedResult<Message>>) - Method in class io.ably.lib.realtime.ChannelBase
-
Asynchronously retrieves a
PaginatedResult object, containing an array of historical
Message objects for the channel.
- historyAsync(Param[], Callback<AsyncPaginatedResult<PresenceMessage>>) - Method in class io.ably.lib.realtime.Presence
-
- historyAsync(Param[], Callback<AsyncPaginatedResult<Message>>) - Method in class io.ably.lib.rest.ChannelBase
-
Asynchronously obtain recent history for this channel using the REST API.
- historyAsync(Param[], Callback<AsyncPaginatedResult<PresenceMessage>>) - Method in class io.ably.lib.rest.ChannelBase.Presence
-
- host - Variable in class io.ably.lib.transport.ITransport.TransportParams
-
- host - Variable in class io.ably.lib.types.ProxyOptions
-
- HOST_FALLBACKS - Static variable in class io.ably.lib.transport.Defaults
-
- HOST_REALTIME - Static variable in class io.ably.lib.transport.Defaults
-
- HOST_REST - Static variable in class io.ably.lib.transport.Defaults
-
- Hosts - Class in io.ably.lib.transport
-
Object to encapsulate primary host name and shuffled fallback host names.
- Hosts(String, String, ClientOptions) - Constructor for class io.ably.lib.transport.Hosts
-
Create Hosts object
- href - Variable in class io.ably.lib.types.ErrorInfo
-
This is included for REST responses to provide a URL for additional help on the error code.
- Http - Class in io.ably.lib.http
-
A high level wrapper of both a sync and an async HttpScheduler.
- Http(AsyncHttpScheduler, SyncHttpScheduler) - Constructor for class io.ably.lib.http.Http
-
- http - Variable in class io.ably.lib.rest.AblyBase
-
- Http.Execute<Result> - Interface in io.ably.lib.http
-
- Http.Request<Result> - Class in io.ably.lib.http
-
- HTTP_ASYNC_THREADPOOL_SIZE - Static variable in class io.ably.lib.transport.Defaults
-
- HTTP_MAX_RETRY_COUNT - Static variable in class io.ably.lib.transport.Defaults
-
- HttpAuth - Class in io.ably.lib.http
-
- HttpAuth.Type - Enum in io.ably.lib.http
-
- httpBodyHandler - Static variable in class io.ably.lib.push.PushBase.ChannelSubscription
-
- httpBodyHandler - Static variable in class io.ably.lib.rest.DeviceDetails
-
- httpBodyHandler - Static variable in class io.ably.lib.util.Serialisation
-
- HttpBodyHandler(Class<T[]>, Serialisation.FromJsonElement<T>) - Constructor for class io.ably.lib.util.Serialisation.HttpBodyHandler
-
- HttpBodyHandler() - Constructor for class io.ably.lib.util.Serialisation.HttpBodyHandler
-
If the target type extends JsonElement, we don't need to convert JsonElements to
it.
- httpBodyHandler - Static variable in class io.ably.lib.util.StringUtils
-
- HttpConstants - Class in io.ably.lib.http
-
- HttpConstants() - Constructor for class io.ably.lib.http.HttpConstants
-
- HttpConstants.ContentTypes - Class in io.ably.lib.http
-
- HttpConstants.Headers - Class in io.ably.lib.http
-
- HttpConstants.Methods - Class in io.ably.lib.http
-
- HttpCore - Class in io.ably.lib.http
-
HttpCore performs authenticated HTTP synchronously.
- HttpCore(ClientOptions, Auth, PlatformAgentProvider) - Constructor for class io.ably.lib.http.HttpCore
-
Public API
- httpCore - Variable in class io.ably.lib.rest.AblyBase
-
- HttpCore.AuthRequiredException - Exception in io.ably.lib.http
-
Exception signifying that an httpCore request failed with a WWW-Authenticate response
- HttpCore.BodyHandler<T> - Interface in io.ably.lib.http
-
Interface for an entity that performs type-specific processing on an httpCore response body
- HttpCore.RequestBody - Interface in io.ably.lib.http
-
Interface for an entity that supplies an httpCore request body
- HttpCore.Response - Class in io.ably.lib.http
-
A type encapsulating an httpCore response
- HttpCore.ResponseHandler<T> - Interface in io.ably.lib.http
-
Interface for an entity that performs type-specific processing on an httpCore response
- httpExecute(URL, Proxy, String, Param[], HttpCore.RequestBody, boolean, HttpCore.ResponseHandler<T>) - Method in class io.ably.lib.http.HttpCore
-
Make a synchronous HTTP request specified by URL and proxy
- httpExecute(HttpCore, URL, String, Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>) - Static method in class io.ably.lib.http.HttpHelpers
-
Make a synchronous HTTP request to non-Ably endpoint, specified by URL and using the configured proxy, if any
- httpExecute(URL, String, Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>, Callback<T>) - Method in class io.ably.lib.http.HttpScheduler
-
Make an asynchronous HTTP request to a given URL
- httpExecuteWithRetry(URL, String, Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>, boolean) - Method in class io.ably.lib.http.HttpCore
-
Make a synchronous HTTP request specified by URL and proxy, retrying if necessary on WWW-Authenticate
- HttpHelpers - Class in io.ably.lib.http
-
- HttpHelpers() - Constructor for class io.ably.lib.http.HttpHelpers
-
- httpListener - Variable in class io.ably.lib.debug.DebugOptions
-
- httpMaxRetryCount - Variable in class io.ably.lib.types.ClientOptions
-
The maximum number of fallback hosts to use as a fallback when an HTTP request to the primary host
is unreachable or indicates that it is unserviceable.
- httpMaxRetryDuration - Static variable in class io.ably.lib.transport.Defaults
-
- httpMaxRetryDuration - Variable in class io.ably.lib.types.ClientOptions
-
Denotes elapsed time in which fallback host retries for HTTP requests will be attempted.
- httpOpenTimeout - Variable in class io.ably.lib.types.ClientOptions
-
Timeout for opening a connection to Ably to initiate an HTTP request.
- HttpPaginatedQuery - Class in io.ably.lib.http
-
- HttpPaginatedQuery(Http, String, String, Param[], Param[], HttpCore.RequestBody) - Constructor for class io.ably.lib.http.HttpPaginatedQuery
-
- HttpPaginatedQuery.HttpPaginatedResult - Class in io.ably.lib.http
-
- HttpPaginatedResponse - Class in io.ably.lib.types
-
A superset of
PaginatedResult which represents a page of results plus metadata indicating the relative queries available to it.
- HttpPaginatedResponse() - Constructor for class io.ably.lib.types.HttpPaginatedResponse
-
- httpRequestTimeout - Variable in class io.ably.lib.types.ClientOptions
-
Timeout for a client performing a complete HTTP request to Ably, including the connection phase.
- httpResponseHandler - Static variable in class io.ably.lib.push.PushBase.ChannelSubscription
-
- httpResponseHandler - Static variable in class io.ably.lib.rest.DeviceDetails
-
- httpResponseHandler - Static variable in class io.ably.lib.util.Serialisation
-
- HttpResponseHandler(Class<T>, Serialisation.FromJsonElement<T>) - Constructor for class io.ably.lib.util.Serialisation.HttpResponseHandler
-
- HttpResponseHandler() - Constructor for class io.ably.lib.util.Serialisation.HttpResponseHandler
-
If the target type extends JsonElement, we don't need to convert JsonElements to
it.
- httpResponseHandler - Static variable in class io.ably.lib.util.StringUtils
-
- HttpScheduler - Class in io.ably.lib.http
-
HttpScheduler schedules HttpCore operations to an Executor, exposing a generic async API.
- HttpScheduler(HttpCore, CloseableExecutor) - Constructor for class io.ably.lib.http.HttpScheduler
-
- HttpUtils - Class in io.ably.lib.http
-
HttpUtils: utility methods for Http operations
Internal
- HttpUtils() - Constructor for class io.ably.lib.http.HttpUtils
-
- HttpUtils.ByteArrayRequestBody - Class in io.ably.lib.http
-
A RequestBody wrapping a byte array
- HttpUtils.FormRequestBody - Class in io.ably.lib.http
-
- HttpUtils.JsonRequestBody - Class in io.ably.lib.http
-
A RequestBody wrapping a JSON-serialisable object
- leave(Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Leaves the presence set for the channel.
- leave(CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Leaves the presence set for the channel.
- leaveClient(String) - Method in class io.ably.lib.realtime.Presence
-
Leaves the presence set of the channel for a given clientId.
- leaveClient(String, Object) - Method in class io.ably.lib.realtime.Presence
-
Leaves the presence set of the channel for a given clientId.
- leaveClient(String, Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Leaves the presence set of the channel for a given clientId.
- level - Static variable in class io.ably.lib.util.Log
-
- LINK - Static variable in class io.ably.lib.http.HttpConstants.Headers
-
- linkPattern - Static variable in class io.ably.lib.http.BasePaginatedQuery
-
internal
- list(Param[]) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
Retrieves all push channel subscriptions matching the filter params provided.
- list(Param[]) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Retrieves all devices matching the filter params provided.
- listAsync(Param[], Callback<AsyncPaginatedResult<PushBase.ChannelSubscription>>) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
Asynchronously retrieves all push channel subscriptions matching the filter params provided.
- listAsync(Param[], Callback<AsyncPaginatedResult<DeviceDetails>>) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Asynchronously retrieves all devices matching the filter params provided.
- listChannels(Param[]) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
Retrieves all channels with at least one device subscribed to push notifications.
- listChannelsAsync(Param[], Callback<AsyncPaginatedResult<String>>) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
Asynchronously retrieves all channels with at least one device subscribed to push notifications.
- listChannelsImpl(Param[]) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
- listener - Variable in class io.ably.lib.transport.ConnectionManager.QueuedMessage
-
- listeners - Variable in class io.ably.lib.transport.NetworkConnectivity
-
- listImpl(Param[]) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
- listImpl(Param[]) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
- localStorage - Variable in class io.ably.lib.types.ClientOptions
-
Custom Local Device storage.
- Log - Class in io.ably.lib.util
-
- Log() - Constructor for class io.ably.lib.util.Log
-
- Log.DefaultHandler - Class in io.ably.lib.util
-
Default log handler class that sends output to System.out.
- Log.LogHandler - Interface in io.ably.lib.util
-
- logHandler - Variable in class io.ably.lib.types.ClientOptions
-
Controls the log output of the library.
- logLevel - Variable in class io.ably.lib.types.ClientOptions
-
Controls the verbosity of the logs output from the library.
- mac - Variable in class io.ably.lib.rest.Auth.TokenRequest
-
The Message Authentication Code for this request.
- Map(Callback<U>) - Constructor for class io.ably.lib.types.Callback.Map
-
- map(T) - Method in class io.ably.lib.types.Callback.Map
-
- map - Variable in class io.ably.lib.util.InternalMap
-
- markAsReleased() - Method in class io.ably.lib.realtime.ChannelBase
-
Mark channel as released that means we can't perform any operation on this channel anymore
- maxFrameSize - Variable in class io.ably.lib.types.ConnectionDetails
-
Overrides the default maxFrameSize.
- maxIdleInterval - Static variable in class io.ably.lib.transport.Defaults
-
- maxIdleInterval - Variable in class io.ably.lib.types.ConnectionDetails
-
The maximum length of time in milliseconds that the server will allow no activity to occur in the server to client direction.
- maxInboundRate - Variable in class io.ably.lib.types.ConnectionDetails
-
The maximum allowable number of requests per second from a client or Ably.
- maxMessageSize - Variable in class io.ably.lib.types.ConnectionDetails
-
The maximum message size is an attribute of an Ably account and enforced by Ably servers.
- maxOutboundRate - Variable in class io.ably.lib.types.ConnectionDetails
-
- mean - Variable in class io.ably.lib.types.Stats.ResourceCount
-
The average number of resources of this type used for this period.
- memberKey() - Method in class io.ably.lib.types.PresenceMessage
-
Combines clientId and connectionId to ensure that multiple connected clients with an identical clientId are uniquely identifiable.
- mergeHeaders(Param[], Param[]) - Static method in class io.ably.lib.http.HttpUtils
-
- mergeParams(Map<String, Param>, Map<String, Param>) - Static method in class io.ably.lib.http.HttpUtils
-
- message - Variable in class io.ably.lib.types.ErrorInfo
-
Additional message information, where available.
- Message - Class in io.ably.lib.types
-
Contains an individual message that is sent to, or received from, Ably.
- Message() - Constructor for class io.ably.lib.types.Message
-
Default constructor
- Message(String, Object) - Constructor for class io.ably.lib.types.Message
-
Construct a Message object with an event name and payload.
- Message(String, Object, String) - Constructor for class io.ably.lib.types.Message
-
Construct a Message object with an event name, payload, and a unique client ID.
- Message(String, Object, MessageExtras) - Constructor for class io.ably.lib.types.Message
-
Construct a Message object with an event name, payload, and a extras.
- Message(String, Object, String, MessageExtras) - Constructor for class io.ably.lib.types.Message
-
Construct a Message object with an event name, payload, extras, and a unique client ID.
- Message.Batch - Class in io.ably.lib.types
-
- Message.Serializer - Class in io.ably.lib.types
-
- MessageCategory() - Constructor for class io.ably.lib.types.Stats.MessageCategory
-
- MessageCount() - Constructor for class io.ably.lib.types.Stats.MessageCount
-
- MessageDecodeException - Exception in io.ably.lib.types
-
Special AblyException for message decoding problems
- MessageExtras - Class in io.ably.lib.types
-
- MessageExtras(JsonObject) - Constructor for class io.ably.lib.types.MessageExtras
-
Creates a MessageExtras instance to be sent as extra with a Message to Ably's servers.
- MessageExtras.Serializer - Class in io.ably.lib.types
-
- messageId - Variable in class io.ably.lib.types.PublishResponse
-
The unique ID for a successfully published message.
- messages - Variable in class io.ably.lib.types.Message.Batch
-
An array of
Message objects to publish.
- messages - Variable in class io.ably.lib.types.ProtocolMessage
-
- messages - Variable in class io.ably.lib.types.Stats.MessageTypes
-
- messages - Variable in class io.ably.lib.types.Stats.PushedMessages
-
Total number of push messages.
- MessageSerializer - Class in io.ably.lib.types
-
MessageReader: internal
Utility class to convert response bodies in different formats to Message
and Message arrays.
- MessageSerializer() - Constructor for class io.ably.lib.types.MessageSerializer
-
- MessageTraffic() - Constructor for class io.ably.lib.types.Stats.MessageTraffic
-
- MessageTypes() - Constructor for class io.ably.lib.types.Stats.MessageTypes
-
- metadata - Variable in class io.ably.lib.rest.DeviceDetails
-
A JSON object of key-value pairs that contains metadata for the device.
- Methods() - Constructor for class io.ably.lib.http.HttpConstants.Methods
-
- mimeTypes - Static variable in class io.ably.lib.http.HttpUtils
-
- min - Variable in class io.ably.lib.types.Stats.ResourceCount
-
The minimum total resources of this type used for this period.
- mode - Variable in class io.ably.lib.transport.ITransport.TransportParams
-
- modes - Variable in class io.ably.lib.types.ChannelOptions
-
- msg - Variable in class io.ably.lib.transport.ConnectionManager.QueuedMessage
-
- msgpackPackerConfig - Static variable in class io.ably.lib.util.Serialisation
-
- msgpackToGson(byte[]) - Static method in class io.ably.lib.util.Serialisation
-
- msgpackToGson(Value) - Static method in class io.ably.lib.util.Serialisation
-
- msgpackUnpackerConfig - Static variable in class io.ably.lib.util.Serialisation
-
- msgSerial - Variable in class io.ably.lib.types.ProtocolMessage
-
- Multicaster() - Constructor for class io.ably.lib.realtime.ChannelStateListener.Multicaster
-
- Multicaster(CompletionListener...) - Constructor for class io.ably.lib.realtime.CompletionListener.Multicaster
-
- Multicaster() - Constructor for class io.ably.lib.realtime.ConnectionStateListener.Multicaster
-
- Multicaster<T> - Class in io.ably.lib.util
-
Collection of members who are listeners, with methods that are safe to be called from any thread.
- Multicaster(T...) - Constructor for class io.ably.lib.util.Multicaster
-
- object() - Static method in class io.ably.lib.util.JsonUtils
-
- off() - Method in class io.ably.lib.util.EventEmitter
-
Deregisters all registrations, for all events and listeners.
- off(Listener) - Method in class io.ably.lib.util.EventEmitter
-
Deregisters the specified listener.
- off(Event, Listener) - Method in class io.ably.lib.util.EventEmitter
-
Removes all registrations that match both the specified listener and the specified event.
- on(ChannelState, ChannelStateListener) - Method in class io.ably.lib.realtime.ChannelBase
-
- on(ConnectionState, ConnectionStateListener) - Method in class io.ably.lib.realtime.Connection
-
Deprecated.
- on(Listener) - Method in class io.ably.lib.util.EventEmitter
-
Registers the provided listener all events.
- on(Event, Listener) - Method in class io.ably.lib.util.EventEmitter
-
Registers the provided listener for the specified event.
- onAuthError(ErrorInfo) - Method in class io.ably.lib.realtime.AblyRealtime
-
Authentication error occurred
- onAuthError(ErrorInfo) - Method in class io.ably.lib.rest.AblyBase
-
Authentication error occurred
- onAuthError(ErrorInfo) - Method in class io.ably.lib.rest.Auth
-
- onAuthError(ErrorInfo) - Method in class io.ably.lib.transport.ConnectionManager
-
Called when where was an error during authentication attempt
- onAuthUpdated(String, boolean) - Method in class io.ably.lib.realtime.AblyRealtime
-
Authentication token has changed.
- onAuthUpdated(String, boolean) - Method in class io.ably.lib.rest.AblyBase
-
Override this method in AblyRealtime and pass updated token to ConnectionManager
- onAuthUpdated(String, boolean) - Method in class io.ably.lib.transport.ConnectionManager
-
(RTC8) For a realtime client, Auth.authorize instructs the library to
obtain a token using the provided tokenParams and authOptions and upgrade
the current connection to use that token; or if not currently connected,
to connect with the token.
- onAuthUpdatedAsync(String, Auth.AuthUpdateResult) - Method in class io.ably.lib.realtime.AblyRealtime
-
Authentication token has changed.
- onAuthUpdatedAsync(String, Auth.AuthUpdateResult) - Method in class io.ably.lib.rest.AblyBase
-
Override this method in AblyRealtime and pass updated token to ConnectionManager
- onAuthUpdatedAsync(String, Auth.AuthUpdateResult) - Method in class io.ably.lib.transport.ConnectionManager
-
Async version of onAuthUpdated that returns a Future that includes an option Ably exception
- once(ChannelState, ChannelStateListener) - Method in class io.ably.lib.realtime.ChannelBase
-
- once(ConnectionState, ConnectionStateListener) - Method in class io.ably.lib.realtime.Connection
-
Deprecated.
- once(Listener) - Method in class io.ably.lib.util.EventEmitter
-
Registers the provided listener for the first event that is emitted.
- once(Event, Listener) - Method in class io.ably.lib.util.EventEmitter
-
Registers the provided listener for the first occurrence of a single named event specified as the Event argument.
- onChannelStateChanged(ChannelStateListener.ChannelStateChange) - Method in class io.ably.lib.realtime.ChannelStateListener.Filter
-
- onChannelStateChanged(ChannelStateListener.ChannelStateChange) - Method in class io.ably.lib.realtime.ChannelStateListener.Multicaster
-
- onChannelStateChanged(ChannelStateListener.ChannelStateChange) - Method in interface io.ably.lib.realtime.ChannelStateListener
-
Called when channel state changes.
- onClientIdSet(String) - Method in class io.ably.lib.rest.AblyBase
-
clientId set by late initialisation
- onCompletion(boolean, Auth.TokenDetails, ErrorInfo) - Method in interface io.ably.lib.rest.Auth.RenewAuthResult
-
- onConnectionStateChange(ConnectionStateListener.ConnectionStateChange) - Method in class io.ably.lib.realtime.Connection
-
- onConnectionStateChanged(ConnectionStateListener.ConnectionStateChange) - Method in class io.ably.lib.realtime.ConnectionStateListener.Filter
-
- onConnectionStateChanged(ConnectionStateListener.ConnectionStateChange) - Method in class io.ably.lib.realtime.ConnectionStateListener.Multicaster
-
- onConnectionStateChanged(ConnectionStateListener.ConnectionStateChange) - Method in interface io.ably.lib.realtime.ConnectionStateListener
-
Called when connection state changes.
- onEmpty() - Method in class io.ably.lib.transport.NetworkConnectivity
-
- onError(ErrorInfo) - Method in class io.ably.lib.realtime.CompletionListener.FromCallback
-
- onError(ErrorInfo) - Method in class io.ably.lib.realtime.CompletionListener.Multicaster
-
- onError(ErrorInfo) - Method in interface io.ably.lib.realtime.CompletionListener
-
Called when the associated operation completes with an error.
- onError(ErrorInfo) - Method in class io.ably.lib.realtime.CompletionListener.ToCallback
-
- onError(ErrorInfo) - Method in interface io.ably.lib.types.AsyncHttpPaginatedResponse.Callback
-
Called when the associated operation completes with an error.
- onError(ErrorInfo) - Method in class io.ably.lib.types.Callback.Map
-
- onError(ErrorInfo) - Method in interface io.ably.lib.types.Callback
-
Called when the associated operation completes with an error.
- onMessage(Message) - Method in interface io.ably.lib.realtime.ChannelBase.MessageListener
-
- onMessage(ProtocolMessage) - Method in interface io.ably.lib.transport.ConnectionManager.Channels
-
- onMessage(ITransport, ProtocolMessage) - Method in class io.ably.lib.transport.ConnectionManager
-
React on message from the transport
- onNetworkAvailable() - Method in class io.ably.lib.transport.NetworkConnectivity.DelegatedNetworkConnectivity
-
- onNetworkAvailable() - Method in interface io.ably.lib.transport.NetworkConnectivity.NetworkConnectivityListener
-
- onNetworkUnavailable(ErrorInfo) - Method in class io.ably.lib.transport.NetworkConnectivity.DelegatedNetworkConnectivity
-
- onNetworkUnavailable(ErrorInfo) - Method in interface io.ably.lib.transport.NetworkConnectivity.NetworkConnectivityListener
-
- onNonempty() - Method in class io.ably.lib.transport.NetworkConnectivity
-
- onPresenceMessage(PresenceMessage) - Method in interface io.ably.lib.realtime.Presence.PresenceListener
-
- onRawConnect(String) - Method in interface io.ably.lib.debug.DebugOptions.RawProtocolListener
-
- onRawConnectRequested(String) - Method in interface io.ably.lib.debug.DebugOptions.RawProtocolListener
-
- onRawHttpException(String, String, Throwable) - Method in interface io.ably.lib.debug.DebugOptions.RawHttpListener
-
- onRawHttpRequest(String, HttpURLConnection, String, String, Map<String, List<String>>, HttpCore.RequestBody) - Method in interface io.ably.lib.debug.DebugOptions.RawHttpListener
-
- onRawHttpResponse(String, String, HttpCore.Response) - Method in interface io.ably.lib.debug.DebugOptions.RawHttpListener
-
- onRawMessageRecv(ProtocolMessage) - Method in interface io.ably.lib.debug.DebugOptions.RawProtocolListener
-
- onRawMessageSend(ProtocolMessage) - Method in interface io.ably.lib.debug.DebugOptions.RawProtocolListener
-
- onResponse(AsyncHttpPaginatedResponse) - Method in interface io.ably.lib.types.AsyncHttpPaginatedResponse.Callback
-
Called when the associated request completes with an Http response,
- onSuccess() - Method in class io.ably.lib.realtime.CompletionListener.FromCallback
-
- onSuccess() - Method in class io.ably.lib.realtime.CompletionListener.Multicaster
-
- onSuccess() - Method in interface io.ably.lib.realtime.CompletionListener
-
Called when the associated operation completes successfully.
- onSuccess(Void) - Method in class io.ably.lib.realtime.CompletionListener.ToCallback
-
- onSuccess(T) - Method in class io.ably.lib.types.Callback.Map
-
- onSuccess(T) - Method in interface io.ably.lib.types.Callback
-
Called when the associated operation completes successfully,
- onTransportAvailable(ITransport) - Method in class io.ably.lib.transport.ConnectionManager
-
- onTransportAvailable(ITransport) - Method in interface io.ably.lib.transport.ITransport.ConnectListener
-
- onTransportUnavailable(ITransport, ErrorInfo) - Method in class io.ably.lib.transport.ConnectionManager
-
- onTransportUnavailable(ITransport, ErrorInfo) - Method in interface io.ably.lib.transport.ITransport.ConnectListener
-
- onUpdate(boolean, ErrorInfo) - Method in interface io.ably.lib.rest.Auth.AuthUpdateResult
-
Signals an update from io.ably.lib.transport.ConnectionManager#onAuthUpdatedAsync(String, AuthUpdateResult)
- opened - Variable in class io.ably.lib.types.Stats.ResourceCount
-
The total number of resources opened of this type.
- options - Variable in class io.ably.lib.rest.AblyBase
-
- options - Variable in class io.ably.lib.transport.ITransport.TransportParams
-
- outbound - Variable in class io.ably.lib.types.Stats
-
- PaginatedQuery<T> - Class in io.ably.lib.http
-
An object that encapsulates parameters of a REST query with a paginated response
- PaginatedQuery(Http, String, Param[], Param[], HttpCore.BodyHandler<T>) - Constructor for class io.ably.lib.http.PaginatedQuery
-
Construct a PaginatedQuery
- PaginatedQuery(Http, String, Param[], Param[], HttpCore.RequestBody, HttpCore.BodyHandler<T>) - Constructor for class io.ably.lib.http.PaginatedQuery
-
Construct a PaginatedQuery
- PaginatedResult<T> - Interface in io.ably.lib.types
-
Contains a page of results for message or presence history, stats, or REST presence requests.
- Param - Class in io.ably.lib.types
-
A class encapsulating a key/value pair
- Param(String, String) - Constructor for class io.ably.lib.types.Param
-
- Param(String, Object) - Constructor for class io.ably.lib.types.Param
-
- params - Variable in class io.ably.lib.types.ChannelOptions
-
- params - Variable in class io.ably.lib.types.ProtocolMessage
-
- ParamsUtils - Class in io.ably.lib.util
-
- ParamsUtils() - Constructor for class io.ably.lib.util.ParamsUtils
-
- parseLinks(Collection<String>) - Static method in class io.ably.lib.http.BasePaginatedQuery
-
- parseUrl(String) - Static method in class io.ably.lib.http.HttpUtils
-
- password - Variable in class io.ably.lib.types.ProxyOptions
-
- PATCH - Static variable in class io.ably.lib.http.HttpConstants.Methods
-
- patch(String, Param[], Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>, boolean, Callback<T>) - Method in class io.ably.lib.http.HttpScheduler
-
Async HTTP PATCH for Ably host, with fallbacks
- peak - Variable in class io.ably.lib.types.Stats.ResourceCount
-
The peak number of resources of this type used for this period.
- persisted - Variable in class io.ably.lib.types.Stats
-
- ping(CompletionListener) - Method in class io.ably.lib.realtime.Connection
-
When connected, sends a heartbeat ping to the Ably server and executes the callback with any error and the response
time in milliseconds when a heartbeat ping request is echoed from the server.
- ping(CompletionListener) - Method in class io.ably.lib.transport.ConnectionManager
-
ping API
- plain - Variable in class io.ably.lib.types.Stats.ConnectionTypes
-
A
Stats.ResourceCount object containing a breakdown of usage by scope over non-TLS connections.
- Platform - Class in io.ably.lib.platform
-
- Platform() - Constructor for class io.ably.lib.platform.Platform
-
- platform - Variable in class io.ably.lib.rest.AblyBase
-
- platform - Variable in class io.ably.lib.rest.DeviceDetails
-
The platform associated with the device.
- platformAgentProvider - Variable in class io.ably.lib.rest.AblyBase
-
- PlatformAgentProvider - Interface in io.ably.lib.util
-
- port - Variable in class io.ably.lib.http.HttpCore
-
- PORT - Static variable in class io.ably.lib.transport.Defaults
-
- port - Variable in class io.ably.lib.transport.ITransport.TransportParams
-
- port - Variable in class io.ably.lib.types.ClientOptions
-
Enables a non-default Ably port to be specified.
- port - Variable in class io.ably.lib.types.ProxyOptions
-
- POST - Static variable in class io.ably.lib.http.HttpConstants.Methods
-
- post(String, Param[], Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>, boolean, Callback<T>) - Method in class io.ably.lib.http.HttpScheduler
-
Async HTTP POST for Ably host, with fallbacks
- postSync(Http, String, Param[], Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>, boolean) - Static method in class io.ably.lib.http.HttpHelpers
-
- postUri(HttpCore, String, Param[], Param[], Param[], HttpCore.ResponseHandler<T>) - Static method in class io.ably.lib.http.HttpHelpers
-
HTTP POST with data in form encoding for non-Ably host
- prefAuthType - Variable in class io.ably.lib.types.ProxyOptions
-
- preProcessReceivedMessage(ProtocolMessage) - Method in class io.ably.lib.transport.WebSocketTransport
-
- presence - Variable in class io.ably.lib.realtime.ChannelBase
-
- Presence - Class in io.ably.lib.realtime
-
Enables the presence set to be entered and subscribed to, and the historic presence set to be retrieved for a channel.
- presence - Variable in class io.ably.lib.rest.ChannelBase
-
The presence instance for this channel.
- Presence() - Constructor for class io.ably.lib.rest.ChannelBase.Presence
-
- presence - Variable in class io.ably.lib.types.ProtocolMessage
-
- presence - Variable in class io.ably.lib.types.Stats.MessageTypes
-
- Presence.PresenceListener - Interface in io.ably.lib.realtime
-
An interface allowing a listener to be notified of arrival of a presence message.
- PresenceMessage - Class in io.ably.lib.types
-
A class representing an individual presence update to be sent or received
via the Ably Realtime service.
- PresenceMessage() - Constructor for class io.ably.lib.types.PresenceMessage
-
Default constructor
- PresenceMessage(PresenceMessage.Action, String) - Constructor for class io.ably.lib.types.PresenceMessage
-
Construct a PresenceMessage from an Action and clientId
- PresenceMessage(PresenceMessage.Action, String, Object) - Constructor for class io.ably.lib.types.PresenceMessage
-
Generic constructor
- PresenceMessage.Action - Enum in io.ably.lib.types
-
Describes the possible actions members in the presence set can emit.
- PresenceMessage.ActionSerializer - Class in io.ably.lib.types
-
- PresenceMessage.Serializer - Class in io.ably.lib.types
-
- PresenceSerializer - Class in io.ably.lib.types
-
PresenceSerializer: internal
Utility class to convert response bodies in different formats to PresenceMessage
and PresenceMessage arrays.
- PresenceSerializer() - Constructor for class io.ably.lib.types.PresenceSerializer
-
- previous - Variable in class io.ably.lib.realtime.ChannelStateListener.ChannelStateChange
-
The previous state.
- previous - Variable in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
-
- println(int, String, String, Throwable) - Method in class io.ably.lib.util.Log.DefaultHandler
-
- println(PrintStream, int, String, String, Throwable) - Method in class io.ably.lib.util.Log.DefaultHandler
-
- println(int, String, String, Throwable) - Method in interface io.ably.lib.util.Log.LogHandler
-
- processAuthenticateHeaders(Map<HttpAuth.Type, String>) - Method in class io.ably.lib.http.HttpAuth
-
Process a challenge; this selects the auth type to use and caches all
possible values based on the challenge in the case of digest auth
- processed - Variable in class io.ably.lib.types.Stats
-
- ProcessedCount() - Constructor for class io.ably.lib.types.Stats.ProcessedCount
-
- ProcessedMessages() - Constructor for class io.ably.lib.types.Stats.ProcessedMessages
-
- properties - Variable in class io.ably.lib.realtime.ChannelBase
-
- protocolListener - Variable in class io.ably.lib.debug.DebugOptions
-
- ProtocolMessage - Class in io.ably.lib.types
-
A message sent and received over the Realtime protocol.
- ProtocolMessage() - Constructor for class io.ably.lib.types.ProtocolMessage
-
- ProtocolMessage(ProtocolMessage.Action) - Constructor for class io.ably.lib.types.ProtocolMessage
-
- ProtocolMessage(ProtocolMessage.Action, String) - Constructor for class io.ably.lib.types.ProtocolMessage
-
- ProtocolMessage.Action - Enum in io.ably.lib.types
-
- ProtocolMessage.ActionSerializer - Class in io.ably.lib.types
-
- ProtocolMessage.AuthDetails - Class in io.ably.lib.types
-
Contains the token string used to authenticate a client with Ably.
- ProtocolMessage.Flag - Enum in io.ably.lib.types
-
- ProtocolSerializer - Class in io.ably.lib.types
-
- ProtocolSerializer() - Constructor for class io.ably.lib.types.ProtocolSerializer
-
- proxy - Variable in class io.ably.lib.types.ClientOptions
-
Proxy settings
- PROXY_AUTHENTICATE - Static variable in class io.ably.lib.http.HttpConstants.Headers
-
- PROXY_AUTHORIZATION - Static variable in class io.ably.lib.http.HttpConstants.Headers
-
- proxyAuthChallenge - Variable in exception io.ably.lib.http.HttpCore.AuthRequiredException
-
- ProxyOptions - Class in io.ably.lib.types
-
- ProxyOptions() - Constructor for class io.ably.lib.types.ProxyOptions
-
- publish(Param[], JsonObject) - Method in class io.ably.lib.push.PushBase.Admin
-
Sends a push notification directly to a device, or a group of devices sharing the same clientId.
- publish(String, Object) - Method in class io.ably.lib.realtime.ChannelBase
-
Publishes a single message to the channel with the given event name and payload.
- publish(Message) - Method in class io.ably.lib.realtime.ChannelBase
-
Publishes a message to the channel.
- publish(Message[]) - Method in class io.ably.lib.realtime.ChannelBase
-
Publishes an array of messages to the channel.
- publish(String, Object, CompletionListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Publishes a single message to the channel with the given event name and payload.
- publish(Message, CompletionListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Publishes a message to the channel.
- publish(Message[], CompletionListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Publishes an array of messages to the channel.
- publish(String, Object) - Method in class io.ably.lib.rest.ChannelBase
-
Publish a message on this channel using the REST API.
- publish(Message[]) - Method in class io.ably.lib.rest.ChannelBase
-
Publish an array of messages on this channel.
- publishAsync(Param[], JsonObject, CompletionListener) - Method in class io.ably.lib.push.PushBase.Admin
-
Asynchronously sends a push notification directly to a device, or a group of devices sharing the same clientId.
- publishAsync(String, Object, CompletionListener) - Method in class io.ably.lib.rest.ChannelBase
-
Publish a message on this channel using the REST API.
- publishAsync(Message[], CompletionListener) - Method in class io.ably.lib.rest.ChannelBase
-
Asynchronously publish an array of messages on this channel
- publishBatch(Message.Batch[], ChannelOptions) - Method in class io.ably.lib.rest.AblyBase
-
Publish an array of Message.Batch objects to one or more channels, up to a maximum of 100 channels.
- publishBatch(Message.Batch[], ChannelOptions, Param[]) - Method in class io.ably.lib.rest.AblyBase
-
Publish an array of Message.Batch objects to one or more channels, up to a maximum of 100 channels.
- publishBatchAsync(Message.Batch[], ChannelOptions, Callback<PublishResponse[]>) - Method in class io.ably.lib.rest.AblyBase
-
Asynchronously publish an array of Message.Batch objects to one or more channels, up to a maximum of 100 channels.
- publishBatchAsync(Message.Batch[], ChannelOptions, Param[], Callback<PublishResponse[]>) - Method in class io.ably.lib.rest.AblyBase
-
Asynchronously publish an array of Message.Batch objects to one or more channels, up to a maximum of 100 channels.
- PublishResponse - Class in io.ably.lib.types
-
Contains the responses from a
PublishResponse PublishResponse#publish request.
- PublishResponse() - Constructor for class io.ably.lib.types.PublishResponse
-
- Push - Class in io.ably.lib.push
-
Enables a device to be registered and deregistered from receiving push notifications.
- Push(AblyBase) - Constructor for class io.ably.lib.push.Push
-
- push - Variable in class io.ably.lib.rest.AblyBase
-
- push - Variable in class io.ably.lib.rest.DeviceDetails
-
- Push() - Constructor for class io.ably.lib.rest.DeviceDetails.Push
-
- push(Param[], Param) - Static method in class io.ably.lib.types.Param
-
- push(Param[], String, String) - Static method in class io.ably.lib.types.Param
-
- push - Variable in class io.ably.lib.types.Stats
-
- PushBase - Class in io.ably.lib.push
-
Enables a device to be registered and deregistered from receiving push notifications.
- PushBase(AblyBase) - Constructor for class io.ably.lib.push.PushBase
-
- PushBase.Admin - Class in io.ably.lib.push
-
- PushBase.ChannelSubscription - Class in io.ably.lib.push
-
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.
- PushBase.ChannelSubscriptions - Class in io.ably.lib.push
-
Enables device push channel subscriptions.
- PushBase.DeviceRegistrations - Class in io.ably.lib.push
-
Enables the management of push notification registrations with Ably.
- PushedMessages() - Constructor for class io.ably.lib.types.Stats.PushedMessages
-
- pushFullWait - Variable in class io.ably.lib.types.ClientOptions
-
Whether to tell Ably to wait for push REST requests to fully wait for all their effects
before responding.
- pushRecipientJsonObject() - Method in class io.ably.lib.rest.DeviceDetails
-
- PUT - Static variable in class io.ably.lib.http.HttpConstants.Methods
-
- put(String, Param[], Param[], HttpCore.RequestBody, HttpCore.ResponseHandler<T>, boolean, Callback<T>) - Method in class io.ably.lib.http.HttpScheduler
-
Async HTTP PUT for Ably host, with fallbacks
- put(String, String) - Method in interface io.ably.lib.push.Storage
-
Put string value in to storage
- put(String, int) - Method in interface io.ably.lib.push.Storage
-
Put integer value in to storage
- read(JsonObject) - Method in class io.ably.lib.types.BaseMessage
-
Populate fields from JSON.
- read(JsonObject) - Method in class io.ably.lib.types.Message
-
- readJson(byte[]) - Static method in class io.ably.lib.types.StatsReader
-
- readJson(String) - Static method in class io.ably.lib.types.StatsReader
-
- readLong(JsonObject, String) - Method in class io.ably.lib.types.BaseMessage
-
Read an optional numerical value.
- readMessagesFromJson(byte[]) - Static method in class io.ably.lib.types.MessageSerializer
-
JSON decode
- readMsgpack(byte[]) - Static method in class io.ably.lib.types.MessageSerializer
-
- readMsgpack(byte[]) - Static method in class io.ably.lib.types.PresenceSerializer
-
- readMsgpack(byte[]) - Static method in class io.ably.lib.types.ProtocolSerializer
-
Msgpack decode
- readMsgpackArray(MessageUnpacker) - Static method in class io.ably.lib.types.MessageSerializer
-
Msgpack decode
- readMsgpackArray(MessageUnpacker) - Static method in class io.ably.lib.types.PresenceSerializer
-
Msgpack decode
- ReadOnlyMap<K,V> - Interface in io.ably.lib.types
-
Exposes a subset of the Map interface, providing read only access only, removing mutating interfaces.
- readString(JsonObject, String) - Method in class io.ably.lib.types.BaseMessage
-
Read an optional textual value.
- readStringMap(MessageUnpacker) - Static method in class io.ably.lib.types.MessageSerializer
-
- realtime - Variable in class io.ably.lib.types.Stats.MessageTraffic
-
A
Stats.MessageTypes object containing a breakdown of usage by message type
for messages transferred over a realtime transport such as WebSocket.
- realtimeHost - Variable in class io.ably.lib.types.ClientOptions
-
Enables a non-default Ably host to be specified for realtime connections.
- realtimeRequestTimeout - Static variable in class io.ably.lib.transport.Defaults
-
- realtimeRequestTimeout - Variable in class io.ably.lib.types.ClientOptions
-
Timeout for the wait of acknowledgement for operations performed via a realtime connection,
before the client library considers a request failed and triggers a failure condition.
- reason - Variable in class io.ably.lib.realtime.ChannelBase
-
An
ErrorInfo object describing the last error which occurred on the channel, if any.
- reason - Variable in class io.ably.lib.realtime.ChannelStateListener.ChannelStateChange
-
An
ErrorInfo object containing any information relating to the transition.
- reason - Variable in class io.ably.lib.realtime.Connection
-
An
ErrorInfo object describing the last error received if a connection failure occurs.
- reason - Variable in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
-
An
ErrorInfo object containing any information relating to the transition.
- receive(ProtocolMessage) - Method in interface io.ably.lib.transport.ITransport
-
- receive(ProtocolMessage) - Method in class io.ably.lib.transport.WebSocketTransport
-
- recipient - Variable in class io.ably.lib.rest.DeviceDetails.Push
-
A JSON object of key-value pairs that contains of the push transport and address.
- ReconnectionStrategy - Class in io.ably.lib.util
-
- ReconnectionStrategy() - Constructor for class io.ably.lib.util.ReconnectionStrategy
-
- recover - Variable in class io.ably.lib.types.ClientOptions
-
Enables a connection to inherit the state of a previous connection that may have existed under a
different instance of the Realtime library.
- recoveryKey - Variable in class io.ably.lib.realtime.Connection
-
The recovery key string can be used by another client to recover this connection's state in the recover client options property.
- refused - Variable in class io.ably.lib.types.Stats.RequestCount
-
The number of requests that were refused, typically as a result of permissions or a limit being exceeded.
- refused - Variable in class io.ably.lib.types.Stats.ResourceCount
-
The number of resource requests refused within this period.
- release(String) - Method in interface io.ably.lib.realtime.AblyRealtime.Channels
-
Releases a
Channel object, deleting it, and enabling it to be garbage collected.
- release(String) - Method in interface io.ably.lib.rest.AblyBase.Channels
-
- remove(PushBase.ChannelSubscription) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
Unsubscribes a device, or a group of devices sharing the same clientId from receiving push notifications on a channel.
- remove(DeviceDetails) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Removes a device registered to receive push notifications from Ably using the id property of a
DeviceDetails object.
- remove(String) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Removes a device registered to receive push notifications from Ably using its deviceId.
- remove(T) - Method in class io.ably.lib.util.Multicaster
-
- removeAsync(PushBase.ChannelSubscription, CompletionListener) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
Asynchronously unsubscribes a device,
or a group of devices sharing the same clientId from receiving push notifications on a channel.
- removeAsync(DeviceDetails, CompletionListener) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Asynchronously removes a device registered to receive push notifications from Ably using the id property of a
DeviceDetails object.
- removeAsync(String, CompletionListener) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Asynchronously removes a device registered to receive push notifications from Ably using its deviceId.
- removeImpl(PushBase.ChannelSubscription) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
- removeImpl(String) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
- removeListener(NetworkConnectivity.NetworkConnectivityListener) - Method in class io.ably.lib.transport.NetworkConnectivity
-
- removeOperation(String, String) - Method in class io.ably.lib.types.Capability
-
Remove an operation for a given resource.
- removeResource(String) - Method in class io.ably.lib.types.Capability
-
Remove a resource from an existing Capability instance
- removeWhere(Param[]) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
Unsubscribes all devices from receiving push notifications on a channel that match the filter params provided.
- removeWhere(Param[]) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Removes all devices registered to receive push notifications from Ably matching the filter params provided.
- removeWhereAsync(Param[], CompletionListener) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
Asynchronously unsubscribes all devices from receiving push notifications on a channel that match the filter params provided.
- removeWhereAsync(Param[], CompletionListener) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Removes all devices registered to receive push notifications from Ably matching the filter params provided.
- removeWhereImpl(Param[]) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
- removeWhereImpl(Param[]) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
- renew() - Method in class io.ably.lib.rest.Auth
-
- renewAuth(Auth.RenewAuthResult) - Method in class io.ably.lib.rest.Auth
-
Renew auth credentials.
- request(Http.Execute<Result>) - Method in class io.ably.lib.http.Http
-
- request(String, String, Param[], HttpCore.RequestBody, Param[]) - Method in class io.ably.lib.rest.AblyBase
-
Makes a REST request to a provided path.
- requestAsync(String, String, Param[], HttpCore.RequestBody, Param[], AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.rest.AblyBase
-
Makes a async REST request to a provided path.
- requestBodyFromGson(JsonElement, boolean) - Static method in class io.ably.lib.http.HttpUtils
-
- RequestCount() - Constructor for class io.ably.lib.types.Stats.RequestCount
-
- requestState(ConnectionState) - Method in class io.ably.lib.transport.ConnectionManager
-
- requestState(ConnectionManager.StateIndication) - Method in class io.ably.lib.transport.ConnectionManager
-
- requestToken(Auth.TokenParams, Auth.AuthOptions) - Method in class io.ably.lib.rest.Auth
-
- ResourceCount() - Constructor for class io.ably.lib.types.Stats.ResourceCount
-
- Response() - Constructor for class io.ably.lib.http.HttpCore.Response
-
- rest - Variable in class io.ably.lib.push.PushBase
-
- rest - Variable in class io.ably.lib.types.Stats.MessageTraffic
-
A
Stats.MessageTypes object containing a breakdown of usage by message type
for messages transferred over a rest transport such as WebSocket.
- restHost - Variable in class io.ably.lib.types.ClientOptions
-
Enables a non-default Ably host to be specified.
- resumed - Variable in class io.ably.lib.realtime.ChannelStateListener.ChannelStateChange
-
- retryIn - Variable in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
-
Duration in milliseconds, after which the client retries a connection where applicable.
- SafeSSLSocketFactory - Class in io.ably.lib.transport
-
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.
- SafeSSLSocketFactory(SSLSocketFactory) - Constructor for class io.ably.lib.transport.SafeSSLSocketFactory
-
- save(PushBase.ChannelSubscription) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
Subscribes a device, or a group of devices sharing the same clientId to push notifications on a channel.
- save(DeviceDetails) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
- saveAsync(PushBase.ChannelSubscription, Callback<PushBase.ChannelSubscription>) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
Asynchronously subscribes a device, or a group of devices sharing the same clientId to push notifications on a channel.
- saveAsync(DeviceDetails, Callback<DeviceDetails>) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
Asynchronously registers or updates a
DeviceDetails object with Ably.
- saveImpl(PushBase.ChannelSubscription) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
-
- saveImpl(DeviceDetails) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
-
- scheme - Variable in class io.ably.lib.http.HttpCore
-
- send(ProtocolMessage, boolean, CompletionListener) - Method in class io.ably.lib.transport.ConnectionManager
-
- send(ProtocolMessage) - Method in interface io.ably.lib.transport.ITransport
-
Send a message on the channel
- send(ProtocolMessage) - Method in class io.ably.lib.transport.WebSocketTransport
-
- sendEvents - Variable in class io.ably.lib.transport.ConnectionManager.State
-
- serial - Variable in class io.ably.lib.realtime.Connection
-
The serial number of the last message to be received on this connection,
used automatically by the library when recovering or resuming a connection.
- Serialisation - Class in io.ably.lib.util
-
- Serialisation() - Constructor for class io.ably.lib.util.Serialisation
-
- Serialisation.FromJsonElement<T> - Interface in io.ably.lib.util
-
- Serialisation.HttpBodyHandler<T> - Class in io.ably.lib.util
-
- Serialisation.HttpResponseHandler<T> - Class in io.ably.lib.util
-
- serialize(Message, Type, JsonSerializationContext) - Method in class io.ably.lib.types.Message.Serializer
-
- serialize(MessageExtras, Type, JsonSerializationContext) - Method in class io.ably.lib.types.MessageExtras.Serializer
-
- serialize(PresenceMessage, Type, JsonSerializationContext) - Method in class io.ably.lib.types.PresenceMessage.Serializer
-
- serialize(ProtocolMessage.Action, Type, JsonSerializationContext) - Method in class io.ably.lib.types.ProtocolMessage.ActionSerializer
-
- Serializer() - Constructor for class io.ably.lib.types.Message.Serializer
-
- Serializer() - Constructor for class io.ably.lib.types.MessageExtras.Serializer
-
- Serializer() - Constructor for class io.ably.lib.types.PresenceMessage.Serializer
-
- serverId - Variable in class io.ably.lib.types.ConnectionDetails
-
A unique identifier for the front-end server that the client has connected to.
- serverTimestamp() - Method in class io.ably.lib.rest.Auth
-
Using time delta obtained before guess current server time
- set(Param[], Param) - Static method in class io.ably.lib.types.Param
-
- set(Param[], String, String) - Static method in class io.ably.lib.types.Param
-
- setClientId(String) - Method in class io.ably.lib.rest.Auth
-
Set the clientId, after first initialisation in the construction of the library
therefore an existing null value is significant - it means that ClientOptions.clientId
was null
- setConnected(boolean) - Method in class io.ably.lib.realtime.ChannelBase
-
- setConnectionClosed(ErrorInfo) - Method in class io.ably.lib.realtime.ChannelBase
-
(RTL3b) If the connection state enters the CLOSED state, then an
ATTACHING or ATTACHED channel state will transition to DETACHED.
- setConnectionFailed(ErrorInfo) - Method in class io.ably.lib.realtime.ChannelBase
-
If the connection state enters the FAILED state, then an ATTACHING
or ATTACHED channel state will transition to FAILED and set the
Channel#errorReason
- setFlag(ProtocolMessage.Flag) - Method in class io.ably.lib.types.ProtocolMessage
-
- setFlags(int) - Method in class io.ably.lib.types.ProtocolMessage
-
- setHandler(Log.LogHandler) - Static method in class io.ably.lib.util.Log
-
- setLastActivity(long) - Method in class io.ably.lib.transport.ConnectionManager
-
- setLastMessageData(String) - Method in class io.ably.lib.types.DecodingContext
-
- setLastMessageData(byte[]) - Method in class io.ably.lib.types.DecodingContext
-
- setLevel(int) - Static method in class io.ably.lib.util.Log
-
- setOptions(ChannelOptions) - Method in class io.ably.lib.realtime.ChannelBase
-
- setOptions(ChannelOptions, CompletionListener) - Method in class io.ably.lib.realtime.ChannelBase
-
- setPreferredHost(String) - Method in class io.ably.lib.http.HttpCore
-
Sets host for this HTTP client
- setPreferredHost(String, boolean) - Method in class io.ably.lib.transport.Hosts
-
set preferred hostname, which might not be the primary
- setSuspended(ErrorInfo, boolean) - Method in class io.ably.lib.realtime.ChannelBase
-
(RTL3c) If the connection state enters the SUSPENDED state, then an
ATTACHING or ATTACHED channel state will transition to SUSPENDED.
- size() - Method in interface io.ably.lib.rest.AblyBase.Channels
-
- size() - Method in interface io.ably.lib.types.ReadOnlyMap
-
- size() - Method in class io.ably.lib.util.InternalMap
-
- size() - Method in class io.ably.lib.util.Multicaster
-
- skipped - Variable in class io.ably.lib.types.Stats.ProcessedCount
-
- sortAuthenticateHeaders(Collection<String>) - Static method in class io.ably.lib.http.HttpAuth
-
Split a compound authenticate header string to get details for each auth type
- state - Variable in class io.ably.lib.realtime.ChannelBase
-
- state - Variable in class io.ably.lib.realtime.Connection
-
- state - Variable in class io.ably.lib.rest.DeviceDetails.Push
-
The current state of the push registration.
- state - Variable in class io.ably.lib.transport.ConnectionManager.State
-
- StateIndication(ConnectionState, ErrorInfo) - Constructor for class io.ably.lib.transport.ConnectionManager.StateIndication
-
- stats(Param[]) - Method in class io.ably.lib.rest.AblyBase
-
Queries the REST /stats API and retrieves your application's usage statistics.
- Stats - Class in io.ably.lib.types
-
Contains application statistics for a specified time interval and time period.
- Stats() - Constructor for class io.ably.lib.types.Stats
-
- Stats.ConnectionTypes - Class in io.ably.lib.types
-
Contains a breakdown of summary stats data for different (TLS vs non-TLS) connection types.
- Stats.Granularity - Enum in io.ably.lib.types
-
Describes the interval unit over which statistics are gathered.
- Stats.MessageCategory - Class in io.ably.lib.types
-
- Stats.MessageCount - Class in io.ably.lib.types
-
Contains the aggregate counts for messages and data transferred.
- Stats.MessageTraffic - Class in io.ably.lib.types
-
Contains a breakdown of summary stats data for traffic over various transport types.
- Stats.MessageTypes - Class in io.ably.lib.types
-
Contains a breakdown of summary stats data for different (channel vs presence) message types.
- Stats.ProcessedCount - Class in io.ably.lib.types
-
- Stats.ProcessedMessages - Class in io.ably.lib.types
-
- Stats.PushedMessages - Class in io.ably.lib.types
-
Details the stats on push notifications.
- Stats.RequestCount - Class in io.ably.lib.types
-
Contains the aggregate counts for requests made.
- Stats.ResourceCount - Class in io.ably.lib.types
-
Contains the aggregate data for usage of a resource in a specific scope.
- statsAsync(Param[], Callback<AsyncPaginatedResult<Stats>>) - Method in class io.ably.lib.rest.AblyBase
-
Asynchronously queries the REST /stats API and retrieves your application's usage statistics.
- StatsReader - Class in io.ably.lib.types
-
StatsReader: internal
Utility class to convert response bodies in different formats to Stats data.
- StatsReader() - Constructor for class io.ably.lib.types.StatsReader
-
- statsResponseHandler - Static variable in class io.ably.lib.types.StatsReader
-
- statusCode - Variable in class io.ably.lib.http.HttpCore.Response
-
- statusCode - Variable in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
- statusCode - Variable in class io.ably.lib.types.ErrorInfo
-
HTTP Status Code corresponding to this error, where applicable.
- statusCode - Variable in class io.ably.lib.types.HttpPaginatedResponse
-
The HTTP status code of the response.
- statusLine - Variable in class io.ably.lib.http.HttpCore.Response
-
- Storage - Interface in io.ably.lib.push
-
Interface for an entity that supplies key value store
- StringUtils - Class in io.ably.lib.util
-
- StringUtils() - Constructor for class io.ably.lib.util.StringUtils
-
- subscribe(ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Registers a listener for messages on this channel.
- subscribe(String, ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Registers a listener for messages with a given event name on this channel.
- subscribe(String[], ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Registers a listener for messages on this channel for multiple event name values.
- subscribe(Presence.PresenceListener, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Registers a listener that is called each time a
PresenceMessage matching a given
PresenceMessage.Action,
or an action within an array of
PresenceMessage.Action, is received on the channel,
such as a new member entering the presence set.
- subscribe(Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Registers a listener that is called each time a
PresenceMessage matching a given
PresenceMessage.Action,
or an action within an array of
PresenceMessage.Action, is received on the channel,
such as a new member entering the presence set.
- subscribe(PresenceMessage.Action, Presence.PresenceListener, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Registers a listener that is called each time a
PresenceMessage matching a given
PresenceMessage.Action,
or an action within an array of
PresenceMessage.Action, is received on the channel,
such as a new member entering the presence set.
- subscribe(PresenceMessage.Action, Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Registers a listener that is called each time a
PresenceMessage matching a given
PresenceMessage.Action,
or an action within an array of
PresenceMessage.Action, is received on the channel,
such as a new member entering the presence set.
- subscribe(EnumSet<PresenceMessage.Action>, Presence.PresenceListener, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Registers a listener that is called each time a
PresenceMessage matching a given
PresenceMessage.Action,
or an action within an array of
PresenceMessage.Action, is received on the channel,
such as a new member entering the presence set.
- subscribe(EnumSet<PresenceMessage.Action>, Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Registers a listener that is called each time a
PresenceMessage matching a given
PresenceMessage.Action,
or an action within an array of
PresenceMessage.Action, is received on the channel,
such as a new member entering the presence set.
- succeeded - Variable in class io.ably.lib.types.Stats.ProcessedCount
-
- succeeded - Variable in class io.ably.lib.types.Stats.RequestCount
-
The number of requests that succeeded.
- success - Variable in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
- success - Variable in class io.ably.lib.types.HttpPaginatedResponse
-
Whether statusCode indicates success.
- suspendAll(ErrorInfo, boolean) - Method in interface io.ably.lib.transport.ConnectionManager.Channels
-
- suspendedRetryTimeout - Static variable in class io.ably.lib.transport.Defaults
-
- suspendedRetryTimeout - Variable in class io.ably.lib.types.ClientOptions
-
This is a timeout when the connection enters the suspendedState.
- sync() - Method in class io.ably.lib.http.BasePaginatedQuery.ResultRequest.Failed
-
- sync() - Method in class io.ably.lib.http.BasePaginatedQuery.ResultRequest
-
- sync() - Method in class io.ably.lib.http.Http.Request
-
- sync() - Method in class io.ably.lib.realtime.ChannelBase
-
- syncComplete - Variable in class io.ably.lib.realtime.Presence
-
Indicates whether the presence set synchronization between Ably and the clients on the channel has been completed.
- SyncHttpScheduler - Class in io.ably.lib.http
-
A HttpScheduler that runs everything in the current thread.
- SyncHttpScheduler(HttpCore) - Constructor for class io.ably.lib.http.SyncHttpScheduler
-
- uncompressedData - Variable in class io.ably.lib.types.Stats.MessageCount
-
- unit - Variable in class io.ably.lib.types.Stats
-
The length of the interval the stats span.
- unsubscribe() - Method in class io.ably.lib.realtime.ChannelBase
-
Deregisters all listeners to messages on this channel.
- unsubscribe(ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Deregisters the given listener (for any/all event names).
- unsubscribe(String, ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Deregisters the given listener for the specified event name.
- unsubscribe(String[], ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Deregisters the given listener from all event names in the array.
- unsubscribe(Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Deregisters a specific listener that is registered to receive
PresenceMessage on the channel.
- unsubscribe(PresenceMessage.Action, Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Deregisters a specific listener that is registered to receive
PresenceMessage on the channel for a given
PresenceMessage.Action.
- unsubscribe(EnumSet<PresenceMessage.Action>, Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Deregisters a specific listener that is registered to receive
PresenceMessage on the channel for a given
PresenceMessage.Action.
- unsubscribe() - Method in class io.ably.lib.realtime.Presence
-
Deregisters all listeners currently receiving
PresenceMessage for the channel.
- update(Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Updates the data payload for a presence member.
- updateClient(String) - Method in class io.ably.lib.realtime.Presence
-
Updates the data payload for a presence member using a given clientId.
- updateClient(String, Object) - Method in class io.ably.lib.realtime.Presence
-
Updates the data payload for a presence member using a given clientId.
- updateClient(String, Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Updates the data payload for a presence member using a given clientId.
- updatePresence(PresenceMessage, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Update the presence for this channel with a given PresenceMessage update.
- urlPattern - Static variable in class io.ably.lib.http.BasePaginatedQuery
-
- urlWithQueryStringRemoved(String) - Static method in class io.ably.lib.http.HttpUtils
-
Removes querystring from given url string and returns the url string without query string(s)
- useBinaryProtocol - Variable in class io.ably.lib.types.ClientOptions
-
When true, the more efficient MsgPack binary encoding is used.
- username - Variable in class io.ably.lib.types.ProxyOptions
-
- useTokenAuth - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
When true, forces token authentication to be used by the library.
- v(String, String) - Static method in class io.ably.lib.util.Log
-
- v(String, String, Throwable) - Static method in class io.ably.lib.util.Log
-
- value - Variable in class io.ably.lib.types.Param
-
- valueOf(String) - Static method in enum io.ably.lib.http.HttpAuth.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.realtime.ChannelEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.realtime.ChannelState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.realtime.ConnectionEvent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.realtime.ConnectionState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.rest.Auth.AuthMethod
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.rest.DeviceDetails.Push.State
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.transport.ITransport.Mode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.types.ChannelMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.types.PresenceMessage.Action
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.types.ProtocolMessage.Action
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.types.ProtocolMessage.Flag
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.ably.lib.types.Stats.Granularity
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.ably.lib.http.HttpAuth.Type
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.ably.lib.realtime.ChannelEvent
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.ably.lib.realtime.ChannelState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.ably.lib.realtime.ConnectionEvent
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.ably.lib.realtime.ConnectionState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Method in interface io.ably.lib.rest.AblyBase.Channels
-
- values() - Static method in enum io.ably.lib.rest.Auth.AuthMethod
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.ably.lib.rest.DeviceDetails.Push.State
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Method in interface io.ably.lib.transport.ConnectionManager.Channels
-
- values() - Static method in enum io.ably.lib.transport.ITransport.Mode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.ably.lib.types.ChannelMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.ably.lib.types.PresenceMessage.Action
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.ably.lib.types.ProtocolMessage.Action
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum io.ably.lib.types.ProtocolMessage.Flag
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Method in interface io.ably.lib.types.ReadOnlyMap
-
- values() - Static method in enum io.ably.lib.types.Stats.Granularity
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Method in class io.ably.lib.util.InternalMap
-
- VERBOSE - Static variable in class io.ably.lib.util.Log
-
Priority constant; use Log.v.