@univerjs-pro/collaboration-client v0.5.4

Class: abstract CollaborationEntity

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration-entity.ts:24

Each univer document instance would map to an CollaborationEntity to handle collaborated editing events.

Extends

• RxDisposable

Extended by

• DocCollaborationEntity
• SheetCollaborationEntity

Constructors

new CollaborationEntity()

new CollaborationEntity(
   unitID, 
   session, 
   _type, 
   _injector, 
   _compressMutationService, 
   _localeService, 
   _revisionService, 
   _eventService, 
   _logService, 
   _commandService, 
   _permissionService, 
   _singleActiveUnitService?, 
   _localCacheService?): CollaborationEntity

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration-entity.ts:49

Parameters

Returns

CollaborationEntity

Overrides

RxDisposable.constructor

Properties

Accessors

state

Get Signature

get state(): CollaborationState

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration-entity.ts:29

Returns

CollaborationState

Methods

_createHandler()

protected _createHandler(): ICollaborationStateHandler

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration-entity.ts:289

Returns

ICollaborationStateHandler

_init()

protected _init(): Promise<CollaborationState>

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration-entity.ts:99

Returns

Promise<CollaborationState>

_onLocalMutation()

protected _onLocalMutation(command): void

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration-entity.ts:189

Parameters

Returns

void

dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:122

Returns

void

Inherited from

RxDisposable.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

Returns

IDisposable

Inherited from

RxDisposable.disposeWithMe

ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

RxDisposable.ensureNotDisposed

init()

init(): Promise<void>

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration-entity.ts:67

Returns

Promise<void>

onLocalMutation()

onLocalMutation(command): void

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration-entity.ts:90

Parameters

Returns

void

pauseCollaboration()

pauseCollaboration(): IDisposable

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration-entity.ts:81

Pause collaboration on the document. Remote changesets would be inserted to a queue and wait for resuming.

Returns

IDisposable

a disposable which will resume collaboration when called.