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`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:145

onStateChanged

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

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

`Protected`doInit

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

`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:367

`Protected`init

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

`Protected`launchVSCode

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

`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:321

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

restart

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

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

start

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

startDebugSessionManager

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

stop

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