@univerjs-prolive-shareclassesLivesharecoordinator

@univerjs-pro/live-share v0.5.4


Class: LiveShareCoordinator

Defined in: packages/live-share/src/controllers/live-share/live-share.controller.ts:100

This coordinator subscribe to collaboration session and call LiveShareFollowerController or LiveSharePresenterController to execute live share.

Extends

Constructors

new LiveShareCoordinator()

new LiveShareCoordinator(
   _unitID, 
   _collabSession, 
   _configService, 
   _liveShareService, 
   _commandService): LiveShareCoordinator

Defined in: packages/live-share/src/controllers/live-share/live-share.controller.ts:112

Parameters

ParameterType
_unitIDstring
_collabSessionCollaborationSession
_configServiceIConfigService
_liveShareServiceLiveShareService
_commandServiceICommandService

Returns

LiveShareCoordinator

Overrides

RxDisposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseRxDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96
dispose$protectedSubject<void>undefinedRxDisposable.dispose$submodules/univer/packages/core/src/shared/lifecycle.ts:120
status$publicObservable<LiveShareStatus>undefined-packages/live-share/src/controllers/live-share/live-share.controller.ts:102

Methods

dispose()

dispose(): void

Defined in: packages/live-share/src/controllers/live-share/live-share.controller.ts:122

Returns

void

Overrides

RxDisposable.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

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

Parameters

ParameterType
disposableDisposableLike

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(): void

Defined in: packages/live-share/src/controllers/live-share/live-share.controller.ts:128

Returns

void


startFollowing()

startFollowing(): void

Defined in: packages/live-share/src/controllers/live-share/live-share.controller.ts:196

Returns

void


stopFollowing()

stopFollowing(): void

Defined in: packages/live-share/src/controllers/live-share/live-share.controller.ts:205

Returns

void


stopPresenting()

stopPresenting(): void

Defined in: packages/live-share/src/controllers/live-share/live-share.controller.ts:181

Returns

void


tryStartPresenting()

tryStartPresenting(): void

Defined in: packages/live-share/src/controllers/live-share/live-share.controller.ts:168

Returns

void