pdfrx_web
    Preparing search index...

    Interface CollaborationWebSocket

    Minimal browser WebSocket surface used by PageCollaborationClient.

    interface CollaborationWebSocket {
        readyState: number;
        addEventListener(
            type: "open" | "close" | "error" | "message",
            listener: (event: Event | MessageEvent<any>) => void,
        ): void;
        close(): void;
        send(data: string): void;
    }
    Index
    readyState: number

    Native WebSocket ready-state value.

    • Registers a browser-compatible socket event listener.

      Parameters

      • type: "open" | "close" | "error" | "message"

        The type value ( or or or ).

      • listener: (event: Event | MessageEvent<any>) => void

        The callback to invoke when the value changes.

      Returns void

    • Sends one serialized relay message.

      Parameters

      • data: string

        The input data.

      Returns void