@univerjs-prolive-shareclassesLivesharecoordinator

@univerjs-pro/live-share v0.5.0-beta.1Docs


Class: LiveShareCoordinator

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

Parameters

ParameterType
_unitIDstring
_collabSessionCollaborationSession
_configServiceIConfigService
_liveShareServiceLiveShareService
_commandServiceICommandService

Returns

LiveShareCoordinator

Overrides

RxDisposable.constructor

Defined in

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

Properties

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

Methods

dispose()

dispose(): void

Returns

void

Overrides

RxDisposable.dispose

Defined in

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


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

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


init()

init(): void

Returns

void

Defined in

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


startFollowing()

startFollowing(): void

Returns

void

Defined in

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


stopFollowing()

stopFollowing(): void

Returns

void

Defined in

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


stopPresenting()

stopPresenting(): void

Returns

void

Defined in

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


tryStartPresenting()

tryStartPresenting(): void

Returns

void

Defined in

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