Options
All
  • Public
  • Public/Protected
  • All
Menu

Client options used to create WebCollabClient.

Hierarchy

  • CollabOptions

Index

Properties

baseURL: string

Base URL of the backend API. For example: "https://your-domain-name/prefix/".

Please make sure collaboration server is available under this base URL and CORS restriction is correctly configured.

pdfViewer: any

The PDFViewer instance from Foxit PDF SDK for Web.

A PDFViewer instance is needed to set up the binding between PDFViewer and collaboration client.

Methods

  • The user provider is used to provide user information to collaboration.

    For example, a simple user provider can be defined as the following:

    function userProvider(){
    const userInfo = userApp.login()
    return {
    id: userInfo.id,
    username: userInfo.name,
    token: userInfo.token
    }
    }

    Returns UserInfo

Generated using TypeDoc