A client that extends the functionality of RestCallbacks and provides additional realtime-specific features.

Hierarchy

Constructors

Properties

An AuthCallbacks object.

A Channels object.

clientId: string

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.

connection: ConnectionCallbacks

A PushCallbacks object.

Callbacks: typeof RealtimeCallbacks

A callback based version of the library

Crypto: Crypto

The cryptographic functions available in the library.

Message: MessageStatic

Static utilities related to messages.

PresenceMessage: PresenceMessageStatic

Static utilities related to presence messages.

Promise: typeof RealtimePromise

A promisified version of the library (use this if you prefer to use Promises or async/await instead of callbacks)

Methods

  • Makes a REST request to a provided path. This is provided as a convenience for developers who wish to use REST API functionality that is either not documented or is not yet included in the public API, without having to directly handle features such as authentication, paging, fallback hosts, MsgPack and JSON support.

    Type Parameters

    • T = any

    Parameters

    • method: string

      The request method to use, such as GET, POST.

    • path: string

      The request path.

    • Optional params: any

      The parameters to include in the URL query of the request. The parameters depend on the endpoint being queried. See the REST API reference for the available parameters of each endpoint.

    • Optional body: any

      The JSON body of the request.

    • Optional headers: any

      Additional HTTP headers to include in the request.

    • Optional callback: StandardCallback<HttpPaginatedResponse<T>>

      A function which, upon success, will be called with the HttpPaginatedResponse response object returned by the HTTP request. This response object will contain an empty or JSON-encodable object. Upon failure, the function will be called with information about the error.

    Returns void

  • Queries the REST /stats API and retrieves your application's usage statistics. Returns a PaginatedResult object, containing an array of Stats objects. See the Stats docs.

    Parameters

    • params: any

      A set of parameters which are used to specify which statistics should be retrieved. This parameter should be a StatsParams object. For reasons of backwards compatibility this parameter will also accept any; this ability will be removed in the next major release of this SDK.

    • callback: paginatedResultCallback<Stats>

      A function which, upon success, will be called with a PaginatedResult object containing an array of Stats objects. Upon failure, the function will be called with information about the error.

    Returns void

  • Queries the REST /stats API and retrieves your application's usage statistics, using the default parameters described in the StatsParams interface. Returns a PaginatedResult object, containing an array of Stats objects. See the Stats docs.

    Parameters

    Returns void

  • Retrieves the time from the Ably service as milliseconds since the Unix epoch. Clients that do not have access to a sufficiently well maintained time source and wish to issue Ably TokenRequests with a more accurate timestamp should use the queryTime property instead of this method.

    Parameters

    • Optional callback: timeCallback

      A function which, upon success, will be called with the time as milliseconds since the Unix epoch. Upon failure, the function will be called with information about the error.

    Returns void

Generated using TypeDoc