@univerjs-pro/collaboration-client v0.5.4

Class: CollaborationSession

Defined in: packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:37

The data structure to represent a collaboration session. It also manages the collaborator’s identity.

An collaboration session maps to a unit.

Extends

• RxDisposable

Implements

• IDisposable

Constructors

new CollaborationSession()

new CollaborationSession(
   _unitID, 
   socket$, 
   _logService, 
   _configService, 
   _localeService, 
   _memberService, 
   _commentService, 
   _collaborationUIEventService, 
   _telemetryService?): CollaborationSession

Defined in: packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:51

Parameters

Returns

CollaborationSession

Overrides

RxDisposable.constructor

Properties

Accessors

sessionStatus

Get Signature

get sessionStatus(): SessionStatus

Defined in: packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:40

Returns

SessionStatus

Methods

close()

close(): void

Defined in: packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:111

Returns

void

dispose()

dispose(): void

Defined in: packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:105

Returns

void

Implementation of

IDisposable.dispose

Overrides

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

getMemberID()

getMemberID(): null | string

Defined in: packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:101

Returns

null | string

send()

send(event, unitID): Promise<void>

Defined in: packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:213

Send event to the collaboration server.

Parameters

Returns

Promise<void>