@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
Inherited from
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | Disposable ._disposed | submodules/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
disposeWithMe()
disposeWithMe(disposable): IDisposable
Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
ensureNotDisposed()
protected ensureNotDisposed(): void
Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103
Returns
void
Inherited from
getInitialStates()
getInitialStates(unitID): IOperationInfo[]
Defined in: packages/live-share/src/services/live-share.service.ts:28
Parameters
Parameter | Type |
---|---|
unitID | string |
Returns
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
Parameter | Type |
---|---|
reporter | (unitID ) => IOperationInfo |
Returns
registerSharedOperation()
registerSharedOperation(operation): IDisposable
Defined in: packages/live-share/src/services/live-share.service.ts:8
Parameters
Parameter | Type |
---|---|
operation | string |
Returns
shouldShareOperation()
shouldShareOperation(operation): boolean
Defined in: packages/live-share/src/services/live-share.service.ts:24
Parameters
Parameter | Type |
---|---|
operation | string |
Returns
boolean