A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  R  S  T  U  V  W  X 

F

FAILED - enum entry in io.ably.lib.rest.DeviceDetails.Push.State
 
failed - enum entry in io.ably.lib.realtime.ChannelEvent
 
failed - enum entry in io.ably.lib.realtime.ChannelState

An indefinite failure condition.This state is entered if a channel error has been received from the Ably service,such as an attempt to attach without the necessary access rights.

failed - enum entry in io.ably.lib.realtime.ConnectionEvent
 
failed - enum entry in io.ably.lib.realtime.ConnectionState

This state is entered if the client library encounters a failure condition that it cannot recover from.This may be a fatal connection error received from the Ably service,for example an attempt to connect with an incorrect API key, or a local terminal error,for example the token in use has expired and the library does not have any way to renew it.In the failed state, no reconnection attempts are made automatically by the library, and clients may not publish messages.A new connection attempt can be triggered by an explicit call to connect.

failedRequest(AblyException) - function in io.ably.lib.http.Http
 
FAILING - enum entry in io.ably.lib.rest.DeviceDetails.Push.State
 
fallbackHostsRemaining(String) - function in io.ably.lib.transport.Hosts
 
FCM - enum entry in io.ably.lib.types.RegistrationToken.Type
 
fillInStackTrace() - function in java.lang.MessageDecodeException
 
fillInStackTrace() - function in java.lang.AblyException
 
fillInStackTrace() - function in java.lang.AblyException.HostFailedException
 
fillInStackTrace() - function in java.lang.HttpCore.AuthRequiredException
 
findByValue(int) - function in io.ably.lib.types.ProtocolMessage.Action
 
findByValue(int) - function in io.ably.lib.types.PresenceMessage.Action
 
first() - function in io.ably.lib.types.HttpPaginatedResponse
Perform the given relative query
first(AsyncHttpPaginatedResponse.Callback) - function in io.ably.lib.types.AsyncHttpPaginatedResponse
Obtain params required to perform the given relative query
first() - function in io.ably.lib.types.PaginatedResult
Returns a new PaginatedResult for the first page of results.
first() - function in io.ably.lib.types.BasePaginatedResult
Perform the given relative query
first(Callback) - function in io.ably.lib.types.AsyncPaginatedResult
Returns a new PaginatedResult for the first page of results.
first(AsyncHttpPaginatedResponse.Callback) - function in io.ably.lib.http.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
Obtain params required to perform the given relative query
first(AsyncHttpPaginatedResponse.Callback) - function in io.ably.lib.types.AsyncHttpPaginatedQuery.AsyncHttpPaginatedResult
Obtain params required to perform the given relative query
first() - function in io.ably.lib.http.HttpPaginatedQuery.HttpPaginatedResult
Perform the given relative query
flattenParams(Map) - function in io.ably.lib.http.HttpUtils
 
forClientId(String,String) - function in io.ably.lib.push.PushBase.ChannelSubscription
A static factory method to create a PushChannelSubscription object for a channel and group of devices sharing the same clientId.
forDevice(String,String) - function in io.ably.lib.push.PushBase.ChannelSubscription
A static factory method to create a PushChannelSubscription object for a channel and single device.
fromCipherKey(Array) - function in io.ably.lib.types.ChannelOptions
Deprecated.
fromCipherKey(String) - function in io.ably.lib.types.ChannelOptions
Deprecated.
fromCode(String) - function in io.ably.lib.rest.DeviceDetails.Push.State
 
fromDescription(String) - function in io.ably.lib.types.MessageDecodeException
 
