Interface RealtimePresenceParams

The RealtimePresenceParams interface describes the parameters accepted by the following methods:

Hierarchy

  • RealtimePresenceParams

Properties

clientId connectionId waitForSync

Properties

Optional clientId

clientId?: string

Filters the array of returned presence members by a specific client using its ID.

Optional connectionId

connectionId?: string

Filters the array of returned presence members by a specific connection using its ID.

Optional waitForSync

waitForSync?: boolean

Sets whether to wait for a full presence set synchronization between Ably and the clients on the channel to complete before returning the results. Synchronization begins as soon as the channel is ATTACHED. When set to true the results will be returned as soon as the sync is complete. When set to false the current list of members will be returned without the sync completing. The default is true.

Default Value

true

Settings

Member Visibility

Theme

Generated using TypeDoc