类: 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.

方法

loadActiveSheet()

loadActiveSheet(): Promise<FWorkbook>;

返回

Promise<FWorkbook>

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

已被弃用

Use loadActiveSheetAsync instead.

loadActiveSheetAsync()

loadActiveSheetAsync(): Promise<FWorkbook>;

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

返回

Promise<FWorkbook>

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

抛出

If the method is not overridden.

示例

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

loadSheet()

loadSheet(unitId): Promise<FWorkbook>;

参数

返回

Promise<FWorkbook>

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

已被弃用

Use loadSheetAsync instead.

loadSheetAsync()

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

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

参数

返回

Promise<FWorkbook>

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

示例

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

subscribeCollaborators()

subscribeCollaborators(unitId, callback): IDisposable;

Subscribe collaborators of a Univer file.

参数

返回

IDisposable

A handler to dispose the subscription.

示例

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