- AblyException - Exception in io.ably.lib.types
-
An exception type encapsulating an Ably error code
- AblyException.HostFailedException - Exception in io.ably.lib.types
-
- ablyHttpExecute(String, String, Param[], Param[], Http.RequestBody, Http.ResponseHandler<T>, Callback<T>) - Method in class io.ably.lib.http.AsyncHttp
-
- AblyRealtime - Class in io.ably.lib.realtime
-
AblyRealtime
The top-level class to be instanced for the Ably Realtime library.
- AblyRealtime(String) - Constructor for class io.ably.lib.realtime.AblyRealtime
-
Instance the Ably library using a key only.
- AblyRealtime(ClientOptions) - Constructor for class io.ably.lib.realtime.AblyRealtime
-
Instance the Ably library with the given options.
- AblyRealtime.Channels - Class in io.ably.lib.realtime
-
A collection of the Channels associated with this Realtime
instance.
- AblyRest - Class in io.ably.lib.rest
-
AblyRest
The top-level class to be instanced for the Ably REST library.
- AblyRest(String) - Constructor for class io.ably.lib.rest.AblyRest
-
Instance the Ably library using a key only.
- AblyRest(ClientOptions) - Constructor for class io.ably.lib.rest.AblyRest
-
Instance the Ably library with the given options.
- AblyRest.Channels - Class in io.ably.lib.rest
-
A collection of Channels associated with an Ably instance.
- abort(ErrorInfo) - Method in interface io.ably.lib.transport.ITransport
-
Kill this transport.
- abort(ErrorInfo) - Method in class io.ably.lib.transport.WebSocketTransport
-
- 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(T) - Method in class io.ably.lib.util.Multicaster
-
- addOperation(String, String) - Method in class io.ably.lib.types.Capability
-
Add an operation to an existing Capability instance for a
given resource.
- 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.
- addResource(String, String) - Method in class io.ably.lib.types.Capability
-
Add a resource to an existing Capability instance with the
given single operation.
- addResource(String) - Method in class io.ably.lib.types.Capability
-
Add a resource to an existing Capability instance with an
empty set of operations.
- algorithm - Variable in class io.ably.lib.util.Crypto.CipherParams
-
- all - Variable in class io.ably.lib.types.Stats
-
- all - Variable in class io.ably.lib.types.Stats.ConnectionTypes
-
- all - Variable in class io.ably.lib.types.Stats.MessageTraffic
-
- all - Variable in class io.ably.lib.types.Stats.MessageTypes
-
- apiRequests - Variable in class io.ably.lib.types.Stats
-
- apply(ChannelStateListener, ChannelState, Object...) - Method in class io.ably.lib.realtime.Channel
-
- apply(ConnectionStateListener, ConnectionState, 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
-
- asJSON() - Method in class io.ably.lib.rest.Auth.TokenRequest
-
Internal; convert a TokenParams into a JSON object.
- 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(PresenceMessage) - Static method in class io.ably.lib.types.PresenceSerializer
-
JSON encode
- asJSONRequest(PresenceMessage[]) - Static method in class io.ably.lib.types.PresenceSerializer
-
- asMsgpackRequest(Message) - Static method in class io.ably.lib.types.MessageSerializer
-
Msgpack encode
- asMsgpackRequest(Message[]) - Static method in class io.ably.lib.types.MessageSerializer
-
- asParams() - Method in class io.ably.lib.rest.Auth.TokenParams
-
Internal; convert a TokenParams to a collection of Params
- AsyncHttp - Class in io.ably.lib.http
-
- AsyncHttp(Http) - Constructor for class io.ably.lib.http.AsyncHttp
-
Internal API
- asyncHttp - Variable in class io.ably.lib.rest.AblyRest
-
- AsyncPaginatedQuery<T> - Class in io.ably.lib.http
-
An object that encapsulates parameters of a REST query with a paginated response
- AsyncPaginatedQuery(AsyncHttp, String, Param[], Param[], Http.BodyHandler<T>) - Constructor for class io.ably.lib.http.AsyncPaginatedQuery
-
Construct a PaginatedQuery
- AsyncPaginatedQuery.ResultPage - Class in io.ably.lib.http
-
A private class encapsulating the result of a single page response
- 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.Channel
-
Attach to this channel.
- attachSerial - Variable in class io.ably.lib.realtime.Channel
-
A message identifier indicating the time of attachment to the channel;
used when recovering a message history to mesh exactly with messages
received on this channel subsequent to attachment.
- auth - Variable in class io.ably.lib.rest.AblyRest
-
- Auth - Class in io.ably.lib.rest
-
Token-generation and authentication operations for the Ably API.
- Auth.AuthMethod - Enum in io.ably.lib.rest
-
Authentication methods
- Auth.AuthOptions - Class in io.ably.lib.rest
-
Authentication options when instancing the Ably library
- 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
-
A class providing details of a token and its associated metadata,
provided when the system successfully requests a token from the system.
- Auth.TokenParams - Class in io.ably.lib.rest
-
A class providing parameters of a token request.
- Auth.TokenRequest - Class in io.ably.lib.rest
-
A class providing parameters of a token request.
- authCallback - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
A callback to call to obtain a signed token request.
- authHeaders - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
Headers to be included in any request made by the library
to the authURL.
- 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.AuthOptions, Auth.TokenParams) - Method in class io.ably.lib.http.TokenAuth
-
- authorise(Auth.AuthOptions, Auth.TokenParams) - Method in class io.ably.lib.rest.Auth
-
Ensure valid auth credentials are present.
- authParams - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
Query params to be included in any request made by the library
to the authURL.
- authUrl - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
A URL to queryto obtain a signed token request.
- autoConnect - Variable in class io.ably.lib.types.ClientOptions
-
If false, suppresses the automatic initiation of a connection when the library is instanced.
- 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.
- capability - Variable in class io.ably.lib.rest.Auth.TokenDetails
-
The capability associated with this token.
- capability - Variable in class io.ably.lib.rest.Auth.TokenParams
-
Capability of the 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
- Channel - Class in io.ably.lib.realtime
-
A class representing a Channel belonging to this application.
- Channel - Class in io.ably.lib.rest
-
A class representing a Channel in the Ably REST API.
- channel - Variable in class io.ably.lib.types.ProtocolMessage
-
- Channel.MessageListener - Interface in io.ably.lib.realtime
-
An interface whereby a client maybe notified of messages changes on a channel.
- Channel.Presence - Class in io.ably.lib.rest
-
A class enabling access to Channel Presence information via the REST API.
- ChannelOptions - Class in io.ably.lib.types
-
- ChannelOptions() - Constructor for class io.ably.lib.types.ChannelOptions
-
- channels - Variable in class io.ably.lib.realtime.AblyRealtime
-
The #Channels associated with this instance.
- Channels() - Constructor for class io.ably.lib.realtime.AblyRealtime.Channels
-
- channels - Variable in class io.ably.lib.rest.AblyRest
-
- Channels() - Constructor for class io.ably.lib.rest.AblyRest.Channels
-
- 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
-
Channel states.
- ChannelStateListener - Interface in io.ably.lib.realtime
-
An interface whereby a client may be notified of state changes for a channel.
- ChannelStateListener.Filter - Class in io.ably.lib.realtime
-
- ChannelStateListener.Multicaster - Class in io.ably.lib.realtime
-
- 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
-
- CipherParams(String, byte[]) - Constructor for class io.ably.lib.util.Crypto.CipherParams
-
- clear() - Method in class io.ably.lib.http.TokenAuth
-
- clear() - Method in class io.ably.lib.util.Multicaster
-
- clientId - Variable in class io.ably.lib.rest.Auth.TokenDetails
-
The clientId, if any, bound to this token.
- clientId - Variable in class io.ably.lib.rest.Auth.TokenParams
-
A clientId to associate with this token.
- clientId - Variable in class io.ably.lib.types.BaseMessage
-
The id of the publisher of this message
- clientId - Variable in class io.ably.lib.types.ClientOptions
-
The id of the client represented by this instance.
- clientId - Variable in class io.ably.lib.types.ConnectionDetails
-
- ClientOptions - Class in io.ably.lib.types
-
Options: Ably library options for REST and Realtime APIs
- ClientOptions() - Constructor for class io.ably.lib.types.ClientOptions
-
Default constructor
- ClientOptions(String) - Constructor for class io.ably.lib.types.ClientOptions
-
Construct an options with a single key string.
- clone() - Method in class io.ably.lib.types.PresenceMessage
-
- close() - Method in class io.ably.lib.realtime.AblyRealtime
-
Close this instance.
- close() - Method in class io.ably.lib.realtime.Connection
-
Causes the connection to close, entering the closed state, from any state except
the failed state.
- close() - Method in class io.ably.lib.transport.ConnectionManager
-
- close(boolean) - Method in interface io.ably.lib.transport.ITransport
-
Close this transport.
- close(boolean) - Method in class io.ably.lib.transport.WebSocketTransport
-
- code - Variable in class io.ably.lib.types.ErrorInfo
-
Ably error code (see ably-common/protocol/errors.json)
- CompletionListener - Interface in io.ably.lib.realtime
-
An interface allowing a client to be notified of the outcome
of an asynchronous operation.
- 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.
- connect() - Method in class io.ably.lib.realtime.Connection
-
Causes the library to re-attempt connection, if it was previously explicitly
closed by the user, or was closed as a result of an unrecoverable error.
- connect() - Method in class io.ably.lib.transport.ConnectionManager
-
state management
- 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
-
A class representing the connection associated with an AblyRealtime instance.
- ConnectionDetails - Class in io.ably.lib.types
-
- ConnectionDetails() - Constructor for class io.ably.lib.types.ConnectionDetails
-
- connectionDetails - Variable in class io.ably.lib.types.ProtocolMessage
-
- 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.types.ConnectionDetails
-
- connectionKey - Variable in class io.ably.lib.types.ProtocolMessage
-
- connectionManager - Variable in class io.ably.lib.realtime.Connection
-
- ConnectionManager - Class in io.ably.lib.transport
-
- ConnectionManager(AblyRealtime, Connection) - Constructor for class io.ably.lib.transport.ConnectionManager
-
constructor
- ConnectionManager.QueuedMessage - Class in io.ably.lib.transport
-
event queueing
- ConnectionManager.StateIndication - Class in io.ably.lib.transport
-
a class encapsulating information
associated with a state change
request or notification
- ConnectionManager.StateInfo - Class in io.ably.lib.transport
-
a class encapsulating state machine
information for a given state
- connections - Variable in class io.ably.lib.types.Stats
-
- connectionSerial - Variable in class io.ably.lib.types.ProtocolMessage
-
- ConnectionState - Enum in io.ably.lib.realtime
-
Connection states.
- ConnectionStateChange(ConnectionState, ConnectionState, long, ErrorInfo) - Constructor for class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
-
- ConnectionStateListener - Interface in io.ably.lib.realtime
-
- ConnectionStateListener.ConnectionStateChange - Class in io.ably.lib.realtime
-
- ConnectionStateListener.Filter - Class in io.ably.lib.realtime
-
- ConnectionStateListener.Multicaster - Class in io.ably.lib.realtime
-
- ConnectionTypes() - Constructor for class io.ably.lib.types.Stats.ConnectionTypes
-
- containsKey(Param[], String) - Static method in class io.ably.lib.types.Param
-
- count - Variable in class io.ably.lib.types.ProtocolMessage
-
- count - Variable in class io.ably.lib.types.Stats.MessageCount
-
- countFields() - Method in class io.ably.lib.types.BaseMessage
-
- createTokenRequest(Auth.AuthOptions, Auth.TokenParams) - Method in class io.ably.lib.rest.Auth
-
Create a signed token request based on known credentials
and the given token params.
- Crypto - Class in io.ably.lib.util
-
Utility classes and interfaces for message payload encryption.
- Crypto() - Constructor for class io.ably.lib.util.Crypto
-
- Crypto.ChannelCipher - Interface in io.ably.lib.util
-
Interface for a ChannelCipher instance that may be associated with a Channel.
- Crypto.CipherParams - Class in io.ably.lib.util
-
A class encapsulating the client-specifiable parameters for
the cipher.
- current(Callback<AsyncPaginatedResult<T>>) - Method in class io.ably.lib.http.AsyncPaginatedQuery.ResultPage
-
- current() - Method in class io.ably.lib.http.PaginatedQuery.ResultPage
-
- current - Variable in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
-
- current(Callback<AsyncPaginatedResult<T>>) - Method in interface io.ably.lib.types.AsyncPaginatedResult
-
- current() - Method in interface io.ably.lib.types.PaginatedResult
-
- 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, suppresses messages originating from this connection being echoed back
on the same connection.
- emit(Event, Object...) - Method in class io.ably.lib.util.EventEmitter
-
Emit the given event (broadcasting to registered listeners)
- 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.
- encodeURIComponent(String) - Static method in class io.ably.lib.http.HttpUtils
-
- encoding - Variable in class io.ably.lib.types.BaseMessage
-
Any transformation applied to the data for this message
- encrypt(byte[]) - Method in interface io.ably.lib.util.Crypto.ChannelCipher
-
- encrypted - Variable in class io.ably.lib.types.ChannelOptions
-
- enter(Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Enter this client into this channel.
- enterClient(String) - Method in class io.ably.lib.realtime.Presence
-
Enter a specified client into this channel.
- enterClient(String, Object) - Method in class io.ably.lib.realtime.Presence
-
Enter a specified client into this channel.
- enterClient(String, Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Enter a specified client into this channel.
- 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 - Static variable in class io.ably.lib.util.Log
-
Priority constant; use Log.e.
- errorInfo - Variable in exception io.ably.lib.types.AblyException
-
- ErrorInfo - Class in io.ably.lib.types
-
An exception type encapsulating error information containing
an Ably-specific error code and 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
-
Generic constructor
- ErrorResponse - Class in io.ably.lib.types
-
- ErrorResponse() - Constructor for class io.ably.lib.types.ErrorResponse
-
- EventEmitter<Event,Listener> - Class in io.ably.lib.util
-
An interface exposing the ability to register listeners for a class of events
- EventEmitter() - Constructor for class io.ably.lib.util.EventEmitter
-
- EventEmitter.Filter - Class in io.ably.lib.util
-
- expires - Variable in class io.ably.lib.rest.Auth.TokenDetails
-
The time (in millis since the epoch) at which this token expires.
- get(String, Param[], Param[], Http.ResponseHandler<T>, Callback<T>) - Method in class io.ably.lib.http.AsyncHttp
-
Async HTTP GET for Ably host, with fallbacks
- get(Callback<AsyncPaginatedResult<T>>) - Method in class io.ably.lib.http.AsyncPaginatedQuery
-
Get the result of the first query
- get(String, Param[], Param[], Http.ResponseHandler<T>) - Method in class io.ably.lib.http.Http
-
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.realtime.AblyRealtime.Channels
-
Get the named channel; if it does not already exist,
create it with default options.
- get(String, ChannelOptions) - Method in class io.ably.lib.realtime.AblyRealtime.Channels
-
Get the named channel and set the given options, creating it
if it does not already exist.
- get() - Method in class io.ably.lib.realtime.Presence
-
Get the presence state for this Channel.
- get(boolean) - Method in class io.ably.lib.realtime.Presence
-
Get the presence state for this Channel, optionally waiting for sync to complete.
- get(String, boolean) - Method in class io.ably.lib.realtime.Presence
-
Get the presence state for a given clientId
- get(String) - Method in class io.ably.lib.rest.AblyRest.Channels
-
- get(String, ChannelOptions) - Method in class io.ably.lib.rest.AblyRest.Channels
-
- get(Param[]) - Method in class io.ably.lib.rest.Channel.Presence
-
Get the presence state for this Channel.
- getAlgorithm() - Method in interface io.ably.lib.util.Crypto.ChannelCipher
-
- getAsync(Param[], Callback<AsyncPaginatedResult<PresenceMessage>>) - Method in class io.ably.lib.rest.Channel.Presence
-
Asynchronously get the presence state for this Channel.
- getAuthMethod() - Method in class io.ably.lib.rest.Auth
-
Get the authentication method for this library instance.
- 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.
- getCipher() - Method in class io.ably.lib.types.ChannelOptions
-
- getCipher(ChannelOptions) - Static method in class io.ably.lib.util.Crypto
-
Internal; get a ChannelCipher instance based on the given ChannelOptions
- getConnectionState() - Method in class io.ably.lib.transport.ConnectionManager
-
- getConnectParams(Param[]) - Method in class io.ably.lib.transport.ITransport.TransportParams
-
- getContentType() - Method in class io.ably.lib.http.Http.ByteArrayRequestBody
-
- getContentType() - Method in class io.ably.lib.http.Http.JSONRequestBody
-
- getContentType() - Method in interface io.ably.lib.http.Http.RequestBody
-
- getDefaultParams() - Static method in class io.ably.lib.util.Crypto
-
Obtain a default CipherParams.
- getDefaultParams(byte[]) - Static method in class io.ably.lib.util.Crypto
-
Obtain a default CipherParams.
- getDetails(StringBuilder) - Method in class io.ably.lib.types.BaseMessage
-
Generate a String summary of this BaseMessage
- getEncoded() - Method in class io.ably.lib.http.Http.ByteArrayRequestBody
-
- getEncoded() - Method in class io.ably.lib.http.Http.JSONRequestBody
-
- getEncoded() - Method in interface io.ably.lib.http.Http.RequestBody
-
- getEncodedToken() - Method in class io.ably.lib.http.TokenAuth
-
- getFallback(String) - Static method in class io.ably.lib.transport.Hosts
-
Provides fallback host alternative for given host
- getHost() - Method in class io.ably.lib.http.Http
-
Gets host for this HTTP client
- 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.WebSocketTransport
-
- getMessageResponseHandler(ChannelOptions) - Static method in class io.ably.lib.types.MessageSerializer
-
BodyHandler
- getParams(String, int) - Static method in class io.ably.lib.util.Crypto
-
- getParams(String, byte[]) - Static method in class io.ably.lib.util.Crypto
-
- getPort(ClientOptions) - Static method in class io.ably.lib.transport.Defaults
-
- getPresenceResponseHandler(ChannelOptions) - Static method in class io.ably.lib.types.PresenceSerializer
-
BodyHandler
- getStateErrorInfo() - Method in class io.ably.lib.transport.ConnectionManager
-
- getTokenAuth() - Method in class io.ably.lib.rest.Auth
-
- getTokenDetails() - Method in class io.ably.lib.http.TokenAuth
-
- 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(String, Param[], Param[], Http.ResponseHandler<T>) - Method in class io.ably.lib.http.Http
-
HTTP GET for non-Ably host
- getUrl(String) - Method in class io.ably.lib.http.Http
-
Simple HTTP GET; no auth, headers, returning response body as byte[]
- getUrlString(String) - Method in class io.ably.lib.http.Http
-
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
-
- getValue() - Method in enum io.ably.lib.types.ProtocolMessage.Flag
-
- 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
-
- 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[], Http.BodyHandler<T>) - Constructor for class io.ably.lib.http.PaginatedQuery
-
Construct a PaginatedQuery
- PaginatedQuery.ResultPage - Class in io.ably.lib.http
-
A private class encapsulating the result of a single page response
- PaginatedResult<T> - Interface in io.ably.lib.types
-
A type that represents a page of results from a paginated query.
- 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
-
- peak - Variable in class io.ably.lib.types.Stats.ResourceCount
-
- persisted - Variable in class io.ably.lib.types.Stats
-
- ping(CompletionListener) - Method in class io.ably.lib.realtime.Connection
-
Send a heartbeat message to the Ably service and await a response.
- ping(CompletionListener) - Method in class io.ably.lib.transport.ConnectionManager
-
- plain - Variable in class io.ably.lib.types.Stats.ConnectionTypes
-
- PORT - Static variable in class io.ably.lib.transport.Defaults
-
- port - Variable in class io.ably.lib.types.ClientOptions
-
For development environments only; allows a non-default Ably port to be specified.
- post(String, Param[], Param[], Http.RequestBody, Http.ResponseHandler<T>, Callback<T>) - Method in class io.ably.lib.http.AsyncHttp
-
Async HTTP POST for Ably host, with fallbacks
- post(String, Param[], Param[], Http.RequestBody, Http.ResponseHandler<T>) - Method in class io.ably.lib.http.Http
-
HTTP POST for Ably host, with fallbacks
- presence - Variable in class io.ably.lib.realtime.Channel
-
- Presence - Class in io.ably.lib.realtime
-
A class that provides access to presence operations and state for the
associated Channel.
- presence - Variable in class io.ably.lib.rest.Channel
-
The presence instance for this channel.
- Presence() - Constructor for class io.ably.lib.rest.Channel.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 presence messages
- 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
-
Presence Action: the event signified by a PresenceMessage
- 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.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
-
- PROTOCOL_VERSION - Static variable in class io.ably.lib.transport.Defaults
-
- 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.Flag - Enum in io.ably.lib.types
-
- ProtocolSerializer - Class in io.ably.lib.types
-
- ProtocolSerializer() - Constructor for class io.ably.lib.types.ProtocolSerializer
-
- publish(String, Object) - Method in class io.ably.lib.realtime.Channel
-
Publish a message on this channel.
- publish(Message) - Method in class io.ably.lib.realtime.Channel
-
Publish a message on this channel.
- publish(Message[]) - Method in class io.ably.lib.realtime.Channel
-
Publish an array of messages on this channel.
- publish(String, Object, CompletionListener) - Method in class io.ably.lib.realtime.Channel
-
Publish a message on this channel.
- publish(Message, CompletionListener) - Method in class io.ably.lib.realtime.Channel
-
Publish a message on this channel.
- publish(Message[], CompletionListener) - Method in class io.ably.lib.realtime.Channel
-
Publish an array of messages on this channel.
- publish(String, Object) - Method in class io.ably.lib.rest.Channel
-
Publish a message on this channel using the REST API.
- publish(Message[]) - Method in class io.ably.lib.rest.Channel
-
Publish an array of messages on this channel.
- publishAsync(Message[], CompletionListener) - Method in class io.ably.lib.rest.Channel
-
Asynchronously publish an array of messages on this channel
- push(Param[], Param) - Static method in class io.ably.lib.types.Param
-
- 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
-
- serial - Variable in class io.ably.lib.realtime.Connection
-
The serial number of the last message to be received on this connection.
- Serialisation - Class in io.ably.lib.util
-
- Serialisation() - Constructor for class io.ably.lib.util.Serialisation
-
- serialize(BaseMessage, Type, JsonSerializationContext) - Method in class io.ably.lib.types.BaseMessage.Serializer
-
- serialize(Message, Type, JsonSerializationContext) - Method in class io.ably.lib.types.Message.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.BaseMessage.Serializer
-
- Serializer() - Constructor for class io.ably.lib.types.Message.Serializer
-
- Serializer() - Constructor for class io.ably.lib.types.PresenceMessage.Serializer
-
- setConnected() - Method in class io.ably.lib.realtime.Channel
-
- setHandler(Log.LogHandler) - Static method in class io.ably.lib.util.Log
-
- setHost(String) - Method in class io.ably.lib.http.Http
-
Sets host for this HTTP client
- setLevel(int) - Static method in class io.ably.lib.util.Log
-
- setOptions(ChannelOptions) - Method in class io.ably.lib.realtime.Channel
-
Channel options
- setSuspended(ErrorInfo) - Method in class io.ably.lib.realtime.Channel
-
- setThreadPoolSize(int) - Method in class io.ably.lib.http.AsyncHttp
-
- setTokenDetails(Auth.TokenDetails) - Method in class io.ably.lib.http.TokenAuth
-
- size() - Method in class io.ably.lib.util.Multicaster
-
- state - Variable in class io.ably.lib.realtime.Channel
-
The current channel state.
- state - Variable in class io.ably.lib.realtime.Connection
-
The current state of this Connection.
- state - Variable in class io.ably.lib.transport.ConnectionManager.StateInfo
-
- StateIndication(ConnectionState, ErrorInfo) - Constructor for class io.ably.lib.transport.ConnectionManager.StateIndication
-
- StateIndication(ConnectionState, ErrorInfo, boolean) - Constructor for class io.ably.lib.transport.ConnectionManager.StateIndication
-
- states - Static variable in class io.ably.lib.transport.ConnectionManager
-
all state information
- stats(Param[]) - Method in class io.ably.lib.rest.AblyRest
-
Request usage statistics for this application.
- Stats - Class in io.ably.lib.types
-
A class encapsulating a Stats datapoint.
- Stats() - Constructor for class io.ably.lib.types.Stats
-
- Stats.ConnectionTypes - Class in io.ably.lib.types
-
A breakdown of summary stats data for different (tls vs non-tls)
connection types.
- Stats.Granularity - Enum in io.ably.lib.types
-
- Stats.MessageCount - Class in io.ably.lib.types
-
A datapoint for message volume (number of messages plus aggregate data size)
- Stats.MessageTraffic - Class in io.ably.lib.types
-
A breakdown of summary stats data for traffic over various transport types.
- Stats.MessageTypes - Class in io.ably.lib.types
-
A breakdown of summary stats data for different (message vs presence)
message types.
- Stats.RequestCount - Class in io.ably.lib.types
-
Aggregate data for numbers of requests in a specific scope.
- Stats.ResourceCount - Class in io.ably.lib.types
-
Aggregate data for usage of a resource in a specific scope.
- statsAsync(Param[], Callback<AsyncPaginatedResult<Stats>>) - Method in class io.ably.lib.rest.AblyRest
-
Asynchronously obtain usage statistics for this application using the REST API.
- 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.types.ErrorInfo
-
HTTP Status Code corresponding to this error, where applicable
- subscribe(Channel.MessageListener) - Method in class io.ably.lib.realtime.Channel
-
Subscribe for messages on this channel.
- subscribe(String, Channel.MessageListener) - Method in class io.ably.lib.realtime.Channel
-
Subscribe for messages with a specific event name on this channel.
- subscribe(String[], Channel.MessageListener) - Method in class io.ably.lib.realtime.Channel
-
Subscribe for messages with an array of event names on this channel.
- subscribe(Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Subscribe to presence events on the associated Channel.
- subscribe(PresenceMessage.Action, Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Subscribe to presence events with a specific action on the associated Channel.
- subscribe(EnumSet<PresenceMessage.Action>, Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Subscribe to presence events with specific actions on the associated Channel.
- succeeded - Variable in class io.ably.lib.types.Stats.RequestCount
-
- suspendAll(ErrorInfo) - Method in class io.ably.lib.realtime.AblyRealtime.Channels
-
- sync() - Method in class io.ably.lib.realtime.Channel
-
- unit - Variable in class io.ably.lib.types.Stats
-
- unsubscribe() - Method in class io.ably.lib.realtime.Channel
-
Unsubscribe all subscribed listeners from this channel.
- unsubscribe(Channel.MessageListener) - Method in class io.ably.lib.realtime.Channel
-
Unsubscribe a previously subscribed listener from this channel.
- unsubscribe(String, Channel.MessageListener) - Method in class io.ably.lib.realtime.Channel
-
Unsubscribe a previously subscribed event listener from this channel.
- unsubscribe(String[], Channel.MessageListener) - Method in class io.ably.lib.realtime.Channel
-
Unsubscribe a previously subscribed event listener from this channel.
- unsubscribe(Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Unsubscribe a previously subscribed presence listener for this channel.
- unsubscribe(PresenceMessage.Action, Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Unsubscribe a previously subscribed presence listener for this channel from specific action.
- unsubscribe(EnumSet<PresenceMessage.Action>, Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Unsubscribe a previously subscribed presence listener for this channel from specific actions.
- unsubscribe() - Method in class io.ably.lib.realtime.Presence
-
Unsubscribe all subscribed presence lisceners for this channel.
- update(Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Update the presence data for this client.
- updateClient(String) - Method in class io.ably.lib.realtime.Presence
-
Update the presence data for a specified client into this channel.
- updateClient(String, Object) - Method in class io.ably.lib.realtime.Presence
-
Update the presence data for a specified client into this channel.
- updateClient(String, Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Update the presence data for a specified client into this channel.
- updatePresence(PresenceMessage, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Update the presence for this channel with a given PresenceMessage update.
- useBinaryProtocol - Variable in class io.ably.lib.types.ClientOptions
-
If false, forces the library to use the JSON encoding for REST and Realtime operations,
instead of the default binary msgpack encoding.
- 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.realtime.ChannelState
-
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.transport.ITransport.Mode
-
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.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.ConnectionState
-
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.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.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.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() - 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.
- VERBOSE - Static variable in class io.ably.lib.util.Log
-
Priority constant; use Log.v.