Interface PluginServer

interface PluginServer {
    disablePlugin(pluginId): Promise<boolean>;
    enablePlugin(pluginId): Promise<boolean>;
    getAllStorageValues(kind): Promise<KeysToKeysToAnyValue>;
    getDisabledPlugins(): Promise<readonly `${string}.${string}@${string}`[]>;
    getInstalledPlugins(): Promise<readonly `${string}.${string}@${string}`[]>;
    getStorageValue(key, kind): Promise<KeysToAnyValues>;
    getUninstalledPlugins(): Promise<readonly `${string}.${string}@${string}`[]>;
    install(pluginEntry, type?, options?): Promise<void>;
    setStorageValue(key, value, kind): Promise<boolean>;
    uninstall(pluginId): Promise<void>;
}

Implemented by

PluginServerImpl

Index

Methods

disablePlugin enablePlugin getAllStorageValues getDisabledPlugins getInstalledPlugins getStorageValue getUninstalledPlugins install setStorageValue uninstall

Methods

disablePlugin

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

enablePlugin

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

getAllStorageValues

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

getDisabledPlugins

getDisabledPlugins(): Promise<readonly `${string}.${string}@${string}`[]>
Returns Promise<readonly `${string}.${string}@${string}`[]>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1083

getInstalledPlugins

getInstalledPlugins(): Promise<readonly `${string}.${string}@${string}`[]>
Returns Promise<readonly `${string}.${string}@${string}`[]>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1081

getStorageValue

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

getUninstalledPlugins

getUninstalledPlugins(): Promise<readonly `${string}.${string}@${string}`[]>
Returns Promise<readonly `${string}.${string}@${string}`[]>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1082

install

install(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:1075

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:1085

uninstall

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

Interface PluginServer

Implemented by

Index

Methods

Methods

disablePlugin

Parameters

Returns Promise<boolean>

enablePlugin

Parameters

Returns Promise<boolean>

getAllStorageValues

Parameters

Returns Promise<KeysToKeysToAnyValue>

getDisabledPlugins

Returns Promise<readonly `${string}.${string}@${string}`[]>

getInstalledPlugins

Returns Promise<readonly `${string}.${string}@${string}`[]>

getStorageValue

Parameters

Returns Promise<KeysToAnyValues>

getUninstalledPlugins

Returns Promise<readonly `${string}.${string}@${string}`[]>

install

Parameters

Returns Promise<void>

setStorageValue

Parameters

Returns Promise<boolean>

uninstall

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page