Class PluginApiContribution

Contribution for hooking into the backend lifecycle:

initialize()
configure(expressApp)
onStart(httpServer)
onStop()

Implements

Index

Constructors

Properties

applicationPackage remoteService serveSameOrigin webviewExternalEndpointRegExp

Methods

allowWsUpgrade configure init webviewExternalEndpoint webviewExternalEndpointPattern

Constructors

constructor

new PluginApiContribution(): PluginApiContribution
Returns PluginApiContribution

Properties

`Protected` `Readonly`applicationPackage

applicationPackage: ApplicationPackage

`Protected` `Readonly`remoteService

remoteService: BackendRemoteService

`Protected`serveSameOrigin

serveSameOrigin: boolean = false

`Protected`webviewExternalEndpointRegExp

webviewExternalEndpointRegExp: RegExp

Methods

allowWsUpgrade

allowWsUpgrade(request: IncomingMessage): MaybePromise<boolean>
Return false to prevent the protocol upgrade from going through, blocking the WebSocket connection.
Parameters
- request: IncomingMessage
  The HTTP connection upgrade request received by the server.
Returns MaybePromise<boolean>
Implementation of WsRequestValidatorContribution.allowWsUpgrade
- Defined in packages/plugin-ext/src/main/node/plugin-service.ts:64

configure

configure(app: Application): void
Called after the initialization of the backend application is complete. Use this to configure the Express app before it is started, for example to offer additional endpoints.

The implementation may be async, however it will still block the configuration step until it's resolved.
Parameters
- app: Application
  the express application to configure.
Returns void
either undefined or a Promise resolving to undefined.
Implementation of BackendApplicationContribution.configure
- Defined in packages/plugin-ext/src/main/node/plugin-service.ts:51

`Protected`init

init(): void
Returns void
- Defined in packages/plugin-ext/src/main/node/plugin-service.ts:45

`Protected`webviewExternalEndpoint

webviewExternalEndpoint(): string
Returns a RegExp pattern matching the expected WebView endpoint's host.

Returns string
- Defined in packages/plugin-ext/src/main/node/plugin-service.ts:91

`Protected`webviewExternalEndpointPattern

webviewExternalEndpointPattern(): string
Returns string
- Defined in packages/plugin-ext/src/main/node/plugin-service.ts:75