@univerjs-pro/collaboration-client v0.5.4

Class: CollaborationSessionService

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

This service provide collaboration sessions to univer instances. A collaboration session may be used by different controllers of different features.

Extends

Disposable

Constructors

new CollaborationSessionService()

new CollaborationSessionService(
   _injector, 
   _logService, 
   _configService, 
   _socketService, 
   _httpService, 
   _collaborationUIEventService, 
   _networkConditionService?): CollaborationSessionService

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

Parameters

Parameter	Type
`_injector`	`Injector`
`_logService`	`ILogService`
`_configService`	`IConfigService`
`_socketService`	`ICollaborationSocketService`
`_httpService`	`HTTPService`
`_collaborationUIEventService`	`CollaborationUIEventService`
`_networkConditionService`?	`INetworkConditionService`

Returns

CollaborationSessionService

Overrides

Disposable.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:96
`socket$`	`readonly`	`Observable`<`Nullable`<`ICollaborationSocket`>>	`undefined`	-	packages/collaboration-client/src/services/collaboration-session/collaboration-session.service.ts:33
`status$`	`public`	`Observable`<`SessionStatus`>	`undefined`	-	packages/collaboration-client/src/services/collaboration-session/collaboration-session.service.ts:43

Methods

closeSession()

closeSession(unitID): void

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

Parameters

Parameter	Type
`unitID`	`string`

Returns

void

dispose()

dispose(): void

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

Returns

void

Overrides

Disposable.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

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

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

ensureNotDisposed()

protected ensureNotDisposed(): void

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

Returns

void

Inherited from

Disposable.ensureNotDisposed

reconnect()

reconnect(): void

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

Returns

void

requireSession()

requireSession(unitID): Promise<CollaborationSession>

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

Require a collaboration session.

Parameters

Parameter	Type
`unitID`	`string`

Returns

Promise<CollaborationSession>

a collaboration session.

Collaborationsession Collaborationsocketservice