Constructor options for the Collaboration Client
The HTTP URL of the server. This URL is logged when the server is started
The WS URL of the server. This URL is logged when the server is started
The instance of WebViewer returned from the WebViewer constructor
A NotificationFunction to handle client side notifications
Determines the level of logging on the client
Filters client side logs by a certain tag
Custom Winston transports used for logging
If true, the client will track users that are connected to the document, including the page they are looking at
The maximum allowed size of annotations, in bytes
This function can be used to prevent annotation changed from being synced to the database.
Triggered any time a user adds, edits, or deletes an annotation.
Return true from this function if the change can be synced to the database and other users. Return false if the change can not be synced and should only exist client side for the current user.
Custom headers to be sent with requests to the server. Should not be used unless you are using a custom server.
Headers can also be set via Client.setCustomHeaders().
Set this flag to enable document manipulation capabilities.
Please note that WebViewer Collaboration does not currently support syncing of document manipulations, so setting this flag could be dangerous.
Settings for creating a document
The name of the document
The document itself. Can be a string URL, a Blob, a File, or an instance of CoreControls.Document
The ID you want to assign to the document. If not provided, an ID will be generated for you.
Sets whether the document is public or not. When a document is public, it means that anyone can view/join it.
WebViewer options to forward to WebViewers "createDocument" API.
How many items to fetch per query
Order data by either "createdAt" or "updatedAt". Defaults to "createdAt"
Which direction to order - either "ASC" or "DESC". Defaults to "DESC"
Only fetch items before a certain time. Can be used for pagination
An instance of [[Document]] that the user was invited to
The username or email of the user who sent the invite
A callback function that handles client side notification events
This function accepts data about a certain event, and can be used to trigger notifications as you wish.
See defaultNotificationHandler for details on using the default notification handler
A function that unsubscribes from the event you subscribed to. Returned from the "subscribe" function.
A default function that handles browser notifications. This function asks the user permission to send notifications, and triggers notifications whenever a user receives a new message or invite.
This function is available as a static on CollabClient
Configuration options for the handler
Generated using TypeDoc