Skip to main content

PluginLifecycle

API Docs

Class: PluginLifecycle

Defined in: src/plugin/manager/lifecycle.ts:40

Constructors​

Constructor​

new PluginLifecycle(pluginContext, loadedPlugins, extensionRegistry): PluginLifecycle

Defined in: src/plugin/manager/lifecycle.ts:41

Parameters​

pluginContext​

IPluginContext

loadedPlugins​

Map<string, ILoadedPlugin>

extensionRegistry​

IExtensionRegistry

Returns​

PluginLifecycle

Methods​

activatePlugin()​

activatePlugin(pluginId, pluginManager): Promise<boolean>

Defined in: src/plugin/manager/lifecycle.ts:137

Activate a plugin - trigger schema rebuild

Parameters​

pluginId​

string

pluginManager​

IPluginManager

Returns​

Promise<boolean>

deactivatePlugin()​

deactivatePlugin(pluginId, pluginManager, dropTables): Promise<boolean>

Defined in: src/plugin/manager/lifecycle.ts:196

Deactivate a plugin - trigger schema rebuild

Parameters​

pluginId​

string

pluginManager​

IPluginManager

dropTables​

boolean = false

Returns​

Promise<boolean>

getPluginModule()​

getPluginModule(pluginId): Promise<IPluginLifecycle | null>

Defined in: src/plugin/manager/lifecycle.ts:397

Get plugin module for lifecycle hooks

Parameters​

pluginId​

string

Returns​

Promise<IPluginLifecycle | null>

installPlugin()​

installPlugin(pluginId, pluginManager): Promise<boolean>

Defined in: src/plugin/manager/lifecycle.ts:50

Install a plugin - install dependencies and create plugin-defined databases

Parameters​

pluginId​

string

pluginManager​

IPluginManager

Returns​

Promise<boolean>

removeFromExtensionRegistry()​

removeFromExtensionRegistry(pluginId): void

Defined in: src/plugin/manager/lifecycle.ts:417

Remove plugin from extension registry

Parameters​

pluginId​

string

Returns​

void

uninstallPlugin()​

uninstallPlugin(pluginId, pluginManager): Promise<boolean>

Defined in: src/plugin/manager/lifecycle.ts:95

Uninstall a plugin - remove tables and cleanup

Parameters​

pluginId​

string

pluginManager​

IPluginManager

Returns​

Promise<boolean>

unloadPlugin()​

unloadPlugin(pluginId, pluginManager): Promise<boolean>

Defined in: src/plugin/manager/lifecycle.ts:546

Unload a plugin - remove from memory without database changes

Parameters​

pluginId​

string

pluginManager​

IPluginManager

Returns​

Promise<boolean>