A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
R
S
T
U
V
W
X
C
- c14n(String) - function in io.ably.lib.types.Capability
- Convenience method to canonicalise a JSON capability expression.
- Callback - class in io.ably.lib.types
- An interface allowing a client to be notified of the outcome of an asynchronous operation.
- Callback.Map - class in io.ably.lib.types.Callback
- Capability - class in io.ably.lib.types
- A class representing an Ably Capability, providing convenience methods to simplify creation of token requests
- Channel - class in io.ably.lib.rest
- Channel - class in io.ably.lib.realtime
- Channel.MessageListener - class in io.ably.lib.realtime.Channel
- An interface whereby a client maybe notified of messages changes on a channel.
- ChannelBase - class in io.ably.lib.rest
- A class representing a Channel in the Ably REST API.
- ChannelBase - class in io.ably.lib.realtime
- Enables messages to be published and subscribed to.
- ChannelBase.MessageListener - class in io.ably.lib.realtime.ChannelBase
- An interface whereby a client maybe notified of message on a channel.
- ChannelBase.Presence - class in io.ably.lib.rest.ChannelBase
- Enables the retrieval of the current and historic presence set for a channel.
- ChannelEvent - class in io.ably.lib.realtime
- Describes the events emitted by a Channel object.
- ChannelMode - class in io.ably.lib.types
- Describes the possible flags used to configure client capabilities, using ChannelOptions.
- ChannelOptions - class in io.ably.lib.types
- Passes additional properties to a io.ably.lib.rest.Channel or io.ably.lib.realtime.Channel object, such as encryption, ChannelMode and channel parameters.
- ChannelProperties - class in io.ably.lib.types
- Describes the properties of the channel state.
- ChannelState - class in io.ably.lib.realtime
- Describes the possible states of a Channel object.
- ChannelStateListener - class 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.ChannelStateListener
- Contains state change information emitted by Channel objects.
- ChannelStateListener.Filter - class in io.ably.lib.realtime.ChannelStateListener
- ChannelStateListener.Multicaster - class in io.ably.lib.realtime.ChannelStateListener
- checkCipherParams(Object) - function in io.ably.lib.util.Crypto
- Internal; if `cipherParams` is null returns default params otherwise check if params valid and returns them
- checkClientId(BaseMessage,boolean,boolean) - function in io.ably.lib.rest.Auth
- Verify that a message, possibly containing a clientId,is compatible with Auth.
- clean - enum entry in io.ably.lib.transport.ITransport.Mode
- clear() - function in io.ably.lib.util.CompletionListener.Multicaster
- clear() - function in io.ably.lib.util.ConnectionStateListener.Multicaster
- clear() - function in io.ably.lib.util.ChannelStateListener.Multicaster
- clear(Array) - function in io.ably.lib.push.SharedPreferenceStorage
- Removes keys from storage
- clear(Array) - function in io.ably.lib.push.Storage
- Removes keys from storage
- clear() - function in io.ably.lib.util.Multicaster
- clearAuthOptions() - function in io.ably.lib.types.ClientOptions
- Internal methodclears all auth options
- clearAuthOptions() - function in io.ably.lib.types.DebugOptions
- Internal methodclears all auth options
- clearCachedServerTime() - function in io.ably.lib.rest.Auth
- For testing purposes we need method to clear cached timeDelta
- ClientOptions - class in io.ably.lib.types
- Passes additional client-specific properties to the io.ably.lib.rest.AblyRest or the io.ably.lib.realtime.AblyRealtime.
- ClientOptionsUtils - class in io.ably.lib.util
- clone() - function in io.ably.lib.types.PresenceMessage
- close - enum entry in io.ably.lib.types.ProtocolMessage.Action
- close() - function in io.ably.lib.rest.AblyRest
- Causes the connection to close, entering the [closing state.
- close() - function in java.lang.AblyRest
- close() - function in io.ably.lib.rest.AblyBase
- Causes the connection to close, entering the [closing state.
- close() - function in java.lang.AblyBase
- close() - function in io.ably.lib.realtime.AblyRealtime
- Calls close and causes the connection to close, entering the closing state.
- close() - function in java.lang.AblyRealtime
- close() - function in io.ably.lib.realtime.Connection
- Causes the connection to close, entering the closing state.
- close() - function in io.ably.lib.util.CurrentThreadExecutor
- close() - function in java.lang.CurrentThreadExecutor
- close() - function in io.ably.lib.transport.WebSocketTransport
- Close this transport.
- close() - function in io.ably.lib.transport.ITransport
- Close this transport.
- close() - function in io.ably.lib.transport.ConnectionManager
- close() - function in io.ably.lib.http.HttpScheduler
- close() - function in java.lang.HttpScheduler
- close() - function in java.lang.CloseableExecutor
- close() - function in io.ably.lib.http.AsyncHttpScheduler
- close() - function in java.lang.AsyncHttpScheduler
- close() - function in io.ably.lib.http.Http
- close() - function in java.lang.Http
- close() - function in io.ably.lib.http.SyncHttpScheduler
- close() - function in java.lang.SyncHttpScheduler
- CloseableExecutor - class in io.ably.lib.http
- closed - enum entry in io.ably.lib.types.ProtocolMessage.Action
- closed - enum entry in io.ably.lib.realtime.ConnectionEvent
- closed - enum entry in io.ably.lib.realtime.ConnectionState
The connection has been explicitly closed by the client.In the closed state, no reconnection attempts are made automatically by the library, and clients may not publish messages.No connection state is preserved by the service or by the library.A new connection attempt can be triggered by an explicit call to connect, which results in a new connection.
- closing - enum entry in io.ably.lib.realtime.ConnectionEvent
- closing - enum entry in io.ably.lib.realtime.ConnectionState
An explicit request by the developer to close the connection has been sent to the Ably service.If a reply is not received from Ably within a short period of time,the connection is forcibly terminated and the connection state becomes CLOSED.
- CollectionUtils - class in io.ably.lib.util
- CompletionListener - class 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
- CompletionListener.Multicaster - class in io.ably.lib.realtime.CompletionListener
- A Multicaster instance is used in the Ably library to manage a listof client listeners against certain operations.
- CompletionListener.ToCallback - class in io.ably.lib.realtime.CompletionListener
- connect - enum entry in io.ably.lib.types.ProtocolMessage.Action
- connect() - function in io.ably.lib.realtime.AblyRealtime
- Calls connect and causes the connection to open,entering the connecting state.
- connect() - function in io.ably.lib.realtime.Connection
- Explicitly calling connect() is unnecessary unless the autoConnect attribute of the io.ably.lib.types.ClientOptions object is false.
- connect(ITransport.ConnectListener) - function in io.ably.lib.transport.WebSocketTransport
- Connect is called once when we create transport;after transport is closed, we never call `connect` again
- connect(ITransport.ConnectListener) - function in io.ably.lib.transport.ITransport
- Initiate a connection attempt; the transport will be activated,and attempt to remain connected, until disconnect() is called.
- connect() - function in io.ably.lib.transport.ConnectionManager
- connect() - function in io.ably.lib.http.AsyncHttpScheduler
- connect() - function in io.ably.lib.http.Http
- connected - enum entry in io.ably.lib.types.ProtocolMessage.Action
- connected - enum entry in io.ably.lib.realtime.ConnectionEvent
- connected - enum entry in io.ably.lib.realtime.ConnectionState
A connection exists and is active.
- connecting - enum entry in io.ably.lib.realtime.ConnectionEvent
- connecting - enum entry in io.ably.lib.realtime.ConnectionState
A connection attempt has been initiated.The connecting state is entered as soon as the library has completed initialization,and is reentered each time connection is re-attempted following disconnection.
- Connection - class in io.ably.lib.realtime
- Enables the management of a connection to Ably.
- ConnectionDetails - class in io.ably.lib.types
- Contains any constraints a client should adhere to and provides additional metadata about a io.ably.lib.realtime.Connection, such as if a request to publish a message that exceeds the maximum message size should be rejected immediately without communicating with Ably.
- ConnectionEvent - class in io.ably.lib.realtime
- Describes the events emitted by a Connection object.
- ConnectionManager - class in io.ably.lib.transport
- *********************Actions
- ConnectionManager.Channels - class in io.ably.lib.transport.ConnectionManager
- Methods on the channels map owned by the AblyRealtime instancewhich the ConnectionManager needs access to.
- ConnectionManager.QueuedMessage - class in io.ably.lib.transport.ConnectionManager
- ****************event queueing
- ConnectionManager.State - class in io.ably.lib.transport.ConnectionManager
- ***********************************a class encapsulating state machineinformation for a given state
- ConnectionManager.StateIndication - class in io.ably.lib.transport.ConnectionManager
- *********************************a class encapsulating informationassociated with a currentState changerequest or notification
- ConnectionState - class in io.ably.lib.realtime
- Describes the realtime Connection object states.
- ConnectionStateListener - class in io.ably.lib.realtime
- An interface whereby a client may be notified of state changes for a connection.
- ConnectionStateListener.ConnectionStateChange - class in io.ably.lib.realtime.ConnectionStateListener
- Contains ConnectionState change information emitted by the Connection object.
- ConnectionStateListener.Filter - class in io.ably.lib.realtime.ConnectionStateListener
- ConnectionStateListener.Multicaster - class in io.ably.lib.realtime.ConnectionStateListener
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.CalledActivate
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.CalledDeactivate
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.GotPushDeviceDetails
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.GotDeviceRegistration
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.GettingDeviceRegistrationFailed
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.GettingPushDeviceDetailsFailed
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.RegistrationSynced
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.SyncRegistrationFailed
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.Deregistered
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.DeregistrationFailed
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.Event
- constructEventByName(String) - function in io.ably.lib.push.ActivationStateMachine.ErrorEvent
- constructStateByName(String,ActivationStateMachine) - function in io.ably.lib.push.ActivationStateMachine.NotActivated
- constructStateByName(String,ActivationStateMachine) - function in io.ably.lib.push.ActivationStateMachine.WaitingForPushDeviceDetails
- constructStateByName(String,ActivationStateMachine) - function in io.ably.lib.push.ActivationStateMachine.WaitingForNewPushDeviceDetails
- constructStateByName(String,ActivationStateMachine) - function in io.ably.lib.push.ActivationStateMachine.AfterRegistrationSyncFailed
- containsKey(Object) - function in io.ably.lib.types.ReadOnlyMap
- containsKey(Array,String) - function in io.ably.lib.types.Param
- containsKey(Object) - function in io.ably.lib.types.AblyBase.Channels
- containsKey(Object) - function in io.ably.lib.types.AblyRealtime.Channels
- containsKey(Object) - function in io.ably.lib.util.InternalMap
- containsKey(Object) - function in io.ably.lib.types.InternalMap
- containsValue(Object) - function in io.ably.lib.types.ReadOnlyMap
- containsValue(Object) - function in io.ably.lib.types.AblyBase.Channels
- containsValue(Object) - function in io.ably.lib.types.AblyRealtime.Channels
- containsValue(Object) - function in io.ably.lib.util.InternalMap
- containsValue(Object) - function in io.ably.lib.types.InternalMap
- convertToProxyConfig(ClientOptions) - function in io.ably.lib.util.ClientOptionsUtils
- copy() - function in io.ably.lib.types.ClientOptions
- Internal method
- copy(Map) - function in io.ably.lib.util.CollectionUtils
- Creates a shallow copy.
- copy() - function in io.ably.lib.debug.DebugOptions
- Internal method
- copy() - function in io.ably.lib.types.DebugOptions
- Internal method
- create(Map,PlatformAgentProvider) - function in io.ably.lib.util.AgentHeaderCreator
- createChannelDecipher(Crypto.CipherParams) - function in io.ably.lib.util.Crypto
- Internal; get a decrypting cipher instance based on the given channel options.
- createChannelEncipher(Crypto.CipherParams) - function in io.ably.lib.util.Crypto
- Internal; get an encrypting cipher instance based on the given channel options.
- createCounter() - function in io.ably.lib.objects.RealtimeObjects
- Creates a new LiveCounter with an initial value of 0.Send a COUNTER_CREATE operation to the realtime system to create a new counter object in the pool.Once the ACK message is received, the method returns the object from the local pool if it got created due tothe echoed COUNTER_CREATE operation, or if it wasn't received yet, the method creates a new object locallyusing the provided data and returns it.
- createCounter(Number) - function in io.ably.lib.objects.RealtimeObjects
- Creates a new LiveCounter with an initial value.Send a COUNTER_CREATE operation to the realtime system to create a new counter object in the pool.Once the ACK message is received, the method returns the object from the local pool if it got created due tothe echoed COUNTER_CREATE operation, or if it wasn't received yet, the method creates a new object locallyusing the provided data and returns it.
- createCounterAsync(ObjectsCallback) - function in io.ably.lib.objects.RealtimeObjects
- Asynchronously creates a new LiveCounter with an initial value of 0.Send a COUNTER_CREATE operation to the realtime system to create a new counter object in the pool.Once the ACK message is received, the method returns the object from the local pool if it got created due tothe echoed COUNTER_CREATE operation, or if it wasn't received yet, the method creates a new object locallyusing the provided data and returns it.
- createCounterAsync(Number,ObjectsCallback) - function in io.ably.lib.objects.RealtimeObjects
- Asynchronously creates a new LiveCounter with an initial value.Send a COUNTER_CREATE operation to the realtime system to create a new counter object in the pool.Once the ACK message is received, the method returns the object from the local pool if it got created due tothe echoed COUNTER_CREATE operation, or if it wasn't received yet, the method creates a new object locallyusing the provided data and returns it.
- createMap() - function in io.ably.lib.objects.RealtimeObjects
- Creates a new empty LiveMap with no entries.Send a MAP_CREATE operation to the realtime system to create a new map object in the pool.Once the ACK message is received, the method returns the object from the local pool if it got created due tothe echoed MAP_CREATE operation, or if it wasn't received yet, the method creates a new object locallyand returns it.
- createMap(Map) - function in io.ably.lib.objects.RealtimeObjects
- Creates a new LiveMap with type-safe entries that can be Boolean, Binary, Number, String, JsonArray, JsonObject, LiveCounter, or LiveMap.
- createMapAsync(ObjectsCallback) - function in io.ably.lib.objects.RealtimeObjects
- Asynchronously creates a new empty LiveMap with no entries.Send a MAP_CREATE operation to the realtime system to create a new map object in the pool.Once the ACK message is received, the method returns the object from the local pool if it got created due tothe echoed MAP_CREATE operation, or if it wasn't received yet, the method creates a new object locallyand returns it.
- createMapAsync(Map,ObjectsCallback) - function in io.ably.lib.objects.RealtimeObjects
- Asynchronously creates a new LiveMap with type-safe entries that can be Boolean, Binary, Number, String, JsonArray, JsonObject, LiveCounter, or LiveMap.
- createPlatformAgent() - function in io.ably.lib.util.AndroidPlatformAgentProvider
- Creates the platform agent for agent header AgentHeaderCreator.
- createPlatformAgent() - function in io.ably.lib.util.PlatformAgentProvider
- Creates the platform agent for agent header AgentHeaderCreator.
- createRecoveryKey() - function in io.ably.lib.realtime.Connection
- createRecoveryKey is a method that returns a json string which incorporates the @connectionKey@, thecurrent @msgSerial@, and a collection of pairs of channel @name@ and current @channelSerial@ for everycurrently attached channel.
- createSocket() - function in io.ably.lib.transport.SafeSSLSocketFactory
- createSocket(Socket,String,int,boolean) - function in io.ably.lib.transport.SafeSSLSocketFactory
- createSocket(String,int) - function in io.ably.lib.transport.SafeSSLSocketFactory
- createSocket(String,int,InetAddress,int) - function in io.ably.lib.transport.SafeSSLSocketFactory
- createSocket(InetAddress,int) - function in io.ably.lib.transport.SafeSSLSocketFactory
- createSocket(InetAddress,int,InetAddress,int) - function in io.ably.lib.transport.SafeSSLSocketFactory
- createSocket(Socket,String,int,boolean) - function in javax.net.ssl.SafeSSLSocketFactory
- createTokenRequest(Auth.TokenParams,Auth.AuthOptions) - function in io.ably.lib.rest.Auth
- Creates and signs an Ably TokenRequest based on the specified(or if none specified, the client library stored) TokenParams and AuthOptions.Note this can only be used when the API key value is available locally.
- createUpdateEvent(ErrorInfo) - function in io.ably.lib.realtime.ConnectionStateListener.ConnectionStateChange
- Crypto - class in io.ably.lib.util
- Contains the properties required to configure the encryption of io.ably.lib.types.Message payloads.
- Crypto.CipherParams - class in io.ably.lib.util.Crypto
- Sets the properties to configure encryption for a io.ably.lib.rest.Channel or io.ably.lib.realtime.Channel object.
- Crypto.DecryptingChannelCipher - class in io.ably.lib.util.Crypto
- Internal; a cipher used to decrypt plaintext from ciphertext, for a channel.
- Crypto.EncryptingChannelCipher - class in io.ably.lib.util.Crypto
- Internal; a cipher used to encrypt plaintext to ciphertext, for a channel.
- current() - function in io.ably.lib.types.HttpPaginatedResponse
- current(AsyncHttpPaginatedResponse.Callback) - function in io.ably.lib.types.AsyncHttpPaginatedResponse
- current() - function in io.ably.lib.types.PaginatedResult
- Returns a new PaginatedResult for the current page of results.
- current() - function in io.ably.lib.types.BasePaginatedResult
- current(Callback) - function in io.ably.lib.types.AsyncPaginatedResult
- Returns a new PaginatedResult for the current page of results.
- current(AsyncHttpPaginatedResponse.Callback) - function in io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
- current(AsyncHttpPaginatedResponse.Callback) - function in io.ably.lib.types.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
- current() - function in io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
- CurrentThreadExecutor - class in io.ably.lib.util