@ably/chat - v0.10.0
    Preparing search index...

    Interface RealtimePresenceParams

    The RealtimePresenceParams interface describes the parameters accepted by RealtimePresence.get.

    interface RealtimePresenceParams {
        clientId?: string;
        connectionId?: string;
        waitForSync?: boolean;
    }
    Index

    Properties

    clientId? connectionId? waitForSync?

    Properties

    clientId?: string

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

    connectionId?: string

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

    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 ChannelStates.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.

    true

    Settings

    Member Visibility

    On This Page

    Properties