@univerjs-pro/live-share v0.5.0-beta.1 • Docs
Class: UniverLiveSharePlugin
Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods.
Extends
Constructors
new UniverLiveSharePlugin()
new UniverLiveSharePlugin(
_config,
_injector,
_configService): UniverLiveSharePlugin
Parameters
Parameter | Type | Default value |
---|---|---|
_config | IUniverLiveShareConfig | defaultPluginConfig |
_injector | Injector | undefined |
_configService | IConfigService | undefined |
Returns
Overrides
Defined in
packages/live-share/src/plugin.ts:27
Properties
Property | Modifier | Type | Default value | Overrides | Inherited from | Defined in |
---|---|---|---|---|---|---|
_disposed | protected | boolean | false | - | Plugin ._disposed | submodules/univer/packages/core/src/shared/lifecycle.ts:93 |
_injector | protected | Injector | undefined | - | Plugin ._injector | packages/live-share/src/plugin.ts:29 |
pluginName | static | string | PLUGIN_NAME | Plugin .pluginName | - | packages/live-share/src/plugin.ts:25 |
type | static | UniverInstanceType | UniverInstanceType.UNIVER_UNKNOWN | Plugin .type | - | packages/live-share/src/plugin.ts:24 |
Methods
dispose()
dispose(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:106
disposeWithMe()
disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:96
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:100
getPluginName()
getPluginName(): string
Returns
string
Inherited from
Defined in
submodules/univer/packages/core/src/services/plugin/plugin.ts:59
getUniverInstanceType()
getUniverInstanceType(): UniverInstanceType
Returns
Inherited from
Defined in
submodules/univer/packages/core/src/services/plugin/plugin.ts:55
onReady()
onReady(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/core/src/services/plugin/plugin.ts:43
onRendered()
onRendered(): void
Returns
void
Overrides
Defined in
packages/live-share/src/plugin.ts:53
onStarting()
onStarting(): void
Returns
void
Overrides
Defined in
packages/live-share/src/plugin.ts:40
onSteady()
onSteady(): void
Returns
void
Inherited from
Defined in
submodules/univer/packages/core/src/services/plugin/plugin.ts:51