Class HostedPluginSupport

Hierarchy (View Summary)

AbstractHostedPluginSupport<PluginManagerExt, RpcProxy<HostedPluginServer>>
- HostedPluginSupport

Index

Constructors

Accessors

Methods

acceptPlugin activateByCommand activateByCustomEditor activateByDebug activateByEvent activateByFileSystem activateByLanguage activateByNotebook activateByNotebookRenderer activateByNotebookSerializer activateByTaskType activateByTerminalProfile activateByUri activateByView activateByViewContainer activateByWorkspaceContains activatePlugin afterLoadContributions afterStart beforeLoadContributions beforeSyncPlugins createServerRpc createTheiaReadyPromise doLoad ensureCommandHandlerRegistration ensureDebugActivation ensureFileSystemActivation ensureTaskActivation getDeserializationFailedContents getHostGlobalStoragePath getPlugin getPluginCount getStoragePath handleContributions handlePluginStarted init initRpc loadContributions measure obtainManager onStart preserveWebview preserveWebviews registerWebviewReviver restoreWebview runOperation startPlugins syncPlugins unregisterWebviewReviver updateStoragePath

Constructors

constructor

new HostedPluginSupport(): HostedPluginSupport
Returns HostedPluginSupport
Overrides AbstractHostedPluginSupport.constructor
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:182

Properties

`Protected` `Readonly`activationEvents

activationEvents: Set<string> = ...

`Protected` `Readonly`applicationServer

applicationServer: ApplicationServer

`Protected` `Readonly`appState

appState: FrontendApplicationStateService

`Protected` `Readonly`clientId

clientId: string

`Protected` `Readonly`commands

commands: CommandRegistry

`Protected`container

container: Container

`Protected` `Readonly`contributionHandler

contributionHandler: PluginContributionHandler

`Protected` `Readonly`contributions

contributions: Map<`${string}.${string}`, PluginContributions> = ...

`Protected` `Readonly`customEditorRegistry

customEditorRegistry: PluginCustomEditorRegistry

`Protected` `Readonly`debugConfigurationManager

debugConfigurationManager: DebugConfigurationManager

`Protected` `Readonly`debugSessionManager

debugSessionManager: DebugSessionManager

`Protected` `Readonly`deferredDidStart

deferredDidStart: Deferred<void> = ...

`Protected` `Readonly`deferredWillStart

deferredWillStart: Deferred<void> = ...

`Protected` `Readonly`envServer

envServer: EnvVariablesServer

`Protected` `Readonly`fileSearchService

fileSearchService: FileSearchService

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Readonly`jsonSchemaStore

jsonSchemaStore: JsonSchemaStore

load

load: DebouncedFuncLeading<() => Promise<void>> = ...

`Protected`loadQueue

loadQueue: Promise<void> = ...

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`mainPluginApiProviders

mainPluginApiProviders: ContributionProvider<MainPluginApiProvider>

`Protected` `Readonly`managers

managers: Map<string, PluginManagerExt> = ...

`Protected` `Readonly`notebookRendererMessagingService

notebookRendererMessagingService: NotebookRendererMessagingService

`Protected` `Readonly`notebookService

notebookService: NotebookService

`Protected` `Readonly`notebookTypeRegistry

notebookTypeRegistry: NotebookTypeRegistry

`Readonly`onDidChangePlugins

onDidChangePlugins: Event<void> = ...

`Protected` `Readonly`onDidChangePluginsEmitter

onDidChangePluginsEmitter: Emitter<void> = ...

`Protected` `Readonly`pluginPathsService

pluginPathsService: PluginPathsService

`Protected` `Readonly`pluginServer

pluginServer: PluginServer

`Protected` `Readonly`preferenceProviderProvider

preferenceProviderProvider: PreferenceProviderProvider

`Protected` `Readonly`preferenceServiceImpl

preferenceServiceImpl: PreferenceServiceImpl

`Protected` `Readonly`progressService

progressService: ProgressService