fromEncoded(JsonObject,ChannelOptions) - function in io.ably.lib.types.Message
A static factory method to create a Message object from a deserialized Message-like object encoded using Ably's wire protocol.
fromEncoded(String,ChannelOptions) - function in io.ably.lib.types.Message
A static factory method to create a Message object from a deserialized Message-like object encoded using Ably's wire protocol.
fromEncoded(JsonObject,ChannelOptions) - function in io.ably.lib.types.PresenceMessage
Decodes and decrypts a deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.
fromEncoded(String,ChannelOptions) - function in io.ably.lib.types.PresenceMessage
Decodes and decrypts a deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.
fromEncodedArray(JsonArray,ChannelOptions) - function in io.ably.lib.types.Message
A static factory method to create an array of Message objects from an array of deserializedMessage-like object encoded using Ably's wire protocol.
fromEncodedArray(String,ChannelOptions) - function in io.ably.lib.types.Message
A static factory method to create an array of Message objects from an array of deserializedMessage-like object encoded using Ably's wire protocol.
fromEncodedArray(JsonArray,ChannelOptions) - function in io.ably.lib.types.PresenceMessage
Decodes and decrypts an array of deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.
fromEncodedArray(String,ChannelOptions) - function in io.ably.lib.types.PresenceMessage
Decodes and decrypts an array of deserialized PresenceMessage-like object using the cipher in ChannelOptions.Any residual transforms that cannot be decoded or decrypted will be in the encoding property.Intended for users receiving messages from a source other than a REST or Realtime channel (for example a queue)to avoid having to parse the encoding string.
fromErrorInfo(ErrorInfo) - function in io.ably.lib.types.MessageDecodeException
 
fromErrorInfo(Throwable,ErrorInfo) - function in io.ably.lib.types.MessageDecodeException
 
fromErrorInfo(ErrorInfo) - function in io.ably.lib.types.AblyException
 
fromErrorInfo(Throwable,ErrorInfo) - function in io.ably.lib.types.AblyException
 
fromErrorInfo(ErrorInfo) - function in io.ably.lib.types.AblyException.HostFailedException
 
fromErrorInfo(Throwable,ErrorInfo) - function in io.ably.lib.types.AblyException.HostFailedException
 
fromErrorInfo(ErrorInfo) - function in io.ably.lib.types.HttpCore.AuthRequiredException
 
fromErrorInfo(Throwable,ErrorInfo) - function in io.ably.lib.types.HttpCore.AuthRequiredException
 
fromInt(int) - function in io.ably.lib.rest.DeviceDetails.Push.State
 
fromIntervalId(String) - function in io.ably.lib.types.Stats
 
