Interface Presence

Enables the retrieval of the current and historic presence set for a channel.

Hierarchy

  • Presence

Methods

Methods

  • Retrieves a PaginatedResult object, containing an array of historical PresenceMessage objects for the channel. If the channel is configured to persist messages, then presence messages can be retrieved from history for up to 72 hours in the past. If not, presence messages can only be retrieved from history for up to two minutes in the past.

    Parameters

    • Optional params: RestHistoryParams

      A set of parameters which are used to specify which messages should be retrieved.

    Returns Promise<PaginatedResult<PresenceMessage>>

    A promise which, upon success, will be fulfilled with a PaginatedResult object containing an array of PresenceMessage objects. Upon failure, the promise will be rejected with an ErrorInfo object which explains the error.

Generated using TypeDoc