`Protected` `Readonly`server

server: RpcProxy

`Protected` `Readonly`stopwatch

stopwatch: Stopwatch

`Protected` `Readonly`taskDefinitionRegistry

taskDefinitionRegistry: TaskDefinitionRegistry

`Protected` `Readonly`taskProviderRegistry

taskProviderRegistry: TaskProviderRegistry

`Protected` `Readonly`taskResolverRegistry

taskResolverRegistry: TaskResolverRegistry

`Protected` `Readonly`terminalService

terminalService: TerminalService

`Protected`theiaReadyPromise

theiaReadyPromise: Promise<unknown>

`Protected` `Readonly`viewRegistry

viewRegistry: PluginViewRegistry

`Protected` `Readonly`watcher

watcher: HostedPluginWatcher

`Protected` `Readonly`webviewEnvironment

webviewEnvironment: WebviewEnvironment

`Protected` `Readonly`webviewRevivers

webviewRevivers: Map<string, (webview: WebviewWidget) => Promise<void>> = ...

`Protected` `Readonly`webviewsToRestore

webviewsToRestore: Map<string, WebviewWidget> = ...

`Protected` `Readonly`widgets

widgets: WidgetManager

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

`Protected` `Static`ADDITIONAL_ACTIVATION_EVENTS_ENV

ADDITIONAL_ACTIVATION_EVENTS_ENV: string = 'ADDITIONAL_ACTIVATION_EVENTS'

`Protected` `Static`BUILTIN_ACTIVATION_EVENTS

BUILTIN_ACTIVATION_EVENTS: string[] = ...

Accessors

didStart

get didStart(): Promise<void>
Resolves when the initial plugins are started.

Returns Promise<void>
Inherited from AbstractHostedPluginSupport.didStart
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:102

plugins

get plugins(): PluginMetadata[]
Returns PluginMetadata[]
Inherited from AbstractHostedPluginSupport.plugins
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:115

willStart

get willStart(): Promise<void>
Resolves when the initial plugins are loaded and about to be started.

Returns Promise<void>
Inherited from AbstractHostedPluginSupport.willStart
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:94

Methods

`Protected`acceptPlugin

acceptPlugin(plugin: DeployedPlugin): boolean
Only load connection-scoped plugins
Parameters
- plugin: DeployedPlugin
Returns boolean
Overrides AbstractHostedPluginSupport.acceptPlugin
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:250

activateByCommand

activateByCommand(commandId: string): Promise<void>
Parameters
- commandId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:424

activateByCustomEditor

activateByCustomEditor(viewType: string): Promise<void>
Parameters
- viewType: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:432

activateByDebug

activateByDebug(
activationEvent?: DebugActivationEvent,
debugType?: string,
): Promise<void>
Parameters
- OptionalactivationEvent: DebugActivationEvent
- OptionaldebugType: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:507

activateByEvent

activateByEvent(activationEvent: string): Promise<void>
Parameters
- activationEvent: string
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.activateByEvent
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:412

activateByFileSystem

activateByFileSystem(event: FileSystemProviderActivationEvent): Promise<void>
Parameters
- event: FileSystemProviderActivationEvent
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:448

activateByLanguage

activateByLanguage(languageId: string): Promise<void>
Parameters
- languageId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:415

activateByNotebook

activateByNotebook(viewType: string): Promise<void>
Parameters
- viewType: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:436

activateByNotebookRenderer

activateByNotebookRenderer(rendererId: string): Promise<void>
Parameters
- rendererId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:444

activateByNotebookSerializer

activateByNotebookSerializer(viewType: string): Promise<void>
Parameters
- viewType: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:440

activateByTaskType

activateByTaskType(taskType: string): Promise<void>
Parameters
- taskType: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:428

activateByTerminalProfile

activateByTerminalProfile(profileId: string): Promise<void>
Parameters
- profileId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:452

activateByUri

activateByUri(scheme: string, authority: string): Promise<void>
Parameters
- scheme: string
- authority: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:420

