@univerjs-pro/live-share v0.5.4


Class: LiveShareService

Defined in: packages/live-share/src/services/live-share.service.ts:4

Extends

Constructors

new LiveShareService()

new LiveShareService(): LiveShareService

Returns

LiveShareService

Inherited from

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96

Methods

dispose()

dispose(): void

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

Returns

void

Inherited from

Disposable.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

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

Parameters

ParameterType
disposableDisposableLike

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


getInitialStates()

getInitialStates(unitID): IOperationInfo[]

Defined in: packages/live-share/src/services/live-share.service.ts:28

Parameters

ParameterType
unitIDstring

Returns

IOperationInfo[]


registerInitialStateReporter()

registerInitialStateReporter(reporter): IDisposable

Defined in: packages/live-share/src/services/live-share.service.ts:19

Register a reported that should report a view part’s current state by returning an operation.

Parameters

ParameterType
reporter(unitID) => IOperationInfo

Returns

IDisposable


registerSharedOperation()

registerSharedOperation(operation): IDisposable

Defined in: packages/live-share/src/services/live-share.service.ts:8

Parameters

ParameterType
operationstring

Returns

IDisposable


shouldShareOperation()

shouldShareOperation(operation): boolean

Defined in: packages/live-share/src/services/live-share.service.ts:24

Parameters

ParameterType
operationstring

Returns

boolean