Interface PresenceOptions

Represents the presence options for a chat room.

interface PresenceOptions {
    enter?: boolean;
    subscribe?: boolean;
}

Properties

Properties

enter?: boolean

Whether the underlying Realtime channel should use the presence enter mode, allowing entry into presence. This property does not affect the presence lifecycle, and users must still call Presence.enter in order to enter presence.

true
subscribe?: boolean

Whether the underlying Realtime channel should use the presence subscribe mode, allowing subscription to presence. This property does not affect the presence lifecycle, and users must still call Presence.subscribe in order to subscribe to presence.

true