A B C D E F G H I J K L M N O P Q R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ABLY_LIB_HEADER - Static variable in class io.ably.lib.transport.Defaults
- ABLY_LIB_PARAM - Static variable in class io.ably.lib.transport.Defaults
- ABLY_LIB_VERSION - Static variable in class io.ably.lib.transport.Defaults
- ABLY_VERSION - Static variable in class io.ably.lib.transport.Defaults
- 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
-
AblyBase The top-level class to be instanced for the Ably REST library.
- AblyBase(ClientOptions) - Constructor for class io.ably.lib.rest.AblyBase
-
Instance the Ably library with the given options.
- AblyBase(String) - Constructor for class io.ably.lib.rest.AblyBase
-
Instance the Ably library using a key only.
- AblyBase.Channels - Class 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
-
AblyRealtime The top-level class to be instanced for the Ably Realtime library.
- AblyRealtime(ClientOptions) - Constructor for class io.ably.lib.realtime.AblyRealtime
-
Instance the Ably library with the given options.
- AblyRealtime(String) - Constructor for class io.ably.lib.realtime.AblyRealtime
-
Instance the Ably library using a key only.
- 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(ClientOptions) - Constructor for class io.ably.lib.rest.AblyRest
-
Instance the Ably library with the given options.
- AblyRest(String) - Constructor for class io.ably.lib.rest.AblyRest
-
Instance the Ably library using a key only.
- absent - io.ably.lib.types.PresenceMessage.Action
- ACCEPT - Static variable in class io.ably.lib.http.HttpConstants.Headers
- accessToken - Variable in class io.ably.lib.types.ProtocolMessage.AuthDetails
- ack - io.ably.lib.types.ProtocolMessage.Action
- 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
- ACTIVE - io.ably.lib.rest.DeviceDetails.Push.State
- 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.
- addResource(String) - Method in class io.ably.lib.types.Capability
-
Add a resource to an existing Capability instance with an empty 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, 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
- 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(Event, Object...) - Method in class io.ably.lib.util.EventEmitter.Filter
- 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
- 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.
- 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
- asJSONRequest(Message.Batch[]) - Static method in class io.ably.lib.types.MessageSerializer
- 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.Batch[]) - Static method in class io.ably.lib.types.MessageSerializer
- asMsgpackRequest(Message[]) - 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 - io.ably.lib.types.ProtocolMessage.Action
- attach() - Method in class io.ably.lib.realtime.ChannelBase
-
Attach to this channel.
- attach(CompletionListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Attach to this channel.
- attached - io.ably.lib.realtime.ChannelEvent
- attached - io.ably.lib.realtime.ChannelState
- attached - io.ably.lib.types.ProtocolMessage.Action
- attaching - io.ably.lib.realtime.ChannelEvent
- attaching - io.ably.lib.realtime.ChannelState
- attachSerial - Variable in class io.ably.lib.types.ChannelProperties
-
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 - io.ably.lib.types.ProtocolMessage.Action
- auth - Variable in class io.ably.lib.rest.AblyBase
- auth - Variable in class io.ably.lib.types.ProtocolMessage
- 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 TokenRequest, TokenDetails or a token string.
- authChallenge - Variable in exception io.ably.lib.http.HttpCore.AuthRequiredException
- AuthDetails(String) - Constructor for class io.ably.lib.types.ProtocolMessage.AuthDetails
- authHeaders - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
Headers to be included in any request made by the library to the authURL.
- authMethod - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
TO3j7: authMethod: The HTTP verb to be used when a request is 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.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
-
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.
- AuthRequiredException(Throwable, ErrorInfo) - Constructor for exception io.ably.lib.http.HttpCore.AuthRequiredException
- authUrl - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
A URL to query to obtain a signed TokenRequest, TokenDetails or a token string.
- autoConnect - Variable in class io.ably.lib.types.ClientOptions
-
If false, suppresses the automatic initiation of a connection when the library is instanced.
B
- Base64Coder - Class in io.ably.lib.util
-
A Base64 encoder/decoder.
- BaseMessage - Class in io.ably.lib.types
- BaseMessage() - Constructor for class io.ably.lib.types.BaseMessage
- BaseMessage.Serializer - Class in io.ably.lib.types
- BasePaginatedQuery<T> - Class in io.ably.lib.http
-
A paginated query base implementation that can be used sync or asynchronously.
- BasePaginatedQuery(Http, String, Param[], Param[], HttpCore.BodyHandler<T>) - Constructor for class io.ably.lib.http.BasePaginatedQuery
-
Construct a PaginatedQuery
- BasePaginatedQuery(Http, String, Param[], Param[], HttpCore.RequestBody, HttpCore.BodyHandler<T>) - Constructor for class io.ably.lib.http.BasePaginatedQuery
-
Construct a PaginatedQuery
- BasePaginatedQuery.ResultRequest<T> - Class in io.ably.lib.http
-
Wraps a Http.Request
> to fixate on either a sync or an async interface. - BasePaginatedQuery.ResultRequest.Failed<T> - Class in io.ably.lib.http
-
A ResultRequest that has already failed due to a previous condition.
- BasePaginatedResult<T> - Interface in io.ably.lib.types
-
A type that represents a page of results from a paginated query.
- basic - io.ably.lib.rest.Auth.AuthMethod
- BASIC - io.ably.lib.http.HttpAuth.Type
- Batch(String[], Message[]) - Constructor for class io.ably.lib.types.Message.Batch
- Batch(String, Message[]) - Constructor for class io.ably.lib.types.Message.Batch
- Batch(Collection<String>, Collection<Message>) - Constructor for class io.ably.lib.types.Message.Batch
- body - Variable in class io.ably.lib.http.HttpCore.Response
- ByteArrayRequestBody(byte[], String) - Constructor for class io.ably.lib.http.HttpUtils.ByteArrayRequestBody
C
- 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 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 - Variable in class io.ably.lib.push.PushBase.ChannelSubscription
- channel - Variable in class io.ably.lib.types.ProtocolMessage
- Channel - Class in io.ably.lib.realtime
- Channel - Class in io.ably.lib.rest
- Channel.MessageListener - Interface in io.ably.lib.realtime
- ChannelBase - Class in io.ably.lib.realtime
-
A class representing a Channel belonging to this application.
- 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 messages changes on a channel.
- ChannelBase.Presence - Class in io.ably.lib.rest
-
A class enabling access to Channel Presence information via the REST API.
- ChannelEvent - Enum in io.ably.lib.realtime
-
Channel event
- channelId - Variable in class io.ably.lib.types.PublishResponse
- ChannelOptions - Class in io.ably.lib.types
- ChannelOptions() - Constructor for class io.ably.lib.types.ChannelOptions
- ChannelProperties - Class in io.ably.lib.types
-
(RTL15) Channel#properties attribute is a ChannelProperties object representing properties of the channel state
- ChannelProperties() - Constructor for class io.ably.lib.types.ChannelProperties
- channelRetryTimeout - Variable in class io.ably.lib.types.ClientOptions
-
Channel reattach timeout Spec: RTL13b
- channels - Variable in class io.ably.lib.realtime.AblyRealtime
-
The
#Channelsassociated with this instance. - channels - Variable in class io.ably.lib.rest.AblyBase
- channels - Variable in class io.ably.lib.types.Message.Batch
- channels - Variable in class io.ably.lib.types.Stats
- Channels() - Constructor for class io.ably.lib.realtime.AblyRealtime.Channels
- Channels() - Constructor for class io.ably.lib.rest.AblyBase.Channels
- 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.ChannelStateChange - Class in io.ably.lib.realtime
-
Channel state change.
- 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
- 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
-
Parameters for the cipher.
- clean - io.ably.lib.transport.ITransport.Mode
- 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
- clientId - Variable in class io.ably.lib.rest.Auth
-
The clientId for this library instance Spec RSA7b
- 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.rest.DeviceDetails
- 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 - io.ably.lib.types.ProtocolMessage.Action
- 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() - Method in interface io.ably.lib.transport.ITransport
-
Close this transport.
- close() - Method in class io.ably.lib.transport.WebSocketTransport
- closed - io.ably.lib.realtime.ConnectionEvent
- closed - io.ably.lib.realtime.ConnectionState
- closed - io.ably.lib.types.ProtocolMessage.Action
- closing - io.ably.lib.realtime.ConnectionEvent
- closing - io.ably.lib.realtime.ConnectionState
- code - Variable in enum io.ably.lib.rest.DeviceDetails.Push.State
- 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.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 - io.ably.lib.types.ProtocolMessage.Action
- connect() - Method in class io.ably.lib.realtime.AblyRealtime
-
Initiate a connection.
- 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
- 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
- connected - io.ably.lib.realtime.ConnectionEvent
- connected - io.ably.lib.realtime.ConnectionState
- connected - io.ably.lib.types.ProtocolMessage.Action
- connecting - io.ably.lib.realtime.ConnectionEvent
- connecting - io.ably.lib.realtime.ConnectionState
- connection - Variable in class io.ably.lib.realtime.AblyRealtime
-
The
Connectionobject for this instance. - Connection - Class in io.ably.lib.realtime
-
A class representing the connection associated with an AblyRealtime instance.
- connectionDetails - Variable in class io.ably.lib.types.ProtocolMessage
- ConnectionDetails - Class in io.ably.lib.types
- ConnectionEvent - Enum in io.ably.lib.realtime
-
Connection event
- 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
- 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
-
ConnectionManager
- 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
- 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
-
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
- connectionStateTtl - Static variable in class io.ably.lib.transport.Defaults
- connectionStateTtl - Variable in class io.ably.lib.types.ConnectionDetails
- ConnectionTypes() - Constructor for class io.ably.lib.types.Stats.ConnectionTypes
- containsKey(Param[], String) - Static method in class io.ably.lib.types.Param
- 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
- 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.TokenParams, Auth.AuthOptions) - Method in class io.ably.lib.rest.Auth
-
Create a signed token request based on known credentials and the given token params.
- createUpdateEvent(ErrorInfo) - Static method in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
- 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 - Variable in class io.ably.lib.realtime.ChannelStateListener.ChannelStateChange
- current - Variable in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
- current() - Method in class io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
- 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
- current(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
- current(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.types.AsyncHttpPaginatedResponse
- current(Callback<AsyncPaginatedResult<T>>) - Method in interface io.ably.lib.types.AsyncPaginatedResult
- CurrentThreadExecutor - Class in io.ably.lib.util
- CurrentThreadExecutor() - Constructor for class io.ably.lib.util.CurrentThreadExecutor
D
- 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.
- data - Variable in class io.ably.lib.types.Stats.MessageCount
- day - io.ably.lib.types.Stats.Granularity
- 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(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.
- decode(ChannelOptions) - 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.
- 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.
- decrypt(byte[]) - Method in interface io.ably.lib.util.Crypto.ChannelCipher
- 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
-
When a TokenParams object is provided, it will override the client library defaults described in TokenParams Spec: TO3j11
- 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
- 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 - io.ably.lib.types.ProtocolMessage.Action
- 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.
- detached - io.ably.lib.realtime.ChannelEvent
- detached - io.ably.lib.realtime.ChannelState
- detached - io.ably.lib.types.ProtocolMessage.Action
- detaching - io.ably.lib.realtime.ChannelEvent
- detaching - io.ably.lib.realtime.ChannelState
- DeviceDetails - Class in io.ably.lib.rest
- DeviceDetails() - Constructor for class io.ably.lib.rest.DeviceDetails
- DeviceDetails.Push - Class in io.ably.lib.rest
- DeviceDetails.Push.State - Enum in io.ably.lib.rest
- deviceId - Variable in class io.ably.lib.push.PushBase.ChannelSubscription
- deviceRegistrations - Variable in class io.ably.lib.push.PushBase.Admin
- DIGEST - io.ably.lib.http.HttpAuth.Type
- disconnect - io.ably.lib.types.ProtocolMessage.Action
- disconnected - io.ably.lib.realtime.ConnectionEvent
- disconnected - io.ably.lib.realtime.ConnectionState
- disconnected - io.ably.lib.types.ProtocolMessage.Action
- dispose() - Method in class io.ably.lib.http.AsyncHttpScheduler
E
- 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)
- 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.
- emitUpdate(ErrorInfo) - Method in class io.ably.lib.realtime.Connection
- 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.
- encode(ChannelOptions) - Method in class io.ably.lib.types.BaseMessage
- 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
-
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
-
Whether or not this ChannelOptions is encrypted.
- enter - io.ably.lib.types.PresenceMessage.Action
- 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.
- environment - Variable in class io.ably.lib.types.ClientOptions
-
For development environments only; allows a non-default Ably environment to be used such as 'sandbox'.
- 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.ErrorInfo
- equals(Object) - Method in class io.ably.lib.types.Param
- error - io.ably.lib.types.ProtocolMessage.Action
- 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
- 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
- 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
- errorMessage - Variable in class io.ably.lib.types.AsyncHttpPaginatedResponse
- errorMessage - Variable in class io.ably.lib.types.HttpPaginatedResponse
- errorReason - Variable in class io.ably.lib.rest.DeviceDetails.Push
- 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
-
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
- exec() - Method in class io.ably.lib.http.HttpPaginatedQuery
-
Get the result of the first query
- exec(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery
- exec(Param[]) - Method in class io.ably.lib.http.HttpPaginatedQuery
-
Get the result of the first query
- 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(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.util.CurrentThreadExecutor
- executor - Variable in class io.ably.lib.http.HttpScheduler
- 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 time (in millis since the epoch) at which this token expires.
- extras - Variable in class io.ably.lib.types.Message
-
Extras, if available
F
- Factory() - Constructor for class io.ably.lib.transport.WebSocketTransport.Factory
- failed - io.ably.lib.realtime.ChannelEvent
- failed - io.ably.lib.realtime.ChannelState
- failed - io.ably.lib.realtime.ConnectionEvent
- failed - io.ably.lib.realtime.ConnectionState
- failed - Variable in class io.ably.lib.types.Stats.RequestCount
- Failed(AblyException) - Constructor for class io.ably.lib.http.BasePaginatedQuery.ResultRequest.Failed
- FAILED - io.ably.lib.rest.DeviceDetails.Push.State
- failedRequest(AblyException) - Method in class io.ably.lib.http.Http
- FAILING - io.ably.lib.rest.DeviceDetails.Push.State
- fallbackHosts - Variable in class io.ably.lib.types.ClientOptions
-
Spec: TO3k6,RSC15a,RSC15b,RTN17b list of custom fallback hosts.
- fallbackHostsRemaining(String) - Method in class io.ably.lib.transport.Hosts
- fallbackHostsUseDefault - Variable in class io.ably.lib.types.ClientOptions
-
Spec: TO3k7 Set to use default fallbackHosts even when overriding environment or restHost/realtimeHost
- fallbackRetryTimeout - Static variable in class io.ably.lib.transport.Defaults
- fallbackRetryTimeout - Variable in class io.ably.lib.types.ClientOptions
-
Spec: TO3l10
- finalize() - Method in class io.ably.lib.http.HttpCore
- findByValue(int) - Static method in enum io.ably.lib.types.PresenceMessage.Action
- findByValue(int) - Static method in enum io.ably.lib.types.ProtocolMessage.Action
- findByValue(int) - Static method in enum io.ably.lib.types.ProtocolMessage.Flag
- first() - Method in class io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
- 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
-
Perform the given relative query
- first(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
- 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
-
Obtain params required to perform the given relative query
- 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
- forDevice(String, String) - Static method in class io.ably.lib.push.PushBase.ChannelSubscription
- FORM_ENCODING - Static variable in class io.ably.lib.http.HttpConstants.ContentTypes
- formFactor - Variable in class io.ably.lib.rest.DeviceDetails
- 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
-
Refer Spec TM3
An alternative constructor that take an Message-JSON object and a channelOptions (optional), and return a Message - fromEncoded(JsonObject, ChannelOptions) - Static method in class io.ably.lib.types.PresenceMessage
-
Refer Spec TP4
An alternative constructor that take an PresenceMessage-JSON object and a channelOptions (optional), and return a PresenceMessage - fromEncoded(String, ChannelOptions) - Static method in class io.ably.lib.types.Message
-
Refer Spec TM3
An alternative constructor that takes a Stringified Message-JSON and a channelOptions (optional), and return a Message - fromEncoded(String, ChannelOptions) - Static method in class io.ably.lib.types.PresenceMessage
-
Refer Spec TP4
An alternative constructor that takes a Stringified PresenceMessage-JSON and a channelOptions (optional), and return a PresenceMessage - fromEncodedArray(JsonArray, ChannelOptions) - Static method in class io.ably.lib.types.Message
-
Refer Spec TM3
An alternative constructor that takes a Messages JsonArray and a channelOptions (optional), and return array of Messages. - fromEncodedArray(JsonArray, ChannelOptions) - Static method in class io.ably.lib.types.PresenceMessage
-
Refer Spec TP4
An alternative constructor that takes a PresenceMessage JsonArray and a channelOptions (optional), and return array of PresenceMessages. - fromEncodedArray(String, ChannelOptions) - Static method in class io.ably.lib.types.Message
- fromEncodedArray(String, ChannelOptions) - Static method in class io.ably.lib.types.PresenceMessage
-
Refer Spec TP4
An alternative constructor that takes a Stringified PresenceMessages Array and a channelOptions (optional), and return array of PresenceMessages. - 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(String) - Static method in class io.ably.lib.rest.Auth.TokenDetails
-
Convert a JSON element response body to a TokenDetails.
- fromJson(String) - Static method in class io.ably.lib.rest.Auth.TokenRequest
-
Convert a string JSON response body to a TokenParams.
- fromJSON(JsonObject) - Static method in class io.ably.lib.rest.Auth.TokenDetails
-
Deprecated.
- fromJSON(JsonObject) - Static method in class io.ably.lib.rest.Auth.TokenRequest
-
Deprecated.
- 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 - Static variable in class io.ably.lib.util.StringUtils
- fromJsonElement(JsonElement) - Method in interface io.ably.lib.util.Serialisation.FromJsonElement
- fromJsonElement(JsonObject) - Static method in class io.ably.lib.rest.Auth.TokenDetails
-
Convert a JSON element response body to a TokenDetails.
- fromJsonElement(JsonObject) - Static method in class io.ably.lib.rest.Auth.TokenRequest
-
Convert a parsed JSON response body to a TokenParams.
- 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
G
- generateRandomKey() - Static method in class io.ably.lib.util.Crypto
- generateRandomKey(int) - Static method in class io.ably.lib.util.Crypto
- get() - Method in class io.ably.lib.http.BasePaginatedQuery
-
Get the result of the first query
- get() - Method in class io.ably.lib.http.PaginatedQuery
-
Get the result of the first query
- get(boolean) - Method in class io.ably.lib.realtime.Presence
-
Get the presence state for this Channel, optionally waiting for sync to complete.
- get(Callback<AsyncPaginatedResult<T>>) - Method in class io.ably.lib.http.AsyncPaginatedQuery
-
Get the result of the first query
- get(Param...) - Method in class io.ably.lib.realtime.Presence
-
Get the presence state for this channel.
- get(Param[]) - Method in class io.ably.lib.rest.ChannelBase.Presence
-
Get the presence state for this Channel.
- get(String) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- 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) - Method in class io.ably.lib.rest.AblyBase.Channels
- get(String, boolean) - Method in class io.ably.lib.realtime.Presence
-
Get the presence state for a given clientId.
- 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(String, ChannelOptions) - Method in class io.ably.lib.rest.AblyBase.Channels
- 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 - Static variable in class io.ably.lib.http.HttpConstants.Methods
- 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.ChannelCipher
- getAsync(Param[], Callback<AsyncPaginatedResult<PresenceMessage>>) - Method in class io.ably.lib.rest.ChannelBase.Presence
-
Asynchronously get the presence state for this Channel.
- getAsync(String, Callback<DeviceDetails>) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- 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() - Method in class io.ably.lib.rest.Auth
- getAuthorizationHeader(String, String, byte[]) - Method in class io.ably.lib.http.HttpAuth
-
Get authorization header based on the last-received server nonce.
- 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
- 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
- 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
- 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.
- getDefaultParams(String) - Static method in class io.ably.lib.util.Crypto
-
Obtain a default CipherParams using Base64-encoded key.
- 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
- 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
- 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
- getMessageResponseHandler(ChannelOptions) - Static method in class io.ably.lib.types.MessageSerializer
-
BodyHandler
- getNetworkConnectivity() - Method in class io.ably.lib.platform.Platform
- getParam(Param[], String) - Static method in class io.ably.lib.http.HttpUtils
- 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
- getParams(String, int) - Static method in class io.ably.lib.util.Crypto
- getPort() - Method in class io.ably.lib.transport.ITransport.TransportParams
- getPort(ClientOptions) - Static method in class io.ably.lib.transport.Defaults
- 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
- getRandomMessageId() - Static method in class io.ably.lib.util.Crypto
- getStateErrorInfo() - Method in class io.ably.lib.transport.ConnectionManager
- 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
- 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
- gsonToMsgpack(JsonElement) - Static method in class io.ably.lib.util.Serialisation
- gsonToMsgpack(JsonElement, MessagePacker) - Static method in class io.ably.lib.util.Serialisation
H
- 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
- has_backlog - io.ably.lib.types.ProtocolMessage.Flag
- has_presence - io.ably.lib.types.ProtocolMessage.Flag
- 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
- hashCode() - Method in class io.ably.lib.types.Param
- 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
- 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
- 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
- Headers() - Constructor for class io.ably.lib.http.HttpConstants.Headers
- heartbeat - io.ably.lib.types.ProtocolMessage.Action
- heartbeats - Variable in class io.ably.lib.transport.ITransport.TransportParams
- history(Param[]) - Method in class io.ably.lib.realtime.ChannelBase
-
Obtain recent history for this channel using the REST API.
- history(Param[]) - Method in class io.ably.lib.realtime.Presence
-
Obtain recent history for this channel using the REST API.
- 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
-
Asynchronously obtain presence history for this channel using the REST API.
- historyAsync(Param[], Callback<AsyncPaginatedResult<Message>>) - Method in class io.ably.lib.realtime.ChannelBase
- 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.realtime.Presence
- historyAsync(Param[], Callback<AsyncPaginatedResult<PresenceMessage>>) - Method in class io.ably.lib.rest.ChannelBase.Presence
-
Asynchronously obtain recent history for this channel using the REST API.
- 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
- hour - io.ably.lib.types.Stats.Granularity
- href - Variable in class io.ably.lib.types.ErrorInfo
-
Link to specification detail for this error code, where available.
- http - Variable in class io.ably.lib.rest.AblyBase
- 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_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
- Http.Execute<Result> - Interface in io.ably.lib.http
- Http.Request<Result> - Class in io.ably.lib.http
- 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 - Static variable in class io.ably.lib.util.StringUtils
- 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(Class<T[]>, Serialisation.FromJsonElement<T>) - Constructor for class io.ably.lib.util.Serialisation.HttpBodyHandler
- 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 - Variable in class io.ably.lib.rest.AblyBase
- HttpCore - Class in io.ably.lib.http
-
HttpCore performs authenticated HTTP synchronously.
- HttpCore(ClientOptions, Auth) - Constructor for class io.ably.lib.http.HttpCore
-
Public API
- 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(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
- 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
- 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
-
Max 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
- httpOpenTimeout - Variable in class io.ably.lib.types.ClientOptions
-
Spec: TO313
- 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 type that represents a page of results from a paginated http query.
- HttpPaginatedResponse() - Constructor for class io.ably.lib.types.HttpPaginatedResponse
- httpRequestTimeout - Variable in class io.ably.lib.types.ClientOptions
-
Spec: TO314
- 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 - Static variable in class io.ably.lib.util.StringUtils
- 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(Class<T>, Serialisation.FromJsonElement<T>) - Constructor for class io.ably.lib.util.Serialisation.HttpResponseHandler
- HttpScheduler<Executor extends java.util.concurrent.Executor> - Class in io.ably.lib.http
-
HttpScheduler schedules HttpCore operations to an Executor, exposing a generic async API.
- HttpScheduler(HttpCore, Executor) - 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
I
- i(String, String) - Static method in class io.ably.lib.util.Log
- i(String, String, Throwable) - Static method in class io.ably.lib.util.Log
- id - Variable in class io.ably.lib.realtime.Connection
-
A public identifier for this connection, used to identify this member in presence events and message ids.
- id - Variable in class io.ably.lib.rest.DeviceDetails
- id - Variable in class io.ably.lib.types.BaseMessage
-
A unique id for this message
- id - Variable in class io.ably.lib.types.ProtocolMessage
- idempotentRestPublishing - Variable in class io.ably.lib.types.ClientOptions
-
Spec: TO3n
- inbound - Variable in class io.ably.lib.types.Stats
- indexParams(Param[]) - Static method in class io.ably.lib.http.HttpUtils
- INFO - Static variable in class io.ably.lib.util.Log
-
Priority constant; use Log.i.
- initialized - io.ably.lib.realtime.ChannelEvent
- initialized - io.ably.lib.realtime.ChannelState
- initialized - io.ably.lib.realtime.ConnectionEvent
- initialized - io.ably.lib.realtime.ConnectionState
- INSTANCE - Static variable in class io.ably.lib.util.CurrentThreadExecutor
- intervalId - Variable in class io.ably.lib.types.Stats
- io.ably.annotation - package io.ably.annotation
- io.ably.lib.debug - package io.ably.lib.debug
- io.ably.lib.http - package io.ably.lib.http
- io.ably.lib.platform - package io.ably.lib.platform
- io.ably.lib.push - package io.ably.lib.push
- io.ably.lib.realtime - package io.ably.lib.realtime
- io.ably.lib.rest - package io.ably.lib.rest
- io.ably.lib.transport - package io.ably.lib.transport
- io.ably.lib.types - package io.ably.lib.types
- io.ably.lib.util - package io.ably.lib.util
- isActive() - Method in class io.ably.lib.transport.ConnectionManager
- isEmpty() - Method in class io.ably.lib.transport.NetworkConnectivity
- isEmpty() - Method in class io.ably.lib.util.Multicaster
- isLast() - Method in class io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
- isLast() - Method in interface io.ably.lib.types.BasePaginatedResult
- isLast() - Method in class io.ably.lib.types.HttpPaginatedResponse
- isLast() - Method in interface io.ably.lib.types.PaginatedResult
- issued - Variable in class io.ably.lib.rest.Auth.TokenDetails
-
The time (in millis since the epoch) at which this token was issued.
- items() - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
- items() - Method in class io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
- items() - Method in class io.ably.lib.types.AsyncHttpPaginatedResponse
-
Get the contents as an array of component type
- items() - Method in interface io.ably.lib.types.AsyncPaginatedResult
-
Get the contents as an array of component type
- items() - Method in interface io.ably.lib.types.BasePaginatedResult
-
Get the contents as an array of component type
- items() - Method in class io.ably.lib.types.HttpPaginatedResponse
-
Get the contents as an array of component type
- items() - Method in interface io.ably.lib.types.PaginatedResult
-
Get the contents as an array of component type
- iterator() - Method in class io.ably.lib.util.Multicaster
- ITransport - Interface in io.ably.lib.transport
- ITransport.ConnectListener - Interface in io.ably.lib.transport
- ITransport.Factory - Interface in io.ably.lib.transport
- ITransport.Mode - Enum in io.ably.lib.transport
- ITransport.TransportParams - Class in io.ably.lib.transport
J
- JSON - Static variable in class io.ably.lib.http.HttpConstants.ContentTypes
- jsonBytesToGson(byte[]) - Static method in class io.ably.lib.util.Serialisation
- jsonBytesToGson(byte[], Class<T>) - Static method in class io.ably.lib.util.Serialisation
- JsonRequestBody(Object) - Constructor for class io.ably.lib.http.HttpUtils.JsonRequestBody
- JsonRequestBody(String) - Constructor for class io.ably.lib.http.HttpUtils.JsonRequestBody
- JsonUtils - Class in io.ably.lib.util
- JsonUtils() - Constructor for class io.ably.lib.util.JsonUtils
- JsonUtils.JsonUtilsObject - Class in io.ably.lib.util
K
- key - Variable in class io.ably.lib.realtime.Connection
-
The assigned connection key.
- key - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
Full Ably key string as obtained from dashboard.
- key - Variable in class io.ably.lib.types.Param
- keyName - Variable in class io.ably.lib.rest.Auth.TokenRequest
-
The keyName of the key against which this request is made.
L
- leave - io.ably.lib.types.PresenceMessage.Action
- leave(CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Leave this client from this channel.
- leave(Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Leave this client from this channel.
- leaveClient(String) - Method in class io.ably.lib.realtime.Presence
-
Leave a given client from this channel.
- leaveClient(String, Object) - Method in class io.ably.lib.realtime.Presence
-
Leave a given client from this channel.
- leaveClient(String, Object, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Leave a given client from this channel.
- 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
- list(Param[]) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- listAsync(Param[], Callback<AsyncPaginatedResult<PushBase.ChannelSubscription>>) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
- listAsync(Param[], Callback<AsyncPaginatedResult<DeviceDetails>>) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- listChannels(Param[]) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
- listChannelsAsync(Param[], Callback<AsyncPaginatedResult<String>>) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
- 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
- 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
-
Log handler: allows the client to intercept log messages and handle them in a client-specific way.
- logLevel - Variable in class io.ably.lib.types.ClientOptions
-
Log level; controls the level of verbosity of log messages from the library.
M
- mac - Variable in class io.ably.lib.rest.Auth.TokenRequest
-
The Message Authentication Code for this request.
- map(T) - Method in class io.ably.lib.types.Callback.Map
- Map(Callback<U>) - Constructor for class io.ably.lib.types.Callback.Map
- maxFrameSize - Variable in class io.ably.lib.types.ConnectionDetails
- maxIdleInterval - Static variable in class io.ably.lib.transport.Defaults
- maxIdleInterval - Variable in class io.ably.lib.types.ConnectionDetails
- maxInboundRate - Variable in class io.ably.lib.types.ConnectionDetails
- maxMessageSize - Variable in class io.ably.lib.types.ConnectionDetails
- maxOutboundRate - Variable in class io.ably.lib.types.ConnectionDetails
- mean - Variable in class io.ably.lib.types.Stats.ResourceCount
- memberKey() - Method in class io.ably.lib.types.PresenceMessage
-
Get the member key for the PresenceMessage.
- members - Variable in class io.ably.lib.util.Multicaster
- 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
- mergeTo(ProtocolMessage, ProtocolMessage) - Static method in class io.ably.lib.types.ProtocolMessage
- message - io.ably.lib.types.ProtocolMessage.Action
- message - Variable in class io.ably.lib.types.ErrorInfo
-
Additional message information, where available
- Message - Class in io.ably.lib.types
-
A class representing an individual message to be sent or received via the Ably Realtime service.
- 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 from event name and data
- Message(String, Object, JsonObject) - Constructor for class io.ably.lib.types.Message
- Message(String, Object, String) - Constructor for class io.ably.lib.types.Message
- Message(String, Object, String, JsonObject) - Constructor for class io.ably.lib.types.Message
-
Generic constructor
- Message.Batch - Class in io.ably.lib.types
-
A specification for a collection of messages to be sent using the batch API
- Message.Serializer - Class in io.ably.lib.types
- MessageCount() - Constructor for class io.ably.lib.types.Stats.MessageCount
- MessageDecodeException - Exception in io.ably.lib.types
-
Special AblyException for message decoding problems
- messageId - Variable in class io.ably.lib.types.PublishResponse
- messages - Variable in class io.ably.lib.types.Message.Batch
- messages - Variable in class io.ably.lib.types.ProtocolMessage
- messages - Variable in class io.ably.lib.types.Stats.MessageTypes
- 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
- 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
- minute - io.ably.lib.types.Stats.Granularity
- mode - Variable in class io.ably.lib.transport.ITransport.TransportParams
- month - io.ably.lib.types.Stats.Granularity
- 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<T> - Class in io.ably.lib.util
- Multicaster() - Constructor for class io.ably.lib.realtime.ChannelStateListener.Multicaster
- Multicaster() - Constructor for class io.ably.lib.realtime.ConnectionStateListener.Multicaster
- Multicaster(CompletionListener...) - Constructor for class io.ably.lib.realtime.CompletionListener.Multicaster
- Multicaster(T...) - Constructor for class io.ably.lib.util.Multicaster
N
- nack - io.ably.lib.types.ProtocolMessage.Action
- name - Static variable in class io.ably.lib.platform.Platform
- name - Variable in class io.ably.lib.realtime.ChannelBase
-
The name of this channel.
- name - Variable in class io.ably.lib.rest.ChannelBase
-
The Channel name
- name - Variable in class io.ably.lib.types.Message
-
The event name, if available
- NetworkConnectivity - Class in io.ably.lib.transport
- NetworkConnectivity() - Constructor for class io.ably.lib.transport.NetworkConnectivity
- NetworkConnectivity.DefaultNetworkConnectivity - Class in io.ably.lib.transport
- NetworkConnectivity.DelegatedNetworkConnectivity - Class in io.ably.lib.transport
- NetworkConnectivity.NetworkConnectivityListener - Interface in io.ably.lib.transport
- next() - Method in class io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
- next() - Method in interface io.ably.lib.types.BasePaginatedResult
- next() - Method in class io.ably.lib.types.HttpPaginatedResponse
- next() - Method in interface io.ably.lib.types.PaginatedResult
- next(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
- next(AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.types.AsyncHttpPaginatedResponse
- next(Callback<AsyncPaginatedResult<T>>) - Method in interface io.ably.lib.types.AsyncPaginatedResult
- nonce - Variable in class io.ably.lib.rest.Auth.TokenRequest
-
An opaque nonce string of at least 16 characters to ensure uniqueness of this request.
- NONE - Static variable in class io.ably.lib.util.Log
-
Priority constant to suppress all logging.
- nonProxyHosts - Variable in class io.ably.lib.types.ProxyOptions
- notifyNetworkAvailable() - Method in class io.ably.lib.transport.NetworkConnectivity
- notifyNetworkUnavailable(ErrorInfo) - Method in class io.ably.lib.transport.NetworkConnectivity
O
- object() - Static method in class io.ably.lib.util.JsonUtils
- off() - Method in class io.ably.lib.util.EventEmitter
-
Remove all registered listeners irrespective of type
- off(Event, Listener) - Method in class io.ably.lib.util.EventEmitter
-
Remove a previously registered event-specific listener
- off(Listener) - Method in class io.ably.lib.util.EventEmitter
-
Remove a previously registered listener irrespective of type
- on(Event, Listener) - Method in class io.ably.lib.util.EventEmitter
-
Register the given listener for a specific 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
-
Register the given listener for all events
- 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.
- once(Event, Listener) - Method in class io.ably.lib.util.EventEmitter
-
Register the given listener for a single occurrence of a specific event
- 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
-
Register the given listener for a single occurrence of any event
- onChannelMessage(ITransport, ProtocolMessage) - Method in class io.ably.lib.realtime.AblyRealtime.Channels
- 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
- onClientIdSet(String) - Method in class io.ably.lib.rest.AblyBase
-
clientId set by late initialisation
- 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
- 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(ITransport, ProtocolMessage) - Method in class io.ably.lib.transport.ConnectionManager
-
React on message from the transport
- onMessage(Message) - Method in interface io.ably.lib.realtime.ChannelBase.MessageListener
- 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
- opened - Variable in class io.ably.lib.types.Stats.ResourceCount
- 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
P
- 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
-
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, Object) - Constructor for class io.ably.lib.types.Param
- Param(String, String) - Constructor for class io.ably.lib.types.Param
- 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(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
- PATCH - Static variable in class io.ably.lib.http.HttpConstants.Methods
- 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
-
ping API
- plain - Variable in class io.ably.lib.types.Stats.ConnectionTypes
- platform - Variable in class io.ably.lib.rest.AblyBase
- platform - Variable in class io.ably.lib.rest.DeviceDetails
- Platform - Class in io.ably.lib.platform
- Platform() - Constructor for class io.ably.lib.platform.Platform
- port - Variable in class io.ably.lib.http.HttpCore
- port - Variable in class io.ably.lib.transport.ITransport.TransportParams
- port - Variable in class io.ably.lib.types.ClientOptions
-
For development environments only; allows a non-default Ably port to be specified.
- port - Variable in class io.ably.lib.types.ProxyOptions
- PORT - Static variable in class io.ably.lib.transport.Defaults
- 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
- POST - Static variable in class io.ably.lib.http.HttpConstants.Methods
- 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
- presence - io.ably.lib.types.ProtocolMessage.Action
- presence - Variable in class io.ably.lib.realtime.ChannelBase
-
The
Presenceobject for this channel. - presence - Variable in class io.ably.lib.rest.ChannelBase
-
The presence instance for this channel.
- presence - Variable in class io.ably.lib.types.ProtocolMessage
- presence - Variable in class io.ably.lib.types.Stats.MessageTypes
- Presence - Class in io.ably.lib.realtime
-
A class that provides access to presence operations and state for the associated Channel.
- Presence() - Constructor for class io.ably.lib.rest.ChannelBase.Presence
- 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
- present - io.ably.lib.types.PresenceMessage.Action
- previous - Variable in class io.ably.lib.realtime.ChannelStateListener.ChannelStateChange
- 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(int, String, String, Throwable) - Method in interface io.ably.lib.util.Log.LogHandler
- println(PrintStream, int, String, String, Throwable) - Method in class io.ably.lib.util.Log.DefaultHandler
- 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
- properties - Variable in class io.ably.lib.realtime.ChannelBase
-
Properties of Channel
- 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
- 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(Message) - Method in class io.ably.lib.realtime.ChannelBase
-
Publish a message on this channel.
- publish(Message[]) - Method in class io.ably.lib.realtime.ChannelBase
-
Publish an array of messages on this channel.
- publish(Message[]) - Method in class io.ably.lib.rest.ChannelBase
-
Publish an array of messages on this channel.
- publish(Message[], CompletionListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Publish an array of messages on this channel.
- publish(Message, CompletionListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Publish a message on this channel.
- publish(Param[], JsonObject) - Method in class io.ably.lib.push.PushBase.Admin
- publish(String, Object) - Method in class io.ably.lib.realtime.ChannelBase
-
Publish a message on this channel.
- publish(String, Object) - Method in class io.ably.lib.rest.ChannelBase
-
Publish a message on this channel using the REST API.
- publish(String, Object, CompletionListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Publish a message on this channel.
- publishAsync(Message[], CompletionListener) - Method in class io.ably.lib.rest.ChannelBase
-
Asynchronously publish an array of messages on this channel
- publishAsync(Param[], JsonObject, CompletionListener) - Method in class io.ably.lib.push.PushBase.Admin
- publishAsync(String, Object, CompletionListener) - Method in class io.ably.lib.rest.ChannelBase
-
Publish a message on this channel using the REST API.
- publishBatch(Message.Batch[], ChannelOptions) - Method in class io.ably.lib.rest.AblyBase
-
Publish a messages on one or more channels.
- publishBatchAsync(Message.Batch[], ChannelOptions, Callback<PublishResponse[]>) - Method in class io.ably.lib.rest.AblyBase
- PublishResponse - Class in io.ably.lib.types
-
PublishResponse
- PublishResponse() - Constructor for class io.ably.lib.types.PublishResponse
- push - Variable in class io.ably.lib.rest.AblyBase
- push - Variable in class io.ably.lib.rest.DeviceDetails
- 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 - Class in io.ably.lib.push
- Push() - Constructor for class io.ably.lib.rest.DeviceDetails.Push
- Push(AblyBase) - Constructor for class io.ably.lib.push.Push
- PushBase - Class in io.ably.lib.push
- 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
- PushBase.ChannelSubscriptions - Class in io.ably.lib.push
- PushBase.DeviceRegistrations - Class in io.ably.lib.push
- 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(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 - Static variable in class io.ably.lib.http.HttpConstants.Methods
Q
- queryTime - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
This may be set in instances that the library is to sign token requests based on a given key.
- QueuedMessage(ProtocolMessage, CompletionListener) - Constructor for class io.ably.lib.transport.ConnectionManager.QueuedMessage
- queueEvents - Variable in class io.ably.lib.transport.ConnectionManager.State
- queueMessages - Variable in class io.ably.lib.types.ClientOptions
-
If false, suppresses the default queueing of messages when connection states that anticipate imminent connection (connecting and disconnected).
R
- readJson(byte[]) - Static method in class io.ably.lib.types.StatsReader
- readJson(String) - Static method in class io.ably.lib.types.StatsReader
- readJSON(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
- realtime - Variable in class io.ably.lib.types.Stats.MessageTraffic
- realtimeHost - Variable in class io.ably.lib.types.ClientOptions
-
For development environments only; allows a non-default Ably host to be specified for websocket connections.
- realtimeRequestTimeout - Static variable in class io.ably.lib.transport.Defaults
- realtimeRequestTimeout - Variable in class io.ably.lib.types.ClientOptions
-
Spec: DF1b
- reason - Variable in class io.ably.lib.realtime.ChannelBase
-
Error information associated with a failed channel state.
- reason - Variable in class io.ably.lib.realtime.ChannelStateListener.ChannelStateChange
- reason - Variable in class io.ably.lib.realtime.Connection
-
Error information associated with a connection failure.
- reason - Variable in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
- recipient - Variable in class io.ably.lib.rest.DeviceDetails.Push
- recover - io.ably.lib.transport.ITransport.Mode
- recover - Variable in class io.ably.lib.types.ClientOptions
-
A connection recovery string, specified by a client when initialising the library with the intention of inheriting the state of an earlier connection.
- recoveryKey - Variable in class io.ably.lib.realtime.Connection
-
RTN16b) Connection#recoveryKey is an attribute composed of the connection key and latest serial received on the connection
- refused - Variable in class io.ably.lib.types.Stats.RequestCount
- refused - Variable in class io.ably.lib.types.Stats.ResourceCount
- release(String) - Method in class io.ably.lib.realtime.AblyRealtime.Channels
-
Remove this channel from this AblyRealtime instance.
- release(String) - Method in class io.ably.lib.rest.AblyBase.Channels
- remove(PushBase.ChannelSubscription) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
- remove(DeviceDetails) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- remove(String) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- remove(T) - Method in class io.ably.lib.util.Multicaster
- removeAsync(PushBase.ChannelSubscription, CompletionListener) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
- removeAsync(DeviceDetails, CompletionListener) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- removeAsync(String, CompletionListener) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- 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
- removeWhere(Param[]) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- removeWhereAsync(Param[], CompletionListener) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
- removeWhereAsync(Param[], CompletionListener) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- 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
-
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
-
Make a generic HTTP request against an endpoint representing a collection of some type; this is to provide a forward compatibility path for new APIs.
- requestAsync(String, String, Param[], HttpCore.RequestBody, Param[], AsyncHttpPaginatedResponse.Callback) - Method in class io.ably.lib.rest.AblyBase
-
Make an async generic HTTP request against an endpoint representing a collection of some type; this is to provide a forward compatibility path for new APIs.
- 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
-
Make a token request.
- 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
- restHost - Variable in class io.ably.lib.types.ClientOptions
-
For development environments only; allows a non-default Ably host to be specified.
- resume - io.ably.lib.transport.ITransport.Mode
- resumed - io.ably.lib.types.ProtocolMessage.Flag
- resumed - Variable in class io.ably.lib.realtime.ChannelStateListener.ChannelStateChange
- retryIn - Variable in class io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
S
- save(PushBase.ChannelSubscription) - Method in class io.ably.lib.push.PushBase.ChannelSubscriptions
- 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
- saveAsync(DeviceDetails, Callback<DeviceDetails>) - Method in class io.ably.lib.push.PushBase.DeviceRegistrations
- 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) - Method in interface io.ably.lib.transport.ITransport
-
Send a message on the channel
- send(ProtocolMessage) - Method in class io.ably.lib.transport.WebSocketTransport
- send(ProtocolMessage, boolean, CompletionListener) - Method in class io.ably.lib.transport.ConnectionManager
- 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.
- 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(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
- serverId - Variable in class io.ably.lib.types.ConnectionDetails
- 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() - 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
- setHandler(Log.LogHandler) - Static method in class io.ably.lib.util.Log
- setLastActivity(long) - Method in class io.ably.lib.transport.ConnectionManager
- setLevel(int) - Static method in class io.ably.lib.util.Log
- setOptions(ChannelOptions) - Method in class io.ably.lib.realtime.ChannelBase
-
Channel options
- 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 class io.ably.lib.util.Multicaster
- 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
-
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.rest.DeviceDetails.Push
- 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
-
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.AblyBase
-
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.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
- statusLine - Variable in class io.ably.lib.http.HttpCore.Response
- 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
-
Subscribe for messages on this channel.
- subscribe(Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Same as above without completion listener
- subscribe(Presence.PresenceListener, CompletionListener) - 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
-
Same as above without completion listener
- subscribe(PresenceMessage.Action, Presence.PresenceListener, CompletionListener) - Method in class io.ably.lib.realtime.Presence
-
Subscribe to presence events with a specific action on the associated Channel.
- subscribe(String[], ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Subscribe for messages with an array of event names on this channel.
- subscribe(String, ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Subscribe for messages with a specific event name on this channel.
- subscribe(EnumSet<PresenceMessage.Action>, Presence.PresenceListener) - Method in class io.ably.lib.realtime.Presence
-
Same as above without completion listener
- subscribe(EnumSet<PresenceMessage.Action>, Presence.PresenceListener, CompletionListener) - 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
- success - Variable in class io.ably.lib.types.AsyncHttpPaginatedResponse
- success - Variable in class io.ably.lib.types.HttpPaginatedResponse
- suspendAll(ErrorInfo, boolean) - Method in class io.ably.lib.realtime.AblyRealtime.Channels
- suspended - io.ably.lib.realtime.ChannelEvent
- suspended - io.ably.lib.realtime.ChannelState
- suspended - io.ably.lib.realtime.ConnectionEvent
- suspended - io.ably.lib.realtime.ConnectionState
- sync - io.ably.lib.types.ProtocolMessage.Action
- 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
-
(RTP13) Presence#syncComplete returns true if the initial SYNC operation has completed for the members present on the channel
- 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
T
- TAG - Static variable in class io.ably.lib.http.AsyncHttpScheduler
- TAG - Static variable in class io.ably.lib.http.HttpScheduler
- TAG - Static variable in interface io.ably.lib.transport.ITransport
- time() - Method in class io.ably.lib.rest.AblyBase
-
Obtain the time from the Ably service.
- timeAsync(Callback<Long>) - Method in class io.ably.lib.rest.AblyBase
-
Asynchronously obtain the time from the Ably service.
- timeout - Variable in class io.ably.lib.transport.ConnectionManager.State
- TIMEOUT_CHANNEL_RETRY - Static variable in class io.ably.lib.transport.Defaults
- TIMEOUT_CONNECT - Static variable in class io.ably.lib.transport.Defaults
- TIMEOUT_DISCONNECT - Static variable in class io.ably.lib.transport.Defaults
- TIMEOUT_HTTP_OPEN - Static variable in class io.ably.lib.transport.Defaults
- TIMEOUT_HTTP_REQUEST - Static variable in class io.ably.lib.transport.Defaults
- timestamp - Variable in class io.ably.lib.rest.Auth.TokenParams
-
The timestamp (in millis since the epoch) of this request.
- timestamp - Variable in class io.ably.lib.types.BaseMessage
-
The timestamp for this message
- timestamp - Variable in class io.ably.lib.types.ProtocolMessage
- timestamp() - Static method in class io.ably.lib.rest.Auth
- tls - Variable in class io.ably.lib.types.ClientOptions
-
Encrypted transport: if true, TLS will be used for all connections (whether REST/HTTP or Realtime WebSocket or Comet connections).
- tls - Variable in class io.ably.lib.types.Stats.ConnectionTypes
- TLS_PORT - Static variable in class io.ably.lib.transport.Defaults
- tlsPort - Variable in class io.ably.lib.types.ClientOptions
-
For development environments only; allows a non-default Ably TLS port to be specified.
- ToCallback(CompletionListener) - Constructor for class io.ably.lib.realtime.CompletionListener.ToCallback
- toInt() - Method in enum io.ably.lib.rest.DeviceDetails.Push.State
- toIntervalId(long, Stats.Granularity) - Static method in class io.ably.lib.types.Stats
- toJson() - Method in class io.ably.lib.util.JsonUtils.JsonUtilsObject
- toJsonObject() - Method in class io.ably.lib.push.PushBase.ChannelSubscription
- toJsonObject() - Method in class io.ably.lib.rest.DeviceDetails.Push
- toJsonObject() - Method in class io.ably.lib.rest.DeviceDetails
- token - io.ably.lib.rest.Auth.AuthMethod
- token - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
An authentication token issued for this application against a specific key and
Auth.TokenParams - token - Variable in class io.ably.lib.rest.Auth.TokenDetails
-
The token itself
- tokenDetails - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
An authentication token issued for this application against a specific key and
Auth.TokenParams - TokenDetails() - Constructor for class io.ably.lib.rest.Auth.TokenDetails
- TokenDetails(String) - Constructor for class io.ably.lib.rest.Auth.TokenDetails
- TokenParams() - Constructor for class io.ably.lib.rest.Auth.TokenParams
- TokenRequest() - Constructor for class io.ably.lib.rest.Auth.TokenRequest
- TokenRequest(Auth.TokenParams) - Constructor for class io.ably.lib.rest.Auth.TokenRequest
- tokenRequests - Variable in class io.ably.lib.types.Stats
- toParamArray(Map<String, List<String>>) - Static method in class io.ably.lib.http.HttpUtils
- toString() - Method in class io.ably.lib.push.PushBase.ChannelSubscription
- toString() - Method in class io.ably.lib.rest.DeviceDetails
- toString() - Method in class io.ably.lib.transport.WebSocketTransport
- toString() - Method in class io.ably.lib.types.Capability
-
Get the canonicalised String text for a Capability instance.
- toString() - Method in class io.ably.lib.types.ErrorInfo
- toString() - Method in class io.ably.lib.types.Message
-
Generate a String summary of this Message
- toString() - Method in class io.ably.lib.types.Param
- toString() - Method in class io.ably.lib.types.PresenceMessage
-
Generate a String summary of this PresenceMessage
- TRANSPORT - Static variable in class io.ably.lib.transport.Defaults
- transportFactory - Variable in class io.ably.lib.debug.DebugOptions
- transportParams - Variable in class io.ably.lib.types.ClientOptions
-
Additional parameters to be sent in the querystring when initiating a realtime connection
- TransportParams(ClientOptions) - Constructor for class io.ably.lib.transport.ITransport.TransportParams
- ttl - Variable in class io.ably.lib.rest.Auth.TokenParams
-
Requested time to live for the token.
U
- unit - Variable in class io.ably.lib.types.Stats
- unsubscribe() - Method in class io.ably.lib.realtime.ChannelBase
-
Unsubscribe all subscribed listeners from this channel.
- unsubscribe() - Method in class io.ably.lib.realtime.Presence
-
Unsubscribe all subscribed presence lisceners for this channel.
- unsubscribe(ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Unsubscribe a previously subscribed 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(String[], ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Unsubscribe a previously subscribed event listener from this channel.
- unsubscribe(String, ChannelBase.MessageListener) - Method in class io.ably.lib.realtime.ChannelBase
-
Unsubscribe a previously subscribed event listener from this channel.
- 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.
- update - io.ably.lib.realtime.ChannelEvent
- update - io.ably.lib.realtime.ConnectionEvent
- update - io.ably.lib.types.PresenceMessage.Action
- 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.
- urlPattern - Static variable in class io.ably.lib.http.BasePaginatedQuery
- 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.
- username - Variable in class io.ably.lib.types.ProxyOptions
- useTokenAuth - Variable in class io.ably.lib.rest.Auth.AuthOptions
-
TO3j4: Use token authorization even if no clientId
V
- 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.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() - 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() - 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.
W
- w(String, String) - Static method in class io.ably.lib.util.Log
- w(String, String, Throwable) - Static method in class io.ably.lib.util.Log
- w(String, Throwable) - Static method in class io.ably.lib.util.Log
- WARN - Static variable in class io.ably.lib.util.Log
-
Priority constant; use Log.w.
- webhook - Variable in class io.ably.lib.types.Stats.MessageTraffic
- WebSocketTransport - Class in io.ably.lib.transport
- WebSocketTransport(ITransport.TransportParams, ConnectionManager) - Constructor for class io.ably.lib.transport.WebSocketTransport
-
protected constructor
- WebSocketTransport.Factory - Class in io.ably.lib.transport
-
public factory API
- WILDCARD_CLIENTID - Static variable in class io.ably.lib.rest.Auth
- withCipherKey(byte[]) - Static method in class io.ably.lib.types.ChannelOptions
-
Create ChannelOptions with the given cipher key.
- withCipherKey(String) - Static method in class io.ably.lib.types.ChannelOptions
-
Create ChannelOptions with the given cipher key.
- writeJSON(ProtocolMessage) - Static method in class io.ably.lib.types.ProtocolSerializer
-
JSON encode
- writeMsgpack(ProtocolMessage) - Static method in class io.ably.lib.types.ProtocolSerializer
-
Msgpack encode
- writeMsgpack(MessagePacker) - Method in class io.ably.lib.types.Message.Batch
- writeMsgpackArray(Message[]) - Static method in class io.ably.lib.types.MessageSerializer
- writeMsgpackArray(Message[], MessagePacker) - Static method in class io.ably.lib.types.MessageSerializer
- writeMsgpackArray(PresenceMessage[]) - Static method in class io.ably.lib.types.PresenceSerializer
-
Msgpack encode
- writeMsgpackArray(PresenceMessage[], MessagePacker) - Static method in class io.ably.lib.types.PresenceSerializer
- WWW_AUTHENTICATE - Static variable in class io.ably.lib.http.HttpConstants.Headers
X
- X_ABLY_TOKEN - io.ably.lib.http.HttpAuth.Type
All Classes All Packages