Retrieves the current members present on the channel and the metadata for each member, such as their PresenceAction and ID. Returns a PaginatedResult object, containing an array of PresenceMessage objects.
Optional params: RestPresenceParams
A set of parameters which are used to specify which presence members should be retrieved.
Optional callback: paginatedResultCallback<PresenceMessage>
A function which, upon success, will be called with a PaginatedResult object containing an array of PresenceMessage objects. Upon failure, the function will be called with information about the error.
Retrieves the current members present on the channel and the metadata for each member, such as their [PresenceAction]PresenceAction and ID.
Optional callback: paginatedResultCallback<PresenceMessage>
A function which, upon success, will be called with a [PaginatedResult]PaginatedResult object, containing an array of [PresenceMessage]PresenceMessage objects. Upon failure, the function will be called with information about the error.
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.
A set of parameters which are used to specify which messages should be retrieved.
Optional callback: paginatedResultCallback<PresenceMessage>
A function which, upon success, will be called with a PaginatedResult object containing an array of PresenceMessage objects. Upon failure, the function will be called with information about the error.
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.
A function which, upon success, will be called with a PaginatedResult object containing an array of PresenceMessage objects. Upon failure, the function will be called with information about the error.
Generated using TypeDoc
Enables the retrieval of the current and historic presence set for a channel.