The id of the collaboration author.
The name of the collaboration document.
Identifier of the collaboration
This property is used for collaboration access control.
Add the specified members to the collaboration.
A list of users which will be added to the collaboration.
For example
1.When you add members by user id
let members = [
{
id: user_id,
isAllowComment: true
}
]
await collaboration.addMembers(members)
2.When you add members by user email
let members = [
{
email: user_email,
isAllowComment: true
}
]
await collaboration.addMembers(members)
Begin the collaboration session.
An optional fileOptions parameter can be passed in to specify options when opening a PDF file.
For example, in order to open an encrypted PDF file, fileOptions.password is needed.
Options that will be passed along to PDFViewer.openPDFByFile when opening a PDF file.
Refer to PDFViewer.openPDFByFile for more information.
{error:number, pdfDoc: pdfDoc, encryptDict: object}.This error should be properly handled in order to proceed with the collaboration.
For example, when an error = 3, it means a correct password is needed to open the encrypted PDF file. You should prompt the client for a password and call this method again with the provided password.
collaboration.begin().catch(e => {
if(e.error === 3){
const passwordForPDF = await promptForPassword()
await collaboration.begin({
password: passwordForPDF
})
}
})
Create a screenSync session.
The list of member ids of the collaboration which will be invited become follower of the screenSync session, defaults to all members of the collaboration which will be invited become follower of the screenSync session.
When a screenSync session is created,the current user become the leader of the screenSync session, the ScreenSyncEvent.CREATED event is fired for specified member or all members of the collaboration.
End current collaboration session.
Only collaboration owner is allowed to perform this action. The collaboration will no longer be available if succeeded.
Get the specified annotation of the current collaboration session by the annotation ID.
| null>} - The specified annotation information of the current collaboration session.
Get current user of the collaboration.
Get all the members of the collaboration.
Get online members of the collaboration.
Get the permission of the collaboration.
Get a screenSync session by screenSyncId.
The id of the screenSync session.
Get all the screenSync of the collaboration.
Remove all event listeners of the collaboration.
Add event listener to the collaboration.
The event listeners will be called when the corresponding events emitted.
Quit the current collaboration.
The current user will be removed from the member list of this collaboration and the current collaboration session will be ended.
Remove the collaboration members by specified ids.
Set the time interval at which mouse pointer position is sent to the server, in milliseconds.
The default value is 200 milliseconds. It's recommend to set a value greater than 50 milliseconds.
the time interval in milliseconds.
Update members permission of Collaboration.
Update the collaboration permission.
Generated using TypeDoc
Collaboration is used to view and edit PDF documents collaboratively.
In this release, collaborative editings only support annotations, including note, highlight, underline, strikeout, squiggly, square, circle, free text, stamp, caret, ink, line, polygon, polyline, file attachment, PSInk, redact annotations. The redact annotation is constrained to properties updates, the ‘redaction apply’ is not yet supported in the current version.
Basically, a collaboration is retrieved by creating a new collaboration WebCollabClient.createCollaboration or opening an existing collaboration WebCollabClient.getCollaboration.
A collaboration provides methods to perform actions related to collaborative editings, such as: