Javascript: DocumentEditorSettings.webSocketProtocols Property

Description

Optional. An array of additional WebSocket sub-protocols to be passed to the WebSocket constructor. Can be used in order to pass authentication tokens, for example.

Syntax

<string[]> DocumentEditorSettings.webSocketProtocols

Examples

The following example demonstrates DocumentEditorSettings.webSocketProtocols in a practical document-editing workflow. Optional. An array of additional WebSocket sub-protocols to be passed to the WebSocket constructor. Can be used in order to pass authentication tokens, for example.

function inspectWebSocketProtocols(documentEditorSettings) {
    const webSocketProtocols = documentEditorSettings.webSocketProtocols;
    console.log("web socket protocols:", webSocketProtocols);
}