@univerjs-pro/exchange-client v0.5.0-beta.1Docs


Class: UniverExchangeClientPlugin

Plug-in base class, all plug-ins must inherit from this base class. Provide basic methods.

Extends

Constructors

new UniverExchangeClientPlugin()

new UniverExchangeClientPlugin(
   _config, 
   _injector, 
   _configService): UniverExchangeClientPlugin

Parameters

ParameterTypeDefault value
_configIUniverExchangeClientConfigdefaultPluginConfig
_injectorInjectorundefined
_configServiceIConfigServiceundefined

Returns

UniverExchangeClientPlugin

Overrides

Plugin.constructor

Defined in

packages/exchange-client/src/plugin.ts:17

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
_disposedprotectedbooleanfalse-Plugin._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:93
_injectorreadonlyInjectorundefined-Plugin._injectorpackages/exchange-client/src/plugin.ts:19
pluginNamestaticstringPluginNamePlugin.pluginName-packages/exchange-client/src/plugin.ts:15
typestaticUniverInstanceTypeUniverInstanceType.UNIVER_UNKNOWN-Plugin.typesubmodules/univer/packages/core/src/services/plugin/plugin.ts:35

Methods

dispose()

dispose(): void

Returns

void

Inherited from

Plugin.dispose

Defined in

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


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Plugin.disposeWithMe

Defined in

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


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Plugin.ensureNotDisposed

Defined in

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


getPluginName()

getPluginName(): string

Returns

string

Inherited from

Plugin.getPluginName

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:59


getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:55


onReady()

onReady(): void

Returns

void

Overrides

Plugin.onReady

Defined in

packages/exchange-client/src/plugin.ts:41


onRendered()

onRendered(): void

Returns

void

Inherited from

Plugin.onRendered

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:47


onStarting()

onStarting(): void

Returns

void

Overrides

Plugin.onStarting

Defined in

packages/exchange-client/src/plugin.ts:30


onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

submodules/univer/packages/core/src/services/plugin/plugin.ts:51