activateByView

activateByView(viewId: string): Promise<void>
Parameters
- viewId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:411

activateByViewContainer

activateByViewContainer(viewContainerId: string): Promise<void>
Parameters
- viewContainerId: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:407

`Protected`activateByWorkspaceContains

activateByWorkspaceContains(
manager: PluginManagerExt,
plugin: DeployedPlugin,
): Promise<void>
Parameters
- manager: PluginManagerExt
- plugin: DeployedPlugin
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:518

activatePlugin

activatePlugin(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.activatePlugin
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:420

`Protected`createServerRpc

createServerRpc(pluginHostId: string): RPCProtocol
Parameters
- pluginHostId: string
Returns RPCProtocol
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:358

`Protected`createTheiaReadyPromise

createTheiaReadyPromise(): Promise<unknown>
Returns Promise<unknown>
Overrides AbstractHostedPluginSupport.createTheiaReadyPromise
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:236

`Protected`doLoad

doLoad(): Promise<void>
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.doLoad
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:150

`Protected`ensureCommandHandlerRegistration

ensureCommandHandlerRegistration(event: WillExecuteCommandEvent): void
Parameters
- event: WillExecuteCommandEvent
Returns void
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:465

`Protected`ensureDebugActivation

ensureDebugActivation(
    event: WaitUntilEvent,
    activationEvent?: DebugActivationEvent,
    debugType?: string,
): void
Parameters
- event: WaitUntilEvent
- OptionalactivationEvent: DebugActivationEvent
- OptionaldebugType: string
Returns void
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:503

`Protected`ensureFileSystemActivation

ensureFileSystemActivation(event: FileSystemProviderActivationEvent): void
Parameters
- event: FileSystemProviderActivationEvent
Returns void
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:456

`Protected`ensureTaskActivation

ensureTaskActivation(event: WillResolveTaskProvider): void
Parameters
- event: WillResolveTaskProvider
Returns void
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:487

`Protected`getDeserializationFailedContents

getDeserializationFailedContents(message: string): string
Parameters
- message: string
Returns string
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:624

`Protected`getHostGlobalStoragePath

getHostGlobalStoragePath(): Promise<string>
Returns Promise<string>
Overrides AbstractHostedPluginSupport.getHostGlobalStoragePath
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:392

getPlugin

getPlugin(id: `${string}.${string}`): undefined | DeployedPlugin
Parameters
- id: `${string}.${string}`
Returns undefined | DeployedPlugin
Inherited from AbstractHostedPluginSupport.getPlugin
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:121

`Protected`getPluginCount

getPluginCount(plugins: number): string
Parameters
- plugins: number
Returns string
Inherited from AbstractHostedPluginSupport.getPluginCount
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:436

`Protected`getStoragePath

getStoragePath(): Promise<undefined | string>
Returns Promise<undefined | string>
Overrides AbstractHostedPluginSupport.getStoragePath
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:387

`Protected`handleContributions

handleContributions(plugin: DeployedPlugin): Disposable
Parameters
- plugin: DeployedPlugin
Returns Disposable
Overrides AbstractHostedPluginSupport.handleContributions
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:274

`Protected`handlePluginStarted

handlePluginStarted(manager: PluginManagerExt, plugin: DeployedPlugin): void
Parameters
- manager: PluginManagerExt
- plugin: DeployedPlugin
Returns void
Overrides AbstractHostedPluginSupport.handlePluginStarted
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:278

`Protected`init

init(): void
Returns void
Overrides AbstractHostedPluginSupport.init
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:187

`Protected`initRpc

initRpc(host: string, pluginId: string): RPCProtocol
Parameters
- host: string
- pluginId: string
Returns RPCProtocol
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:351

`Protected`loadContributions

loadContributions(
toDisconnect: DisposableCollection,
): Map<string, PluginContributions[]>
Always synchronous in order to simplify handling disconnections.
Parameters
- toDisconnect: DisposableCollection
Returns Map<string, PluginContributions[]>
Throws
never
Inherited from AbstractHostedPluginSupport.loadContributions
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:289

`Protected`measure

measure(name: string): Measurement
Parameters
- name: string
Returns Measurement
Inherited from AbstractHostedPluginSupport.measure
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:432

`Protected`obtainManager

obtainManager(
    host: string,
    hostContributions: PluginContributions[],
    toDisconnect: DisposableCollection,
): Promise<undefined | PluginManagerExt>
Parameters
- host: string
- hostContributions: PluginContributions[]
- toDisconnect: DisposableCollection
Returns Promise<undefined | PluginManagerExt>
Overrides AbstractHostedPluginSupport.obtainManager
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:282

onStart

onStart(container: Container): void
do not call it, except from the plugin frontend contribution
Parameters
- container: Container
Returns void
Inherited from AbstractHostedPluginSupport.onStart
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:127

`Protected`preserveWebview

preserveWebview(webview: WebviewWidget): void
Parameters
- webview: WebviewWidget
Returns void
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:602

`Protected`preserveWebviews

preserveWebviews(): Promise<void>
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:589

registerWebviewReviver

registerWebviewReviver(
viewType: string,
reviver: (webview: WebviewWidget) => Promise<void>,
): void
Parameters
- viewType: string
- reviver: (webview: WebviewWidget) => Promise<void>
Returns void
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:574

`Protected`restoreWebview

restoreWebview(webview: WebviewWidget): Promise<void>
Parameters
- webview: WebviewWidget
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:610

`Protected`runOperation

runOperation(operation: () => Promise<void>): Promise<void>
Parameters
- operation: () => Promise<void>
Returns Promise<void>
Overrides AbstractHostedPluginSupport.runOperation
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:240

`Protected`startPlugins

startPlugins(
contributionsByHost: Map<string, PluginContributions[]>,
toDisconnect: DisposableCollection,
): Promise<void>
Parameters
- contributionsByHost: Map<string, PluginContributions[]>
- toDisconnect: DisposableCollection
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.startPlugins
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:332

`Protected`syncPlugins

syncPlugins(): Promise<void>
Sync loaded and deployed plugins:
- undeployed plugins are unloaded
- newly deployed plugins are initialized
Returns Promise<void>
Inherited from AbstractHostedPluginSupport.syncPlugins
- Defined in packages/plugin-ext/src/hosted/common/hosted-plugin.ts:202

unregisterWebviewReviver

unregisterWebviewReviver(viewType: string): void
Parameters
- viewType: string
Returns void
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:585

`Protected`updateStoragePath

updateStoragePath(): Promise<void>
Returns Promise<void>
- Defined in packages/plugin-ext/src/hosted/browser/hosted-plugin.ts:380

Class HostedPluginSupport

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns HostedPluginSupport

Properties

Protected ReadonlyactivationEvents

Protected ReadonlyapplicationServer

Protected ReadonlyappState

Protected ReadonlyclientId

Protected Readonlycommands

Protectedcontainer

Protected ReadonlycontributionHandler

Protected Readonlycontributions

Protected ReadonlycustomEditorRegistry

Protected ReadonlydebugConfigurationManager

Protected ReadonlydebugSessionManager

Protected ReadonlydeferredDidStart

Protected ReadonlydeferredWillStart

Protected ReadonlyenvServer

Protected ReadonlyfileSearchService

Protected ReadonlyfileService

Protected ReadonlyjsonSchemaStore

load

ProtectedloadQueue

Protected Readonlylogger

Protected ReadonlymainPluginApiProviders

Protected Readonlymanagers

Protected ReadonlynotebookRendererMessagingService

Protected ReadonlynotebookService

Protected ReadonlynotebookTypeRegistry

ReadonlyonDidChangePlugins

Protected ReadonlyonDidChangePluginsEmitter

Protected ReadonlypluginPathsService

Protected ReadonlypluginServer

Protected ReadonlypreferenceProviderProvider

Protected ReadonlypreferenceServiceImpl

Protected ReadonlyprogressService

Protected Readonlyserver

Protected Readonlystopwatch

Protected ReadonlytaskDefinitionRegistry

Protected ReadonlytaskProviderRegistry

Protected ReadonlytaskResolverRegistry

Protected ReadonlyterminalService

ProtectedtheiaReadyPromise

Protected ReadonlyviewRegistry

Protected Readonlywatcher

Protected ReadonlywebviewEnvironment

Protected ReadonlywebviewRevivers

Protected ReadonlywebviewsToRestore

Protected Readonlywidgets

Protected ReadonlyworkspaceService

Protected StaticADDITIONAL_ACTIVATION_EVENTS_ENV

Protected StaticBUILTIN_ACTIVATION_EVENTS

Accessors

didStart

Returns Promise<void>

plugins

Returns PluginMetadata[]

willStart

Returns Promise<void>

Methods

ProtectedacceptPlugin

Parameters

Returns boolean

activateByCommand

Parameters

Returns Promise<void>

activateByCustomEditor

Parameters

Returns Promise<void>

activateByDebug

Parameters

Returns Promise<void>

activateByEvent

`Protected` `Readonly`activationEvents

`Protected` `Readonly`applicationServer

`Protected` `Readonly`appState

`Protected` `Readonly`clientId

`Protected` `Readonly`commands

`Protected`container

`Protected` `Readonly`contributionHandler

`Protected` `Readonly`contributions

`Protected` `Readonly`customEditorRegistry

`Protected` `Readonly`debugConfigurationManager

`Protected` `Readonly`debugSessionManager

`Protected` `Readonly`deferredDidStart

`Protected` `Readonly`deferredWillStart

`Protected` `Readonly`envServer

`Protected` `Readonly`fileSearchService

`Protected` `Readonly`fileService

`Protected` `Readonly`jsonSchemaStore

`Protected`loadQueue

`Protected` `Readonly`logger

`Protected` `Readonly`mainPluginApiProviders

`Protected` `Readonly`managers

`Protected` `Readonly`notebookRendererMessagingService

`Protected` `Readonly`notebookService

`Protected` `Readonly`notebookTypeRegistry

`Readonly`onDidChangePlugins

`Protected` `Readonly`onDidChangePluginsEmitter

`Protected` `Readonly`pluginPathsService

`Protected` `Readonly`pluginServer

`Protected` `Readonly`preferenceProviderProvider

`Protected` `Readonly`preferenceServiceImpl

`Protected` `Readonly`progressService

`Protected` `Readonly`server

`Protected` `Readonly`stopwatch

`Protected` `Readonly`taskDefinitionRegistry

`Protected` `Readonly`taskProviderRegistry

`Protected` `Readonly`taskResolverRegistry

`Protected` `Readonly`terminalService

`Protected`theiaReadyPromise

`Protected` `Readonly`viewRegistry

`Protected` `Readonly`watcher

`Protected` `Readonly`webviewEnvironment

`Protected` `Readonly`webviewRevivers

`Protected` `Readonly`webviewsToRestore

`Protected` `Readonly`widgets

`Protected` `Readonly`workspaceService

`Protected` `Static`ADDITIONAL_ACTIVATION_EVENTS_ENV

`Protected` `Static`BUILTIN_ACTIVATION_EVENTS

`Protected`acceptPlugin

`Protected`activateByWorkspaceContains

`Protected`afterLoadContributions

`Protected`afterStart

`Protected`beforeLoadContributions

`Protected`beforeSyncPlugins

`Protected`createServerRpc

`Protected`createTheiaReadyPromise

`Protected`doLoad

`Protected`ensureCommandHandlerRegistration

`Protected`ensureDebugActivation

`Protected`ensureFileSystemActivation

`Protected`ensureTaskActivation

`Protected`getDeserializationFailedContents