Class PluginAPI

Index

Constructors

Methods

activate deactivate get getActive getAll getInfo has initialize install load resume shutdown suspend uninstall

Constructors

constructor

new PluginAPI(manager?: PluginManager): PluginAPI
Parameters
- Optionalmanager: PluginManager
Returns PluginAPI
- Defined in plugins/dist/api.d.ts:10

Methods

activate

activate(pluginId: string): PluginContext
Parameters
- pluginId: string
Returns PluginContext
- Defined in plugins/dist/api.d.ts:14

deactivate

deactivate(pluginId: string): void
Parameters
- pluginId: string
Returns void
- Defined in plugins/dist/api.d.ts:17

get

get(pluginId: string): PluginEntity | undefined
Parameters
- pluginId: string
Returns PluginEntity | undefined
- Defined in plugins/dist/api.d.ts:19

getActive

getActive(): PluginEntity[]
Returns PluginEntity[]
- Defined in plugins/dist/api.d.ts:21

getAll

getAll(): PluginEntity[]
Returns PluginEntity[]
- Defined in plugins/dist/api.d.ts:20

getInfo

getInfo(pluginId: string): PluginInfo | undefined
Parameters
- pluginId: string
Returns PluginInfo | undefined
- Defined in plugins/dist/api.d.ts:22

has

has(pluginId: string): boolean
Parameters
- pluginId: string
Returns boolean
- Defined in plugins/dist/api.d.ts:23

initialize

initialize(pluginId: string): void
Parameters
- pluginId: string
Returns void
- Defined in plugins/dist/api.d.ts:13

install

install(manifest: PluginManifest): PluginEntity
Parameters
- manifest: PluginManifest
Returns PluginEntity
- Defined in plugins/dist/api.d.ts:11

load

load(pluginId: string): void
Parameters
- pluginId: string
Returns void
- Defined in plugins/dist/api.d.ts:12

resume

resume(pluginId: string): void
Parameters
- pluginId: string
Returns void
- Defined in plugins/dist/api.d.ts:16

shutdown

shutdown(): void
Returns void
- Defined in plugins/dist/api.d.ts:24

suspend

suspend(pluginId: string): void
Parameters
- pluginId: string
Returns void
- Defined in plugins/dist/api.d.ts:15

uninstall

uninstall(pluginId: string): void
Parameters
- pluginId: string
Returns void
- Defined in plugins/dist/api.d.ts:18