Collaboration

Follow Collaboration integration to run the official example, connect your application, and verify persistence and authorization. Implementation details and runnable Web/Server examples are maintained at Univer Office.

Create the Unit through an authenticated business API calling Collaboration Service, then load the returned identifier in the browser. Configure HTTP, Session Ticket, and WebSocket entry points together using Quick Start. Persist data with a Database Adapter and enforce read, JOIN, and edit policies through server middleware.

Before using these APIs, verify that your target backend supports PDF Units. A working Sheets collaboration example does not establish PDF support.

Load a collaborative PDF

After creating a PDF unit through the server API or importPdfToUnitIdAsync, load it with the collaboration Facade:

TypeScript
const pdf = await univerAPI.getCollaboration().loadPdfAsync(unitId)if (!pdf) {  throw new Error(`PDF unit not found: ${unitId}`)}console.log(pdf.getId(), pdf.getName())

loadPdfAsync loads the server snapshot, prepares the collaboration session, and returns an FPdf. It returns null when the unit cannot be associated with a PDF.

How is this guide?

© 2026 DreamNum Co., Ltd.