Type alias ClientToken

ClientToken: {
    baseUrl: string;
    docId: string;
    token?: string;
    url: string;
}

An object containing information needed for the client connect to a document.

This value is expected to be passed from your server to your client. Your server should obtain this value by calling DocumentManager.getClientToken, and then pass it to the client.

Type declaration

  • baseUrl: string

    The base URL for document-level endpoints.

  • docId: string

    A unique identifier for the document that the token connects to.

  • Optional token?: string

    A string that grants the bearer access to the document. By default, the development server does not require a token.

  • url: string

    The bare URL of the WebSocket endpoint to connect to. The doc string will be appended to this.

Settings

Member Visibility

Theme