Class PluginHostRPC

The RPC handler for frontend-connection-scoped plugins (Theia and VSCode plugins).

Hierarchy (View Summary)

AbstractPluginHostRPC<PluginManagerExtImpl, PluginAPIFactory, ExtInterfaces>
- PluginHostRPC

Constructors

constructor

new PluginHostRPC(): PluginHostRPC
Returns PluginHostRPC
Overrides AbstractPluginHostRPC.constructor
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:323

Properties

`Protected`apiFactory

apiFactory: PluginAPIFactory

`Protected` `Readonly`banner

banner: string

`Protected` `Readonly`clipboardExt

clipboardExt: ClipboardExt

`Protected` `Readonly`debugExt

debugExt: DebugExtImpl

`Protected` `Readonly`editorsAndDocumentsExt

editorsAndDocumentsExt: EditorsAndDocumentsExtImpl

`Protected` `Readonly`envExt

envExt: EnvExtImpl

`Protected` `Readonly`keyValueStorageProxy

keyValueStorageProxy: KeyValueStorageProxy

`Protected` `Readonly`loadContainerModule

loadContainerModule: PluginContainerModuleLoader

`Protected` `Readonly`localizationExt

localizationExt: LocalizationExtImpl

`Protected` `Readonly`messageRegistryExt

messageRegistryExt: MessageRegistryExt

`Protected` `Readonly`pluginManager

pluginManager: PluginManagerExtImpl

`Protected` `Readonly`preferenceRegistryExt

preferenceRegistryExt: PreferenceRegistryExtImpl

`Protected` `Readonly`rpc

rpc: any

`Protected` `Readonly`secretsExt

secretsExt: SecretsExtImpl

`Protected` `Readonly`terminalServiceExt

terminalServiceExt: TerminalServiceExtImpl

`Protected` `Readonly`webviewExt

webviewExt: WebviewsExtImpl

`Protected` `Readonly`workspaceExt

workspaceExt: WorkspaceExtImpl

Methods

`Protected`createAPIFactory

createAPIFactory(extInterfaces: ExtInterfaces): PluginAPIFactory
Parameters
- extInterfaces: ExtInterfaces
Returns PluginAPIFactory
Overrides AbstractPluginHostRPC.createAPIFactory
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:355

`Protected`createExtInterfaces

createExtInterfaces(): ExtInterfaces
Returns ExtInterfaces
Overrides AbstractPluginHostRPC.createExtInterfaces
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:337

createPluginHost

createPluginHost(): PluginHost
Create the PluginHost that is required by my plugin manager ext interface to delegate critical behaviour such as loading and initializing plugins to me.

Returns PluginHost
Inherited from AbstractPluginHostRPC.createPluginHost
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:164

`Protected`getBackendPluginPath

getBackendPluginPath(pluginModel: PluginModel): undefined | string
Parameters
- pluginModel: PluginModel
Returns undefined | string
Inherited from AbstractPluginHostRPC.getBackendPluginPath
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:156

initContext

initContext(contextPath: string, plugin: Plugin): void
Parameters
- contextPath: string
- plugin: Plugin
Returns void
Inherited from AbstractPluginHostRPC.initContext
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:144

`Protected`initExtApi

initExtApi(extApi: ExtPluginApi): void
Initialize the end of the given provided extension API applicable to the current plugin host. Errors should be propagated to the caller.
Parameters
- extApi: ExtPluginApi
  the extension API to initialize, if appropriate
Returns void
Throws
if any error occurs in initializing the extension API
Overrides AbstractPluginHostRPC.initExtApi
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:365

initialize

initialize(): void
Returns void
Inherited from AbstractPluginHostRPC.initialize
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:111

`Protected`registerExtInterfaces

registerExtInterfaces(extInterfaces: ExtInterfaces): void
Parameters
- extInterfaces: ExtInterfaces
Returns void
Inherited from AbstractPluginHostRPC.registerExtInterfaces
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:131

terminate

terminate(): Promise<void>
Returns Promise<void>
Inherited from AbstractPluginHostRPC.terminate
- Defined in packages/plugin-ext/src/hosted/node/plugin-host-rpc.ts:123