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


Class: LiveShareController

This controller manage live share session.

Extends

Constructors

new LiveShareController()

new LiveShareController(
   _univerInstanceService, 
   _injector, 
   _collabSessionService): LiveShareController

Parameters

ParameterType
_univerInstanceServiceIUniverInstanceService
_injectorInjector
_collabSessionServiceCollaborationSessionService

Returns

LiveShareController

Overrides

RxDisposable.constructor

Defined in

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

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

Methods

dispose()

dispose(): void

Returns

void

Inherited from

RxDisposable.dispose

Defined in

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


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


getLiveShareCoordinator()

getLiveShareCoordinator(unitID): Promise<LiveShareCoordinator>

Parameters

ParameterType
unitIDstring

Returns

Promise<LiveShareCoordinator>

Defined in

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