Interface PluginServer

interface PluginServer {
    deploy(pluginEntry, type?, options?): Promise<void>;
    getAllStorageValues(kind): Promise<KeysToKeysToAnyValue>;
    getStorageValue(key, kind): Promise<KeysToAnyValues>;
    setStorageValue(key, value, kind): Promise<boolean>;
    undeploy(pluginId): Promise<void>;
    uninstall(pluginId): Promise<void>;
}

Implemented by

PluginServerHandler

Index

Methods

deploy getAllStorageValues getStorageValue setStorageValue undeploy uninstall

Methods

deploy

deploy(pluginEntry, type?, options?): Promise<void>
Deploy a plugin.
Parameters
- pluginEntry: string
- Optional type: PluginType
  whether a plugin is installed by a system or a user, defaults to a user
- Optional options: PluginDeployOptions
Returns Promise<void>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1062

getAllStorageValues

getAllStorageValues(kind): Promise<KeysToKeysToAnyValue>
Parameters
- kind: PluginStorageKind
Returns Promise<KeysToKeysToAnyValue>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1068

getStorageValue

getStorageValue(key, kind): Promise<KeysToAnyValues>
Parameters
- key: string
- kind: PluginStorageKind
Returns Promise<KeysToAnyValues>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1067

setStorageValue

setStorageValue(key, value, kind): Promise<boolean>
Parameters
- key: string
- value: KeysToAnyValues
- kind: PluginStorageKind
Returns Promise<boolean>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1066

undeploy

undeploy(pluginId): Promise<void>
Parameters
- pluginId: `${string}.${string}@${string}`
Returns Promise<void>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1064

uninstall

uninstall(pluginId): Promise<void>
Parameters
- pluginId: `${string}.${string}@${string}`
Returns Promise<void>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1063