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

Class: CollaborationSession

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, 
   _beforeCloseService, 
   _messageService, 
   _configService, 
   _localeService, 
   _memberService, 
   _commentService, 
   _telemetryService?): CollaborationSession

Parameters

Parameter	Type
`_unitID`	`string`
`socket$`	`Observable`<`Nullable`<`ICollaborationSocket`>>
`_logService`	`ILogService`
`_beforeCloseService`	`IBeforeCloseService`
`_messageService`	`IMessageService`
`_configService`	`IConfigService`
`_localeService`	`LocaleService`
`_memberService`	`MemberService`
`_commentService`	`CommentService`
`_telemetryService`?	`ITelemetryService`

Returns

CollaborationSession

Overrides

RxDisposable.constructor

Defined in

packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:44

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`RxDisposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:93
`dispose$`	`protected`	`Subject`<`void`>	`undefined`	`RxDisposable`.`dispose$`	submodules/univer/packages/core/src/shared/lifecycle.ts:117
`event$`	`readonly`	`Observable`<`ICollaborationEvent`>	`undefined`	-	packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:38
`sessionStatus$`	`readonly`	`Observable`<`SessionStatus`>	`undefined`	-	packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:32

Accessors

sessionStatus

Get Signature

get sessionStatus(): SessionStatus

Returns

SessionStatus

Defined in

packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:33

Methods

close()

close(): void

Returns

void

Defined in

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

dispose()

dispose(): void

Returns

void

Implementation of

IDisposable.dispose

Overrides

RxDisposable.dispose

Defined in

packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:99

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

RxDisposable.disposeWithMe

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:96

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

RxDisposable.ensureNotDisposed

Defined in

submodules/univer/packages/core/src/shared/lifecycle.ts:100

getMemberID()

getMemberID(): null | string

Returns

null | string

Defined in

packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:95

send()

send(event, unitID): Promise<void>

Send event to the collaboration server.

Parameters

Parameter	Type
`event`	`ICollaborationEvent`
`unitID`	`string`

Returns

Promise<void>

Defined in

packages/collaboration-client/src/services/collaboration-session/collaboration-session.ts:212

Collaborationentity Collaborationsessionservice