Class: FCollaboration

The Facade API object for the Collaboration module. It provides methods to interact with the Univer Collaboration backend server, such as loading Univer Sheets and subscribing to collaborators.

Extends

• FBase

Methods

loadActiveSheet()

loadActiveSheet(): Promise<FWorkbook>;

Returns

Promise<FWorkbook>

The FWorkbook or null if the active Univer Sheet cannot be loaded.

Deprecated

Use loadActiveSheetAsync instead.

loadActiveSheetAsync()

loadActiveSheetAsync(): Promise<FWorkbook>;

Load the active Univer Sheet. It should be associated with the Uniscript Node.js Runtime.

Returns

Promise<FWorkbook>

The FWorkbook or null if the active Univer Sheet cannot be loaded.

Throws

If the method is not overridden.

Example

const collaboration = univerAPI.getCollaboration();
const workbook = await collaboration.loadActiveSheetAsync();

loadSheet()

loadSheet(unitId): Promise<FWorkbook>;

Parameters

Returns

Promise<FWorkbook>

The FWorkbook or null if the Univer Sheet cannot be loaded.

Deprecated

Use loadSheetAsync instead.

loadSheetAsync()

loadSheetAsync(unitId, context?): Promise<FWorkbook>;

Load a Univer Sheet from the server with a unit ID.

Parameters

Returns

Promise<FWorkbook>

The FWorkbook or null if ID cannot be associated with a Univer Sheet.

Example

const collaboration = univerAPI.getCollaboration();
const workbook = await collaboration.loadSheetAsync('your-unit-id');

subscribeCollaborators()

subscribeCollaborators(unitId, callback): IDisposable;

Subscribe collaborators of a Univer file.

Parameters

Returns

IDisposable

A handler to dispose the subscription.

Example

const collaboration = univerAPI.getCollaboration();
collaboration.subscribeCollaborators('your-unit-id', (members) => {
   console.log(members);
});