Class HeadlessHostedPluginServerImpl

This class implements the per-front-end services for plugin management and communication

Hierarchy (View Summary)

HostedPluginServerImpl
- HeadlessHostedPluginServerImpl

Constructors

constructor

new HeadlessHostedPluginServerImpl(
hostedPlugin: HostedPluginSupport,
): HeadlessHostedPluginServerImpl
Parameters
- hostedPlugin: HostedPluginSupport
Returns HeadlessHostedPluginServerImpl
Inherited from HostedPluginServerImpl.constructor
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:35

Properties

`Protected`backendPluginHostableFilter

backendPluginHostableFilter: BackendPluginHostableFilter

`Protected`client

client: undefined | HostedPluginClient

`Protected` `Readonly`deployerHandler

deployerHandler: PluginDeployerHandlerImpl

`Protected`disabledPlugins

disabledPlugins: Set<`${string}.${string}@${string}`>

`Protected` `Readonly`extPluginAPIContributions

extPluginAPIContributions: ContributionProvider<ExtPluginApiProvider>

`Protected` `Readonly`initialized

initialized: Deferred<void>

`Protected` `Readonly`localizationService

localizationService: HostedPluginLocalizationService

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`pluginDeployer

pluginDeployer: PluginDeployerImpl

`Protected` `Readonly`pluginVersions

pluginVersions: Map<`${string}.${string}`, string>

`Protected`toDispose

toDispose: DisposableCollection

`Protected` `Readonly`uninstallationManager

uninstallationManager: PluginUninstallationManager

`Protected`uninstalledPlugins

uninstalledPlugins: Set<`${string}.${string}@${string}`>

Methods

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from HostedPluginServerImpl.dispose
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:38

getDeployedPluginIds

getDeployedPluginIds(): Promise<`${string}.${string}@${string}`[]>
Returns Promise<`${string}.${string}@${string}`[]>
Inherited from HostedPluginServerImpl.getDeployedPluginIds
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:40

getDeployedPlugins

getDeployedPlugins(
pluginIds: `${string}.${string}@${string}`[],
): Promise<DeployedPlugin[]>
Parameters
- pluginIds: `${string}.${string}@${string}`[]
Returns Promise<DeployedPlugin[]>
Inherited from HostedPluginServerImpl.getDeployedPlugins
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:51

getDisabledPluginIds

getDisabledPluginIds(): Promise<readonly `${string}.${string}@${string}`[]>
Returns Promise<readonly `${string}.${string}@${string}`[]>
Inherited from HostedPluginServerImpl.getDisabledPluginIds
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:50

getExtPluginAPI

getExtPluginAPI(): Promise<ExtPluginApi[]>
Returns Promise<ExtPluginApi[]>
Inherited from HostedPluginServerImpl.getExtPluginAPI
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:53

`Protected`getServerName

getServerName(): string
Returns string
Overrides HostedPluginServerImpl.getServerName
- Defined in plugin-ext-headless/src/hosted/node/headless-plugin-service.ts:22

getUninstalledPluginIds

getUninstalledPluginIds(): Promise<readonly `${string}.${string}@${string}`[]>
Returns Promise<readonly `${string}.${string}@${string}`[]>
Inherited from HostedPluginServerImpl.getUninstalledPluginIds
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:49

`Protected`init

init(): void
Returns void
Inherited from HostedPluginServerImpl.init
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:36

`Protected`isRelevantPlugin

isRelevantPlugin(identifier: `${string}.${string}@${string}`): boolean
Ensures that the plugin was not uninstalled when this session was started and that it matches the first version of the given plugin seen by this session.

The deployment system may have multiple versions of the same plugin available, but a single session should only ever activate one of them.
Parameters
- identifier: `${string}.${string}@${string}`
Returns boolean
Inherited from HostedPluginServerImpl.isRelevantPlugin
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:48

onMessage

onMessage(pluginHostId: string, message: Uint8Array): Promise<void>
Parameters
- pluginHostId: string
- message: Uint8Array
Returns Promise<void>
Inherited from HostedPluginServerImpl.onMessage
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:52

setClient

setClient(client: HostedPluginClient): void
If this server is a proxy to a remote server then a client is used as a local object to handle RPC messages from the remote server.
Parameters
- client: HostedPluginClient
Returns void
Inherited from HostedPluginServerImpl.setClient
- Defined in plugin-ext/lib/hosted/node/plugin-service.d.ts:39

Class HeadlessHostedPluginServerImpl

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HeadlessHostedPluginServerImpl

Properties

ProtectedbackendPluginHostableFilter

Protectedclient

Protected ReadonlydeployerHandler

ProtecteddisabledPlugins

Protected ReadonlyextPluginAPIContributions

Protected Readonlyinitialized

Protected ReadonlylocalizationService

Protected Readonlylogger

Protected ReadonlypluginDeployer

Protected ReadonlypluginVersions

ProtectedtoDispose

Protected ReadonlyuninstallationManager

ProtecteduninstalledPlugins

Methods

dispose

Returns void

getDeployedPluginIds

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

getDeployedPlugins

Parameters

Returns Promise<DeployedPlugin[]>

getDisabledPluginIds

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

getExtPluginAPI

Returns Promise<ExtPluginApi[]>

ProtectedgetServerName

Returns string

getUninstalledPluginIds

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

Protectedinit

Returns void

ProtectedisRelevantPlugin

Parameters

Returns boolean

onMessage

Parameters

Returns Promise<void>

setClient

Parameters

Returns void

Settings

On This Page

`Protected`backendPluginHostableFilter

`Protected`client

`Protected` `Readonly`deployerHandler

`Protected`disabledPlugins

`Protected` `Readonly`extPluginAPIContributions

`Protected` `Readonly`initialized

`Protected` `Readonly`localizationService

`Protected` `Readonly`logger

`Protected` `Readonly`pluginDeployer

`Protected` `Readonly`pluginVersions

`Protected`toDispose

`Protected` `Readonly`uninstallationManager

`Protected`uninstalledPlugins

`Protected`getServerName

`Protected`init

`Protected`isRelevantPlugin