Construct a client object using an Ably ClientOptions object.
A ClientOptions object to configure the client connection to Ably.
Constructs a client object using an Ably API key or token string.
The Ably API key or token string used to validate the client.
A client ID, used for identifying this client when publishing messages or for presence purposes. The clientId can be any non-empty string, except it cannot contain a *. This option is primarily intended to be used in situations where the library is instantiated with a key. A clientId may also be implicit in a token used to instantiate the library; an error will be raised if a clientId specified here conflicts with the clientId implicit in the token.
Static Callbacks
A callback based version of the library
Static Crypto
The cryptographic functions available in the library.
Static Message
Static utilities related to messages.
Static PresenceStatic utilities related to presence messages.
Static Promise
A promisified version of the library (use this if you prefer to use Promises or async/await instead of callbacks)
Calls connection.close() and causes the connection to close, entering the closing state. Once closed, the library will not attempt to re-establish the connection without an explicit call to connect().
Calls connection.connect() and causes the connection to open, entering the connecting state. Explicitly calling connect() is unnecessary unless the autoConnect property is disabled.
Generated using TypeDoc
A base class used internally for Realtime APIs.