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


Class: LiveShareService

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:93

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

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


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

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


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

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


getInitialStates()

getInitialStates(unitID): IOperationInfo<object>[]

Parameters

ParameterType
unitIDstring

Returns

IOperationInfo<object>[]

Defined in

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


registerInitialStateReporter()

registerInitialStateReporter(reporter): IDisposable

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

Parameters

ParameterType
reporter(unitID) => IOperationInfo<object>

Returns

IDisposable

Defined in

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


registerSharedOperation()

registerSharedOperation(operation): IDisposable

Parameters

ParameterType
operationstring

Returns

IDisposable

Defined in

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


shouldShareOperation()

shouldShareOperation(operation): boolean

Parameters

ParameterType
operationstring

Returns

boolean

Defined in

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