@univerjs-pro/collaboration v0.5.0-beta.1 • Docs

@univerjs-pro/collaboration

Enumerations

Enumeration	Description
CollaborationEvent	Types of all possible collaboration events.

Classes

Class	Description
CompressMutationService	During transmission, compression is performed for a specific operation,referencing during transport. Before send -> compress -> transmission -> … -> node apply -> decompression -> apply. Before send -> compress -> transmission -> … -> node transform -> decompression -> apply. Before send -> compress -> transmission -> … -> take from server -> decompression -> apply. Before send -> compress -> save to local -> … -> take from local -> decompression -> apply.
DocTransformController	This controller register sheet transform algorithms to the transform service.
RevisionService	This service provide util functions to get revision number of a document or increment the revision number.
SheetTransformController	This controller register sheet transform algorithms to the transform service.
SnapshotService	The service provides methods to load snapshots from the snapshot server.
TransformService	This service’s responsibility is to transform mutations (changesets).
UniverCollaborationPlugin	Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods.

Interfaces

Interface	Description
IAcknowledgedChangeset	Awaiting mutations were acknowledged by the server.
IAcknowledgementEvent	-
IChangeset	-
ICollaborationUser	-
ICreateUnitMutationParams	-
IFailureTransformChangesetsResult	-
IFailureTransformMutationResult	-
IFailureTransformMutationsResult	-
IFailureTransformMutationsWithChangesetResult	-
IFetchingMissEvent	When the collaboration session is created, it should send a handshake event to the server.
IFetchOperationsEvent	-
IHeartbeatRequestEvent	-
IHeartbeatResponseEvent	-
IHelloRequestEvent	-
IHelloResponseEvent	-
IHistoryIoService	-
IIngestQuestEvent	-
IJoinRequestEvent	-
IJoinResponseEvent	-
ILeaveRequestEvent	-
ILogContext	-
IMutationTransformAlgorithm	A single transform algorithm. Algorithms are registered to the transform service in the form of `{m1}-{m2}`. When the transform service is transforming two mutations, it would find the algorithm by the form of `{m1}-{m2}`. `m1` is the mutation on the left side, and `m2` is the mutation on the right side.
INewChangesetsEvent	Receives a changeset from collaboration server.
INewHostEvent	-
IOperationEvent	-
IPermissionUpdateEvent	-
IPseudoFetchMissingResultEvent	-
IRecvResponseEvent	-
IRejectedChangeset	Awaiting mutations were rejected by the server.
IRejectionEvent	-
IRequestHostEvent	-
IRetryEvent	-
IRevertRevisionMutationParams	-
IShouldCloseConnEvent	-
ISnapshotServerService	-
ISubmitChangesetEvent	Send a changeset to the collaboration sever.
ISuccessTransformChangesetsResult	-
ISuccessTransformMutationResult	-
ISuccessTransformMutationsResult	-
ISuccessTransformMutationsWithChangesetResult	-
ITerminateEvent	-
ITransformService	This service’s responsibility is to transform mutations (changesets).
IUpdateCursorEvent	-
IUserJoinEvent	-
IUserLeaveEvent	-
IUserSelectionEvent	-

Type Aliases

Type alias	Description
ICollaborationEvent	A union type of all possible collaboration events.
ICombRequestEvent	-
ICombResponseEvent	-
ITransformChangesetsResult	-
ITransformMutationResult	-
ITransformMutationsResult	-
ITransformMutationsWithChangesetResult	-

Variables

Variable	Description
CreateUnitMutation	This mutation will not create a unit but only be a signal
RevertRevisionMutation	-
SINGLE_HISTORY_MUTATIONS	-
SINGLE_SNAPSHOT_MUTATIONS	Some special mutations. It a changeset contains the following mutations it should create a snapshot immediately.
textDecoder	-
textEncoder	-

Functions

Function	Description
b64DecodeUnicode	-
b64EncodeUnicode	-
generateTempDocumentSnapshot	-
generateTemporarySnap	-
getSheetBlocksFromSnapshot	-
IHistoryIoService	-
ISnapshotServerService	It provides implementations for server side controllers to load or save or load snapshots. This service should be implemented by the host environment. And it shouldn’t contain any business logic.
isTransformChangesetsFailure	-
isTransformChangesetsSuccess	-
isTransformMutationFailure	-
isTransformMutationsFailure	-
isTransformMutationsSuccess	-
isTransformMutationSuccess	-
isTransformMutationsWithChangesetFailure	-
isTransformMutationsWithChangesetSuccess	-
ITransformService	-
makeArray	-
mapDocumentTypeToUniverType	-
parseChangesetToProtocol	-
parseMutationToProtocol	-
parseProtocolChangeset	-
parseProtocolCommand	-
parseProtocolMutation	-
transformDocumentDataToSnapshot	-
transformSnapshotToDocumentData	-
transformSnapshotToWorkbookData	Assemble a snapshot to a workbook.
transformWorkbookDataToSnapshot	-

Watermarkuserinfobaseconfig Compressmutationservice