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

Class: UniverCollaborationClientPlugin

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

Extends

Plugin

Constructors

new UniverCollaborationClientPlugin()

new UniverCollaborationClientPlugin(
   _config, 
   _logService, 
   _renderManagerService, 
   _injector, 
   _configService): UniverCollaborationClientPlugin

Parameters

Parameter	Type	Default value
`_config`	`Partial`<`IUniverCollaborationClientConfig`>	`defaultPluginConfig`
`_logService`	`ILogService`	`undefined`
`_renderManagerService`	`IRenderManagerService`	`undefined`
`_injector`	`Injector`	`undefined`
`_configService`	`IConfigService`	`undefined`

Returns

UniverCollaborationClientPlugin

Overrides

Plugin.constructor

Defined in

packages/collaboration-client/src/plugin.ts:52

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/collaboration-client/src/plugin.ts:56
`pluginName`	`static`	`string`	`PLUGIN_NAME`	`Plugin`.`pluginName`	-	packages/collaboration-client/src/plugin.ts:50
`type`	`static`	`UniverInstanceType`	`UniverInstanceType.UNIVER_UNKNOWN`	-	`Plugin`.`type`	submodules/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

Parameter	Type
`disposable`	`DisposableLike`

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/collaboration-client/src/plugin.ts:72

onRendered()

onRendered(): void

Returns

void

Overrides

Plugin.onRendered

Defined in

packages/collaboration-client/src/plugin.ts:76

onStarting()

onStarting(): void

Returns

void

Overrides

Plugin.onStarting

Defined in

packages/collaboration-client/src/plugin.ts:67

onSteady()

onSteady(): void

Returns

void

Inherited from

Plugin.onSteady

Defined in

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

Snapshotserveroverhttpservice Weburlservice