@univerjs-pro/collaboration-client v0.5.4

Class: UniverCollaborationClientPlugin

Defined in: packages/collaboration-client/src/plugin.ts:55

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, 
   _injector, 
   _configService): UniverCollaborationClientPlugin

Defined in: packages/collaboration-client/src/plugin.ts:58

Parameters

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

Returns

UniverCollaborationClientPlugin

Overrides

Plugin.constructor

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:96
`_injector`	`protected`	`Injector`	`undefined`	-	`Plugin`.`_injector`	packages/collaboration-client/src/plugin.ts:61
`pluginName`	`static`	`string`	`PLUGIN_NAME`	`Plugin`.`pluginName`	-	packages/collaboration-client/src/plugin.ts:56
`type`	`static`	`UniverInstanceType`	`UniverInstanceType.UNIVER_UNKNOWN`	-	`Plugin`.`type`	submodules/univer/packages/core/src/services/plugin/plugin.ts:35

Methods

dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

Plugin.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

Plugin.disposeWithMe

ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Plugin.ensureNotDisposed

getPluginName()

getPluginName(): string

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

Returns

string

Inherited from

Plugin.getPluginName

getUniverInstanceType()

getUniverInstanceType(): UniverInstanceType

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

Returns

UniverInstanceType

Inherited from

Plugin.getUniverInstanceType

onReady()

onReady(): void

Defined in: submodules/univer/packages/core/src/services/plugin/plugin.ts:43

Returns

void

Inherited from

Plugin.onReady

onRendered()

onRendered(): void

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

Returns

void

Inherited from

Plugin.onRendered

onStarting()

onStarting(): void

Defined in: packages/collaboration-client/src/plugin.ts:75

Returns

void

Overrides

Plugin.onStarting

onSteady()

onSteady(): void

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

Returns

void

Inherited from

Plugin.onSteady

Syncedstate Collaborationstatus