Interface CollaborationJoinOptions

Credentials sent in the encrypted WebSocket join payload.

interface CollaborationJoinOptions {
    displayName?: string;
    memberToken?: string;
    reconnect?: boolean;
    reconnectDelayMs?: number;
}

Properties

displayName?: string

Participant display name used for approval requests.

memberToken?: string

Device-specific membership token. It is never appended to the relay URL.

reconnect?: boolean

Rejoin automatically after a connection that completed successfully closes.

reconnectDelayMs?: number

Delay before automatic reconnection. Defaults to 1500 milliseconds.