fromJSON(String) - function in io.ably.lib.types.ErrorResponse
Get an ErrorInfo from a response body with error details
fromJSON(String) - function in io.ably.lib.types.ProtocolSerializer
**************************************JSON decode
fromJSON(JsonObject) - function in io.ably.lib.rest.Auth.TokenDetails
A static factory method to create a TokenDetails object from a deserializedTokenDetails-like object or a JSON stringified TokenDetails object.This method is provided to minimize bugs as a result of differing types by platform for fields such as timestamp or ttl.For example, in Ruby ttl in the TokenDetails object is exposed in seconds as that is idiomatic for the language,yet when serialized to JSON using to_json it is automatically converted to the Ably standard which is milliseconds.By using the fromJson() method when constructing a TokenDetails object,Ably ensures that all fields are consistently serialized and deserialized across platforms.
fromJson(String) - function in io.ably.lib.rest.Auth.TokenDetails
A static factory method to create a TokenDetails object from a deserializedTokenDetails-like object or a JSON stringified TokenDetails object.This method is provided to minimize bugs as a result of differing types by platform for fields such as timestamp or ttl.For example, in Ruby ttl in the TokenDetails object is exposed in seconds as that is idiomatic for the language,yet when serialized to JSON using to_json it is automatically converted to the Ably standard which is milliseconds.By using the fromJson() method when constructing a TokenDetails object,Ably ensures that all fields are consistently serialized and deserialized across platforms.
fromJSON(JsonObject) - function in io.ably.lib.rest.Auth.TokenRequest
A static factory method to create a TokenRequest object from a deserialized TokenRequest-like objector a JSON stringified TokenRequest object.This method is provided to minimize bugs as a result of differing types by platform for fields such as timestamp or ttl.For example, in Ruby ttl in the TokenRequest object is exposed in seconds as that is idiomatic for the language,yet when serialized to JSON using to_json it is automatically converted to the Ably standard which is milliseconds.By using the fromJson() method when constructing a TokenRequest object,Ably ensures that all fields are consistently serialized and deserialized across platforms.
fromJson(String) - function in io.ably.lib.rest.Auth.TokenRequest
A static factory method to create a TokenRequest object from a deserialized TokenRequest-like objector a JSON stringified TokenRequest object.This method is provided to minimize bugs as a result of differing types by platform for fields such as timestamp or ttl.For example, in Ruby ttl in the TokenRequest object is exposed in seconds as that is idiomatic for the language,yet when serialized to JSON using to_json it is automatically converted to the Ably standard which is milliseconds.By using the fromJson() method when constructing a TokenRequest object,Ably ensures that all fields are consistently serialized and deserialized across platforms.
fromJsonElement(JsonObject) - function in io.ably.lib.rest.Auth.TokenDetails
A static factory method to create a TokenDetails object from a deserializedTokenDetails-like object or a JSON stringified TokenDetails object.This method is provided to minimize bugs as a result of differing types by platform for fields such as timestamp or ttl.For example, in Ruby ttl in the TokenDetails object is exposed in seconds as that is idiomatic for the language,yet when serialized to JSON using to_json it is automatically converted to the Ably standard which is milliseconds.By using the fromJson() method when constructing a TokenDetails object,Ably ensures that all fields are consistently serialized and deserialized across platforms.
fromJsonElement(JsonObject) - function in io.ably.lib.rest.Auth.TokenRequest
A static factory method to create a TokenRequest object from a deserialized TokenRequest-like objector a JSON stringified TokenRequest object.This method is provided to minimize bugs as a result of differing types by platform for fields such as timestamp or ttl.For example, in Ruby ttl in the TokenRequest object is exposed in seconds as that is idiomatic for the language,yet when serialized to JSON using to_json it is automatically converted to the Ably standard which is milliseconds.By using the fromJson() method when constructing a TokenRequest object,Ably ensures that all fields are consistently serialized and deserialized across platforms.
fromJsonElement(JsonElement) - function in io.ably.lib.util.Serialisation.FromJsonElement
 
fromJsonObject(JsonObject) - function in io.ably.lib.rest.DeviceDetails
 
fromJsonObject(JsonObject) - function in io.ably.lib.rest.LocalDevice
 
fromJsonObject(JsonObject) - function in io.ably.lib.push.PushBase.ChannelSubscription
 
fromMsgpack(MessageUnpacker) - function in io.ably.lib.types.Annotation
 
fromMsgpackBody(Array) - function in io.ably.lib.types.ErrorInfo
 
fromName(String) - function in io.ably.lib.types.RegistrationToken.Type
 
fromOrdinal(int) - function in io.ably.lib.types.RegistrationToken.Type
 
fromResponseStatus(String,int) - function in io.ably.lib.types.ErrorInfo
 
fromThrowable(Throwable) - function in io.ably.lib.types.ErrorInfo
 
fromThrowable(Throwable) - function in io.ably.lib.types.MessageDecodeException
Get an exception from a throwable occurring locally
fromThrowable(Throwable) - function in io.ably.lib.types.AblyException
Get an exception from a throwable occurring locally
fromThrowable(Throwable) - function in io.ably.lib.types.AblyException.HostFailedException
Get an exception from a throwable occurring locally
fromThrowable(Throwable) - function in io.ably.lib.types.HttpCore.AuthRequiredException
Get an exception from a throwable occurring locally
fromThrowableAndErrorInfo(Throwable,ErrorInfo) - function in io.ably.lib.types.MessageDecodeException
 
A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  R  S  T  U  V  W  X