Skip to main content

PluginManager

Admin Docs

Class: PluginManager

Defined in: src/plugin/manager.ts:16

Constructors​

Constructor​

new PluginManager(apolloClient?): PluginManager

Defined in: src/plugin/manager.ts:23

Parameters​

apolloClient?​

ApolloClient<unknown>

Returns​

PluginManager

Methods​

activatePlugin()​

activatePlugin(pluginId): Promise<boolean>

Defined in: src/plugin/manager.ts:102

Parameters​

pluginId​

string

Returns​

Promise<boolean>

deactivatePlugin()​

deactivatePlugin(pluginId): Promise<boolean>

Defined in: src/plugin/manager.ts:106

Parameters​

pluginId​

string

Returns​

Promise<boolean>

getActivePluginCount()​

getActivePluginCount(): number

Defined in: src/plugin/manager.ts:142

Returns​

number

getExtensionPoints()​

getExtensionPoints<T>(type): IExtensionRegistry[T]

Defined in: src/plugin/manager.ts:147

Type Parameters​

T​

T extends keyof IExtensionRegistry

Parameters​

type​

T

Returns​

IExtensionRegistry[T]

getLoadedPlugin()​

getLoadedPlugin(pluginId): ILoadedPlugin

Defined in: src/plugin/manager.ts:127

Parameters​

pluginId​

string

Returns​

ILoadedPlugin

getLoadedPlugins()​

getLoadedPlugins(): ILoadedPlugin[]

Defined in: src/plugin/manager.ts:123

Returns​

ILoadedPlugin[]

getPluginComponent()​

getPluginComponent(pluginId, componentName): ComponentType<{ }>

Defined in: src/plugin/manager.ts:131

Parameters​

pluginId​

string

componentName​

string

Returns​

ComponentType<{ }>

getPluginCount()​

getPluginCount(): number

Defined in: src/plugin/manager.ts:138

Returns​

number

initializePluginSystem()​

initializePluginSystem(): Promise<void>

Defined in: src/plugin/manager.ts:163

Returns​

Promise<void>

installPlugin()​

installPlugin(pluginId): Promise<boolean>

Defined in: src/plugin/manager.ts:94

Parameters​

pluginId​

string

Returns​

Promise<boolean>

isSystemInitialized()​

isSystemInitialized(): boolean

Defined in: src/plugin/manager.ts:172

Returns​

boolean

loadPlugin()​

loadPlugin(pluginId): Promise<boolean>

Defined in: src/plugin/manager.ts:86

Parameters​

pluginId​

string

Returns​

Promise<boolean>

off()​

off(event, callback): void

Defined in: src/plugin/manager.ts:158

Parameters​

event​

string

callback​

(...args) => void

Returns​

void

on()​

on(event, callback): void

Defined in: src/plugin/manager.ts:154

Parameters​

event​

string

callback​

(...args) => void

Returns​

void

refreshPluginDiscovery()​

refreshPluginDiscovery(): Promise<void>

Defined in: src/plugin/manager.ts:118

Returns​

Promise<void>

setApolloClient()​

setApolloClient(apolloClient): void

Defined in: src/plugin/manager.ts:42

Parameters​

apolloClient​

ApolloClient<unknown>

Returns​

void

togglePluginStatus()​

togglePluginStatus(pluginId, status): Promise<boolean>

Defined in: src/plugin/manager.ts:110

Parameters​

pluginId​

string

status​

"active" | "inactive"

Returns​

Promise<boolean>

uninstallPlugin()​

uninstallPlugin(pluginId): Promise<boolean>

Defined in: src/plugin/manager.ts:98

Parameters​

pluginId​

string

Returns​

Promise<boolean>

unloadPlugin()​

unloadPlugin(pluginId): Promise<boolean>

Defined in: src/plugin/manager.ts:90

Parameters​

pluginId​

string

Returns​

Promise<boolean>