Class HostedPluginController

Adds a status bar element displaying the state of secondary Theia instance with hosted plugin and allows controlling the instance by simple clicking on the status bar element.

Implements

FrontendApplicationContribution

Constructors

constructor

new HostedPluginController(): HostedPluginController
Returns HostedPluginController

Properties

`Protected` `Readonly`connectionStatusService

connectionStatusService: ConnectionStatusService

`Protected` `Readonly`frontendApplicationStateService

frontendApplicationStateService: FrontendApplicationStateService

`Protected` `Readonly`hostedPluginLogViewer

hostedPluginLogViewer: HostedPluginLogViewer

`Protected` `Readonly`hostedPluginManagerClient

hostedPluginManagerClient: HostedPluginManagerClient

`Protected` `Readonly`hostedPluginPreferences

hostedPluginPreferences: HostedPluginPreferences

`Protected` `Readonly`hostedPluginServer

hostedPluginServer: PluginDevServer

`Protected` `Readonly`messageService

messageService: MessageService

`Protected` `Readonly`preferenceService

preferenceService: PreferenceServiceImpl

`Protected` `Readonly`statusBar

statusBar: StatusBar

`Static` `Readonly`HOSTED_PLUGIN

HOSTED_PLUGIN: "hosted-plugin" = 'hosted-plugin'

`Static` `Readonly`HOSTED_PLUGIN_FAILED

HOSTED_PLUGIN_FAILED: "hosted-plugin-failed" = 'hosted-plugin-failed'

`Static` `Readonly`HOSTED_PLUGIN_OFFLINE

HOSTED_PLUGIN_OFFLINE: "hosted-plugin-offline" = 'hosted-plugin-offline'

Methods

`Protected`addCommandsForRunningPlugin

addCommandsForRunningPlugin(commands: CommandRegistry, menu: Menu): void
Adds commands to the menu for running plugin.
Parameters
- commands: CommandRegistry
- menu: Menu
Returns void
- Defined in plugin-dev/src/browser/hosted-plugin-controller.ts:305

`Protected`addCommandsForStoppedPlugin

addCommandsForStoppedPlugin(commands: CommandRegistry, menu: Menu): void
Adds command to the menu for stopped plugin.
Parameters
- commands: CommandRegistry
- menu: Menu
Returns void
- Defined in plugin-dev/src/browser/hosted-plugin-controller.ts:332

`Protected`handleWatchers

handleWatchers(event: HostedInstanceData): Promise<void>
Starts / stops watchers on hosted instance state change.
Parameters
- event: HostedInstanceData
  hosted instance state change event
Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-controller.ts:218

initialize

initialize(): void
Called on application startup before configure is called.

Returns void
Implementation of FrontendApplicationContribution.initialize
- Defined in plugin-dev/src/browser/hosted-plugin-controller.ts:74

`Protected`onHostedPluginFailed

onHostedPluginFailed(): Promise<void>
Display status bar element for failed plugin.

Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-controller.ts:177

`Protected`onHostedPluginRunning

onHostedPluginRunning(): Promise<void>
Display status bar element for running plugin.

Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-controller.ts:151

`Protected`onHostedPluginStarting

onHostedPluginStarting(): Promise<void>
Display status bar element for starting plugin.

Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-controller.ts:133

`Protected`onHostedPluginStopped

onHostedPluginStopped(): Promise<void>
Display status bar element for stopped plugin.

Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-controller.ts:114

`Protected`onPreferencesChanged

onPreferencesChanged(preference: PreferenceChange): Promise<void>
Parameters
- preference: PreferenceChange
Returns Promise<void>
- Defined in plugin-dev/src/browser/hosted-plugin-controller.ts:193

`Protected`showMenu

showMenu(x: number, y: number): void
Show menu containing actions to start/stop/restart hosted plugin.
Parameters
- x: number
- y: number
Returns void
- Defined in plugin-dev/src/browser/hosted-plugin-controller.ts:287

Class HostedPluginController

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns HostedPluginController

Properties

Protected ReadonlyconnectionStatusService

Protected ReadonlyfrontendApplicationStateService

Protected ReadonlyhostedPluginLogViewer

Protected ReadonlyhostedPluginManagerClient

Protected ReadonlyhostedPluginPreferences

Protected ReadonlyhostedPluginServer

Protected ReadonlymessageService

Protected ReadonlypreferenceService

Protected ReadonlystatusBar

Static ReadonlyHOSTED_PLUGIN

Static ReadonlyHOSTED_PLUGIN_FAILED

Static ReadonlyHOSTED_PLUGIN_OFFLINE

Methods

ProtectedaddCommandsForRunningPlugin

Parameters

Returns void

ProtectedaddCommandsForStoppedPlugin

Parameters

Returns void

ProtectedhandleWatchers

Parameters

Returns Promise<void>

initialize

Returns void

ProtectedonHostedPluginFailed

Returns Promise<void>

ProtectedonHostedPluginRunning

Returns Promise<void>

ProtectedonHostedPluginStarting

Returns Promise<void>

ProtectedonHostedPluginStopped

Returns Promise<void>

ProtectedonPreferencesChanged

Parameters

Returns Promise<void>

ProtectedshowMenu

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`connectionStatusService

`Protected` `Readonly`frontendApplicationStateService

`Protected` `Readonly`hostedPluginLogViewer

`Protected` `Readonly`hostedPluginManagerClient

`Protected` `Readonly`hostedPluginPreferences

`Protected` `Readonly`hostedPluginServer

`Protected` `Readonly`messageService

`Protected` `Readonly`preferenceService

`Protected` `Readonly`statusBar

`Static` `Readonly`HOSTED_PLUGIN

`Static` `Readonly`HOSTED_PLUGIN_FAILED

`Static` `Readonly`HOSTED_PLUGIN_OFFLINE

`Protected`addCommandsForRunningPlugin

`Protected`addCommandsForStoppedPlugin

`Protected`handleWatchers

`Protected`onHostedPluginFailed

`Protected`onHostedPluginRunning

`Protected`onHostedPluginStarting

`Protected`onHostedPluginStopped

`Protected`onPreferencesChanged

`Protected`showMenu