Class HostedPluginManagerClient

Responsible for UI to set up and control Hosted Plugin Instance.

Constructors

constructor

new HostedPluginManagerClient(): HostedPluginManagerClient
Returns HostedPluginManagerClient

Properties

`Protected` `Readonly`debugSessionManager

debugSessionManager: DebugSessionManager

`Protected` `Readonly`environments

environments: EnvVariablesServer

`Protected` `Readonly`fileDialogService

fileDialogService: FileDialogService

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Readonly`hostedPluginPreferences

hostedPluginPreferences: HostedPluginPreferences

`Protected` `Readonly`hostedPluginServer

hostedPluginServer: PluginDevServer

`Protected`hostedPluginSessionId

hostedPluginSessionId: undefined | string

Session ID of the parent pwa-extensionHost debug session

`Protected`hostedWindowId

hostedWindowId: undefined | number

Electron window ID of the hosted plugin window, for closing on shutdown

`Protected`isDebug

isDebug: boolean = false

`Protected` `Readonly`labelProvider

labelProvider: LabelProvider

`Protected` `Readonly`messageService

messageService: MessageService

`Protected`pluginInstanceURL

pluginInstanceURL: undefined | string

URL to the running plugin instance

`Protected`pluginLocation

pluginLocation: undefined | URI

path to the plugin on the file system

`Protected` `Readonly`stateChanged

stateChanged: Emitter<HostedInstanceData> = ...

`Protected` `Readonly`windowService

windowService: WindowService

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Accessors

lastPluginLocation

get lastPluginLocation(): undefined | string
Returns undefined | string
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:151

onStateChanged

get onStateChanged(): Event<HostedInstanceData>
Returns Event<HostedInstanceData>
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:112

Methods

debug

debug(config?: PluginDebugConfiguration): Promise<undefined | string>
Parameters
- Optionalconfig: PluginDebugConfiguration
Returns Promise<undefined | string>
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:194

`Protected`doInit

doInit(): Promise<void>
Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:142

`Protected`getErrorMessage

getErrorMessage(error: any): string
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- error: any
Returns string
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:407

`Protected`init

init(): void
Returns void
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:138

`Protected`launchVSCode

launchVSCode(
__namedParameters: LaunchVSCodeRequest,
): Promise<LaunchVSCodeResult>
Parameters
- __namedParameters: LaunchVSCodeRequest
Returns Promise<LaunchVSCodeResult>
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:377

`Protected`openPluginWindow

openPluginWindow(): Promise<void>
Opens window with URL to the running plugin instance.

Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:357

register

register(configType: string, connection: DebugSessionConnection): void
Parameters
- configType: string
- connection: DebugSessionConnection
Returns void
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:328

restart

restart(): Promise<void>
Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:259

selectPluginPath

selectPluginPath(): Promise<void>
Creates directory choose dialog and set selected folder into pluginLocation field.

Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:304

start

start(debugConfig?: PluginDebugConfiguration): Promise<void>
Parameters
- OptionaldebugConfig: PluginDebugConfiguration
Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:158

startDebugSessionManager

startDebugSessionManager(): Promise<void>
Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:201

stop

stop(checkRunning?: boolean): Promise<void>
Parameters
- checkRunning: boolean = true
Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-manager-client.ts:228

Class HostedPluginManagerClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns HostedPluginManagerClient

Properties

Protected ReadonlydebugSessionManager

Protected Readonlyenvironments

Protected ReadonlyfileDialogService

Protected ReadonlyfileService

Protected ReadonlyhostedPluginPreferences

Protected ReadonlyhostedPluginServer

ProtectedhostedPluginSessionId

ProtectedhostedWindowId

ProtectedisDebug

Protected ReadonlylabelProvider

Protected ReadonlymessageService

ProtectedpluginInstanceURL

ProtectedpluginLocation

Protected ReadonlystateChanged

Protected ReadonlywindowService

Protected ReadonlyworkspaceService

Accessors

lastPluginLocation

Returns undefined | string

onStateChanged

Returns Event<HostedInstanceData>

Methods

debug

Parameters

Returns Promise<undefined | string>

ProtecteddoInit

Returns Promise<void>

ProtectedgetErrorMessage

Parameters

Returns string

Protectedinit

Returns void

ProtectedlaunchVSCode

Parameters

Returns Promise<LaunchVSCodeResult>

ProtectedopenPluginWindow

Returns Promise<void>

register

Parameters

Returns void

restart

Returns Promise<void>

selectPluginPath

Returns Promise<void>

start

Parameters

Returns Promise<void>

startDebugSessionManager

Returns Promise<void>

stop

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`debugSessionManager

`Protected` `Readonly`environments

`Protected` `Readonly`fileDialogService

`Protected` `Readonly`fileService

`Protected` `Readonly`hostedPluginPreferences

`Protected` `Readonly`hostedPluginServer

`Protected`hostedPluginSessionId

`Protected`hostedWindowId

`Protected`isDebug

`Protected` `Readonly`labelProvider

`Protected` `Readonly`messageService

`Protected`pluginInstanceURL

`Protected`pluginLocation

`Protected` `Readonly`stateChanged

`Protected` `Readonly`windowService

`Protected` `Readonly`workspaceService

`Protected`doInit

`Protected`getErrorMessage

`Protected`init

`Protected`launchVSCode

`Protected`openPluginWindow