### createGettingStartedPreferences Source: https://eclipse-theia.github.io/theia/docs/next/modules/_theia_getting-started.common_getting-started-preferences.html Creates and initializes the getting started preferences object. ```APIDOC ## Function: createGettingStartedPreferences ### Description This function creates an instance of the getting started preferences, potentially loading default values or configurations. ### Signature `createGettingStartedPreferences(config: any): any` ``` -------------------------------- ### start Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-mcp-server.node_mcp-theia-server-impl.MCPTheiaServerImpl.html Starts the MCP server with the given configuration. ```APIDOC ## start * start(): Promise ### Description Start the MCP server with the given configuration ### Returns Promise ``` -------------------------------- ### $start Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext-headless.plugin_headless-plugin-manager.HeadlessPluginManagerExtImpl.html Starts the plugin manager, loading and activating plugins. ```APIDOC ## $start * $start(params: PluginManagerStartParams): Promise load and activate plugins #### Parameters * params: PluginManagerStartParams #### Returns Promise ``` -------------------------------- ### $start Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_plugin-ext.common_plugin-api-rpc.PluginManagerExt.html Loads and activates plugins. This method accepts parameters related to the starting process and returns a Promise. ```APIDOC ## $start ### Description Loads and activates plugins. ### Method $start ### Parameters #### Path Parameters - **params** (PluginManagerStartParams) - Required - The parameters required for starting the plugin manager. ### Returns Promise ``` -------------------------------- ### install Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_vsx-registry.browser_vsx-extension.VSXExtensionComponent.html Installs the extension, optionally triggered by a mouse event. ```APIDOC ## install ### Description Installs the extension. ### Parameters * `event` (Optional: MouseEvent) ### Returns Promise ``` -------------------------------- ### start Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser_frontend-application.FrontendApplication.html Starts the frontend application. This process includes starting contributions, attaching the shell to the host element, initializing its layout, and revealing the shell if it was initially hidden. ```APIDOC ## start ### Description Starts the frontend application. This process includes starting contributions, attaching the shell to the host element, initializing its layout, and revealing the shell if it was initially hidden. ### Method start() ### Returns Promise ``` -------------------------------- ### bindGettingStartedPreferences Source: https://eclipse-theia.github.io/theia/docs/next/functions/_theia_getting-started.common_getting-started-preferences.bindGettingStartedPreferences.html Binds the getting started preferences. This function takes a Bind object and returns void. ```APIDOC ## Function bindGettingStartedPreferences ### Description Binds the getting started preferences. ### Signature bindGettingStartedPreferences(bind: Bind): void ### Parameters #### bind - **bind** (Bind) - Description of the bind parameter. ``` -------------------------------- ### start Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.main_node_plugin-deployer-impl.PluginDeployerImpl.html Starts the plugin deployment process. This method initiates the necessary services and configurations for plugin operations. ```APIDOC ## start ### Description Starts the plugin deployment process. ### Method start() ### Returns Promise ``` -------------------------------- ### createGettingStartedPreferences Source: https://eclipse-theia.github.io/theia/docs/next/functions/_theia_getting-started.common_getting-started-preferences.createGettingStartedPreferences.html Creates and returns the preferences for the getting started experience. It allows customization through an optional schema. ```APIDOC ## Function createGettingStartedPreferences ### Description Creates and returns the preferences for the getting started experience. It allows customization through an optional schema. ### Signature createGettingStartedPreferences(preferences: PreferenceService, schema?: PreferenceSchema): GettingStartedPreferences ### Parameters #### Required Parameters - **preferences** (PreferenceService) - The preference service instance to use for managing preferences. #### Optional Parameters - **schema** (PreferenceSchema) - An optional schema to define the structure and validation rules for the getting started preferences. Defaults to `GettingStartedPreferenceSchema`. ### Returns - **GettingStartedPreferences** - An object containing the getting started preferences. ``` -------------------------------- ### $start Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_plugin-ext-headless.common_headless-plugin-protocol.PluginManagerExt.html Loads and activates plugins. ```APIDOC ## $start ### Description Loads and activates plugins. ### Method $start ### Parameters #### Path Parameters - **params** (PluginManagerStartParams) - Required - Parameters for starting the plugin manager. ### Returns Promise ``` -------------------------------- ### bindGettingStartedPreferences Source: https://eclipse-theia.github.io/theia/docs/next/modules/_theia_getting-started.common_getting-started-preferences.html Binds the getting started preferences to the application's dependency injection container. ```APIDOC ## Function: bindGettingStartedPreferences ### Description This function is responsible for binding the necessary services and configurations related to getting started preferences into the Theia application's dependency injection system. ### Signature `bindGettingStartedPreferences(app: any): void` ``` -------------------------------- ### install Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_vsx-registry.browser_vsx-extension.AbstractVSXExtensionComponent.html Installs the extension, potentially triggered by a mouse event. ```APIDOC ## install ### Description Installs the extension, potentially triggered by a mouse event. ### Method `Readonly`install(event?: MouseEvent): Promise ### Parameters * `Optional`event (MouseEvent) - The mouse event that triggered the installation. ### Returns Promise ``` -------------------------------- ### GettingStartedPreferences Source: https://eclipse-theia.github.io/theia/docs/next/modules/_theia_getting-started.common_getting-started-preferences.html Represents the preferences object for the getting started feature. ```APIDOC ## Variable: GettingStartedPreferences ### Description This variable holds the preferences object that configures the getting started experience. ### Type `GettingStartedPreferences` ``` -------------------------------- ### start Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_debug.node_debug-adapter-factory.LaunchBasedDebugAdapterFactory.html Starts a debug adapter using the provided executable configuration. ```APIDOC ## start * start(executable: DebugAdapterExecutable): DebugAdapter ### Parameters * executable: DebugAdapterExecutable - The configuration for the debug adapter executable. ### Returns DebugAdapter - The started debug adapter. ``` -------------------------------- ### GettingStartedPreferenceContribution Source: https://eclipse-theia.github.io/theia/docs/next/modules/_theia_getting-started.common_getting-started-preferences.html A contribution point for defining getting started preferences. ```APIDOC ## Variable: GettingStartedPreferenceContribution ### Description Provides a contribution point for defining preferences related to the getting started experience in Theia. ### Type `GettingStartedPreferenceContribution` ``` -------------------------------- ### GettingStartedCommand Source: https://eclipse-theia.github.io/theia/docs/next/variables/_theia_getting-started.browser_getting-started-contribution.GettingStartedCommand.html The GettingStartedCommand is a constant object that defines the properties for triggering the Getting Started Widget. It includes an `id` and a `label`. ```APIDOC ## GettingStartedCommand ### Description Triggers opening the `GettingStartedWidget`. ### Type Declaration * ##### id: string * ##### label: string ### Usage Example ```typescript import { GettingStartedCommand } from '@theia/getting-started/lib/browser/getting-started-contribution'; // Accessing command properties console.log(GettingStartedCommand.id); // e.g., 'getting-started.command' console.log(GettingStartedCommand.label); // e.g., 'Getting Started' ``` ``` -------------------------------- ### start Method Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.common_performance_measurement-protocol.NullBackendStopwatch.html Starts a measurement. This is a no-op implementation. ```APIDOC ## start * start(): Promise Create a Measurement that will compute the time that elapsed on the back-end when logged. #### Returns Promise a token identifying an unique self-timing measurement relative to the back-end's timeline ``` -------------------------------- ### start Method Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_debug.common_debug-model.DebugAdapterSession.html Starts the debug adapter session with the given debug channel. ```APIDOC ## Method: start ### Description Starts the debug adapter session. ### Parameters - **channel** (DebugChannel) - Description: The debug channel to use for communication. ### Returns - Promise ``` -------------------------------- ### start Function Source: https://eclipse-theia.github.io/theia/docs/next/functions/_theia_core.node_main.start.html The start function initiates a server module and returns its address information. ```APIDOC ## start Function ### Description Starts a server module and returns its address information. ### Signature start(serverModule: MaybePromise>): Promise ### Parameters #### serverModule - **serverModule** (MaybePromise>): A promise or a server instance to be started. ``` -------------------------------- ### start Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_debug_plugin-debug-adapter-session.PluginDebugAdapterSession.html Starts the debug session with a given channel. ```APIDOC ## start * start(channel: DebugChannel): Promise #### Parameters * channel: DebugChannel #### Returns Promise ``` -------------------------------- ### start Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_terminal.browser_base_terminal-widget.TerminalWidget.html Start terminal and return terminal id. ```APIDOC ## start ### Description Start terminal and return terminal id. ### Method `start(id?: number): Promise` ### Parameters #### Path Parameters - **id** (number) - Optional - terminal id. ``` -------------------------------- ### startServer Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_ai-mcp.common_mcp-server-manager.MCPFrontendService.html Starts a specified MCP server. ```APIDOC ## startServer ### Description Starts a specified MCP server. ### Method startServer ### Parameters #### Path Parameters - **serverName** (string) - Required - The name of the MCP server to start. ### Returns Promise ``` -------------------------------- ### startPlugins Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.hosted_browser_hosted-plugin.HostedPluginSupport.html Starts all loaded plugins. ```APIDOC ## startPlugins * startPlugins(): Promise ``` -------------------------------- ### start Method Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.common_performance_measurement-protocol.DefaultBackendStopwatch.html Starts a new measurement with the given name and optional options. Returns a unique token for the measurement. ```APIDOC ## start * start(name: string, options?: MeasurementOptions): number ### Parameters * name: string - The name of the measurement. * `Optional`options: MeasurementOptions - Additional options for the measurement. ### Returns number - A unique token representing the started measurement. ``` -------------------------------- ### startServer Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-mcp.browser_mcp-frontend-service.MCPFrontendServiceImpl.html Starts an MCP server by its name. ```APIDOC ## startServer ### Description Starts an MCP server by its name. ### Method startServer ### Parameters #### Path Parameters - **serverName** (string) - Required - The name of the server to start. ### Returns Promise ``` -------------------------------- ### setup Method Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_remote.electron-node_setup_remote-setup-service.RemoteSetupService.html Sets up the remote environment based on the provided options. ```APIDOC ## setup * setup(options: RemoteSetupOptions): Promise #### Parameters * options: RemoteSetupOptions #### Returns Promise ``` -------------------------------- ### GettingStartedPreferenceSchema Source: https://eclipse-theia.github.io/theia/docs/next/modules/_theia_getting-started.common_getting-started-preferences.html Defines the schema for getting started preferences. ```APIDOC ## Variable: GettingStartedPreferenceSchema ### Description Defines the JSON schema for validating and structuring the getting started preferences. ### Type `GettingStartedPreferenceSchema` ``` -------------------------------- ### Range Accessors Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_types-impl.Range.html Accessors to get the start and end positions, and to check if the range is empty or single-lined. ```APIDOC ## Accessors ### end * get end(): Position #### Returns Position ### isEmpty * get isEmpty(): boolean #### Returns boolean ### isSingleLine * get isSingleLine(): boolean #### Returns boolean ### start * get start(): Position #### Returns Position ``` -------------------------------- ### listen Method Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser-only_messaging_frontend-only-service-connection-provider.FrontendOnlyServiceConnectionProvider.html Installs a connection handler for a given path. ```APIDOC ## listen * listen(path: string, handler: ServiceConnectionProvider.ConnectionHandler, reconnect: boolean): void ### Parameters * path: string * handler: ServiceConnectionProvider.ConnectionHandler * reconnect: boolean ### Returns void ``` -------------------------------- ### onStart Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.hosted_common_hosted-plugin.AbstractHostedPluginSupport.html Initiates the plugin's startup sequence. This method should not be called directly except from the plugin frontend contribution. ```APIDOC ## onStart ### Description Initiates the plugin's startup sequence. Do not call this method directly, except from the plugin frontend contribution. ### Signature `onStart(container: Container): void` ### Parameters #### Path Parameters - **container** (`Container`) - The container providing plugin context. ``` -------------------------------- ### GettingStartedPreferences Type Alias Source: https://eclipse-theia.github.io/theia/docs/next/types/_theia_getting-started.common_getting-started-preferences.GettingStartedPreferences.html The GettingStartedPreferences type is an alias for PreferenceProxy, used for managing getting started preferences. ```APIDOC ## Type Alias: GettingStartedPreferences ### Description `GettingStartedPreferences` is a type alias representing a proxy for managing `GettingStartedConfiguration` preferences. It allows for dynamic access and modification of these settings. ### Type Definition ```typescript GettingStartedPreferences: PreferenceProxy ``` ### Usage This type is typically used within the Theia framework to access and manipulate user-specific or workspace-specific configuration related to the getting started experience. ``` -------------------------------- ### QuickOpenMainImpl Constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.main_browser_quick-open-main.QuickOpenMainImpl.html Initializes a new instance of the QuickOpenMainImpl class. ```APIDOC ## constructor * new QuickOpenMainImpl(rpc: RPCProtocol, container: Container): QuickOpenMainImpl #### Parameters * rpc: RPCProtocol * container: Container #### Returns QuickOpenMainImpl ``` -------------------------------- ### PreferencesProps Interface Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_getting-started.browser_getting-started-widget.PreferencesProps.html The PreferencesProps interface defines the properties required for the getting started widget, primarily including the PreferenceService. ```APIDOC ## Interface PreferencesProps interface PreferencesProps { preferenceService: PreferenceService; } ### Properties #### preferenceService preferenceService: PreferenceService ``` -------------------------------- ### initialize Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.electron-browser_electron-uri-handler.ElectronUriHandlerContribution.html Called on application startup before configure is called. ```APIDOC ## initialize * initialize(): void ### Description Called on application startup before configure is called. ### Returns void ``` -------------------------------- ### Get Monaco InstantiationService with Overrides Source: https://eclipse-theia.github.io/theia/docs/next/documents/Migration.html For services specific to a particular instantiation, pass them to a child of the global `IInstantiationService`. See `MonacoEditor.getInstantiationWithOverrides` for an example. ```typescript import { MonacoEditor } from '@theia/monaco-editor-core'; import { IInstantiationService } from '@theia/core/lib/common/services'; // ... const instantiationService = MonacoEditor.getInstantiationWithOverrides(parentInstantiationService, { [IConfigurationService.toString()]: new MyConfigurationServiceOverride() }); ``` -------------------------------- ### install Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_plugin-ext-headless.common_headless-plugin-protocol.PluginServer.html Deploys a plugin. Optionally specify the type and deployment options. ```APIDOC ## install ### Description Deploys a plugin. Optionally specify the type and deployment options. ### Method `install` ### Parameters #### Path Parameters - **pluginEntry** (string) - Required - The entry point for the plugin. - **type** (PluginType) - Optional - Specifies whether the plugin is installed by the system or a user. Defaults to user. - **options** (PluginDeployOptions) - Optional - Additional deployment options for the plugin. ### Returns Promise ``` -------------------------------- ### Example Selection Range Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_editor.browser_editor.Selection.html Illustrates how to define a selection range that includes a line ending character. The end position denotes the start of the next line. ```typescript { start: { line: 5, character: 23 } end : { line 6, character : 0 } } ``` -------------------------------- ### Create a TerminalCompletionItem Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin.theia.TerminalCompletionItem.html Example of creating a completion item for a terminal command. The `replacementRange` specifies the start and end indices of the text to be replaced in the command line. ```typescript const item = { label: '-A', replacementRange: [3, 4], // replace the single character at index 3 detail: 'List all entries except for . and .. (always set for the super-user)', kind: TerminalCompletionItemKind.Flag }; ``` -------------------------------- ### Get WSL Distributions Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_remote-wsl.electron-node_remote-wsl-connection-provider.RemoteWslConnectionProviderImpl.html Retrieves a list of all available WSL distributions installed on the system. It executes `wsl.exe --list` and parses the output to determine the name, default status, and version of each distribution. ```typescript getWslDistributions(): Promise ``` -------------------------------- ### configure Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-mcp-server.node_mcp-theia-server-impl.MCPTheiaServerImpl.html 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. ```APIDOC ## configure * configure?(app: Application): Promise ### Description 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 #### Path Parameters * **app** (Application) - the express application to configure. ### Returns Promise - either `undefined` or a Promise resolving to `undefined`. ``` -------------------------------- ### Editor Guides Settings Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_editor.common_editor-preferences.EditorConfiguration.html Configuration options for visual guides within the editor, such as bracket pair guides and indentation guides. ```APIDOC ## editor.guides.bracketPairs ### Description Enables or configures bracket pair guides. ### Type boolean | "active" ## editor.guides.bracketPairsHorizontal ### Description Enables or configures horizontal bracket pair guides. ### Type boolean | "active" ## editor.guides.highlightActiveBracketPair ### Description Enables highlighting for the active bracket pair. ### Type boolean ## editor.guides.highlightActiveIndentation ### Description Enables highlighting for the active indentation. ### Type boolean | "always" ## editor.guides.indentation ### Description Enables indentation guides. ### Type boolean ``` -------------------------------- ### onStart Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.hosted_browser_hosted-plugin.HostedPluginSupport.html Callback function executed when the plugin host starts. ```APIDOC ## onStart * onStart(): Promise ``` -------------------------------- ### onStart Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-google.browser_google-frontend-application-contribution.GoogleFrontendApplicationContribution.html Called when the application starts. The application shell is not attached yet. ```APIDOC ## onStart * onStart(): void ### Returns void ``` -------------------------------- ### get Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser_dialogs.DialogOverlayService.html Gets the singleton instance of DialogOverlayService. ```APIDOC ## get * get(): DialogOverlayService #### Returns DialogOverlayService ``` -------------------------------- ### initialize Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_core.browser_frontend-application-contribution.FrontendApplicationContribution.html Optional method called on application startup before the configure method. Returns a promise if asynchronous. ```APIDOC ## `Optional`initialize * initialize?(): MaybePromise Called on application startup before configure is called. #### Returns MaybePromise ``` -------------------------------- ### onStart Method Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-ide.browser_implement-gh-ticket-command-contribution.FixGitHubTicketCommandContribution.html Called when the application is started. This method can be used for asynchronous initialization tasks. ```APIDOC ## onStart * onStart(): void Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously. #### Returns void ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser_quick-input_quick-command-frontend-contribution.QuickCommandFrontendContribution.html Initializes a new instance of the QuickCommandFrontendContribution class. ```APIDOC ## constructor * new QuickCommandFrontendContribution(): QuickCommandFrontendContribution ### Returns QuickCommandFrontendContribution ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.main_browser_webview_webview-secondary-window-support.WebviewSecondaryWindowSupport.html Initializes a new instance of WebviewSecondaryWindowSupport. ```APIDOC ## constructor * new WebviewSecondaryWindowSupport(): WebviewSecondaryWindowSupport #### Returns WebviewSecondaryWindowSupport ``` -------------------------------- ### onStart Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-core.browser_frontend-variable-service.DefaultFrontendVariableService.html Called when the application is started. Should return a promise if it runs asynchronously. ```APIDOC ## onStart ### Description Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously. ### Method Signature onStart(): void ### Returns Void. Returns a promise if the operation is asynchronous. ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.main_browser_file-system-main-impl.FileSystemMainImpl.html Initializes a new instance of the FileSystemMainImpl class. ```APIDOC ## constructor * new FileSystemMainImpl( rpc: RPCProtocol, container: Container, ): FileSystemMainImpl #### Parameters * rpc: RPCProtocol * container: Container #### Returns FileSystemMainImpl ``` -------------------------------- ### onStart Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-anthropic.browser_anthropic-frontend-application-contribution.AnthropicFrontendApplicationContribution.html Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously. ```APIDOC ## onStart * onStart(): void Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously. #### Returns void ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser_quick-input_quick-input-frontend-contribution.QuickInputFrontendContribution.html Initializes a new instance of the QuickInputFrontendContribution class. ```APIDOC ## constructor * new QuickInputFrontendContribution(): QuickInputFrontendContribution #### Returns QuickInputFrontendContribution ``` -------------------------------- ### onStart Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.common_command.CommandRegistry.html Lifecycle hook called when the command registry starts. ```APIDOC ## onStart ### Description Lifecycle hook called when the command registry starts. ### Method `onStart(): void` ### Returns `void` ``` -------------------------------- ### VsxCliDeployerParticipant.onWillStart Method Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_vsx-registry.node_vsx-cli-deployer-participant.VsxCliDeployerParticipant.html This method is called before the plugin deployer starts, allowing for pre-deployment actions. ```APIDOC ## onWillStart ### Description Called before the plugin deployer starts. This method can be used to perform actions prior to the deployment process. ### Signature ```typescript onWillStart(context: PluginDeployerStartContext): Promise ``` ### Parameters #### context - **context** (PluginDeployerStartContext) - Required - The context object for the plugin deployer start event. ### Returns A promise that resolves when the operation is complete. ``` -------------------------------- ### Constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser_window_default-window-service.DefaultWindowService.html Initializes a new instance of the DefaultWindowService. ```APIDOC ## constructor * new DefaultWindowService(): DefaultWindowService ### Returns DefaultWindowService ``` -------------------------------- ### Disable Plugin Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.hosted_node_plugin-deployer-handler-impl.PluginDeployerHandlerImpl.html Marks a plugin as disabled. The plugin remains installed but will not be used. Has no effect if the plugin is not installed. ```APIDOC ## disablePlugin ### Description Marks the given plugin as disabled. While the plugin remains installed, it will no longer be used. Has no effect if the plugin is not installed. ### Method DELETE ### Endpoint /plugins/{pluginId}/disable ### Parameters #### Path Parameters - **pluginId** (`${string}.${string}`) - Required - The unique identifier of the plugin to disable. ### Response #### Success Response (200) - **boolean** - Whether the plugin was installed, enabled, and successfully disabled. ``` -------------------------------- ### doInit Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_preferences.common_abstract-resource-preference-provider.AbstractResourcePreferenceProvider.html Protected method to initialize the preference provider. Subclasses should implement this. ```APIDOC ## `Protected`doInit * doInit(): Promise #### Returns Promise ``` -------------------------------- ### init Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.hosted_browser_hosted-plugin.HostedPluginSupport.html Initializes the HostedPluginSupport. ```APIDOC ## init * init(): Promise ``` -------------------------------- ### Developer Certificate of Origin Example Source: https://eclipse-theia.github.io/theia/docs/next/media/CONTRIBUTING.md An example of the 'Signed-off-by' line required in git commit messages for contributions. ```git Signed-off-by: Joe Smith ``` -------------------------------- ### Get ARIA Label for Keybinding Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_monaco.monaco-resolved-keybinding.MonacoResolvedKeybinding.html Use this method to get a string representation of the keybinding suitable for ARIA attributes. ```typescript getAriaLabel(): null | string ``` -------------------------------- ### setupPluginHostLogger Source: https://eclipse-theia.github.io/theia/docs/next/functions/_theia_plugin-ext.hosted_node_plugin-host-logger.setupPluginHostLogger.html Sets up the plugin host logger by providing an RPCProtocol instance. ```APIDOC ## Function setupPluginHostLogger * setupPluginHostLogger(rpc: RPCProtocol): void #### Parameters * rpc: RPCProtocol #### Returns void ``` -------------------------------- ### FileDownloadHandler.prepareDownload Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_filesystem.node_download_file-download-handler.FileDownloadHandler.html Prepares the file and the link for download, setting up necessary configurations before the download begins. ```APIDOC ## prepareDownload * prepareDownload( request: Request, response: Response, options: PrepareDownloadOptions, ): Promise Prepares the file and the link for download #### Parameters * request: Request * response: Response * options: PrepareDownloadOptions #### Returns Promise ``` -------------------------------- ### Custom Sanitizer Example Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_core.common_logger-sanitizer.LoggerSanitizer.html Example of how to extend the DefaultLoggerSanitizer to implement custom sanitization logic, such as masking API keys. ```APIDOC #### Example ```typescript // Custom sanitizer that extends the default behavior @injectable() class CustomLoggerSanitizer extends DefaultLoggerSanitizer { override sanitize(message: string): string { let sanitized = super.sanitize(message); // Add custom sanitization, e.g., mask API keys sanitized = sanitized.replace(/api[_-]?key[=:]\s*['"]?[\w-]+['"]?/gi, 'api_key=****'); return sanitized; } } // In your module: rebind(LoggerSanitizer).to(CustomLoggerSanitizer).inSingletonScope(); ``` ``` -------------------------------- ### Constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.hosted_common_hosted-plugin.AbstractHostedPluginSupport.html Initializes a new instance of AbstractHostedPluginSupport. ```APIDOC ## constructor * new AbstractHostedPluginSupport< PM extends AbstractPluginManagerExt, HPS extends HostedPluginServer | RpcProxy, >( clientId: string, ): AbstractHostedPluginSupport #### Type Parameters * PM extends AbstractPluginManagerExt * HPS extends HostedPluginServer | RpcProxy #### Parameters * clientId: string #### Returns AbstractHostedPluginSupport ``` -------------------------------- ### watchFileChanges Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_filesystem.node_filesystem-watcher-client.FileSystemWatcherServerClient.html Starts file watching for a given URI with optional options. The promise resolves when watching starts and returns a watcher ID. ```APIDOC ## watchFileChanges * watchFileChanges(uri: string, options?: WatchOptions): Promise ### Description Start file watching for the given param. Resolve when watching is started. Return a watcher id. ### Parameters * uri: string * `Optional`options: WatchOptions ### Returns Promise ``` -------------------------------- ### ensureEntry Method Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.common_performance_stopwatch.MeasurementContext.html Ensures that settlement tracking has been started for a given contribution. It starts the per-contribution measurement clock on the first call for each contribution. ```APIDOC ## ensureEntry * ensureEntry(item: T): void Ensure that settlement tracking has been started for the given contribution. Starts the per-contribution measurement clock on the first call for each contribution. #### Parameters * item: T #### Returns void ``` -------------------------------- ### NotebookClipboardService Constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_notebook.browser_service_notebook-clipboard-service.NotebookClipboardService.html Initializes a new instance of the NotebookClipboardService. ```APIDOC ## constructor * new NotebookClipboardService(): NotebookClipboardService #### Returns NotebookClipboardService ``` -------------------------------- ### Get String Representation of Array Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_core.common_array-utils.ArrayUtils.Children.html Use `toString` to get a string representation of the array's elements. This is useful for debugging or display purposes. ```typescript array.toString() ``` -------------------------------- ### configure Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser_common-frontend-contribution.CommonFrontendContribution.html Called before commands, key bindings and menus are initialized. Should return a promise if it runs asynchronously. ```APIDOC ## configure ### Description Called before commands, key bindings and menus are initialized. Should return a promise if it runs asynchronously. ### Parameters #### Parameters - **app** (FrontendApplication) - Description: The frontend application instance. ### Returns Promise ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.main_browser_notebooks_notebooks-main.NotebooksMainImpl.html Initializes a new instance of the NotebooksMainImpl class. ```APIDOC ## constructor * new NotebooksMainImpl( rpc: RPCProtocol, container: Container, commands: CommandRegistryMain, ): NotebooksMainImpl #### Parameters * rpc: RPCProtocol * container: Container * commands: CommandRegistryMain #### Returns NotebooksMainImpl ``` -------------------------------- ### Example Tree Decorator Implementation Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_navigator.browser_navigator-symlink-decorator.NavigatorSymlinkDecorator.html Demonstrates how to implement a custom TreeDecorator to change the background color of tree nodes. This example sets the background color to 'red' for all nodes. ```typescript import { injectable, inject, optional, postConstruct, decorate, LazyServiceIdentifiable, Container, interfaces, multiInject, tagged } from '@theia/core/lib/common/di'; import { Emitter, Event } from '@theia/core/lib/common/event'; import { Tree, TreeEvent, TreeNode, TreeIterator, DepthFirstTreeIterator, TreeProps, TreeSelectionService, TreeSelectionService } from '@theia/core/lib/browser/tree/'; import { Widget } from '@phosphor/widgets'; import { MaybePromise } from '@theia/core/lib/common/maybe-promise'; import { WidgetDecoration } from '@theia/core/lib/browser/widgets/decorations'; export const TreeDecorator = Symbol('TreeDecorator'); export interface TreeDecorator { readonly id: string; readonly onDidChangeDecorations: Event<(tree: Tree) => Map>; decorations(tree: Tree): MaybePromise>; } export namespace TreeDecoration { export interface Data extends WidgetDecoration.Data { backgroundColor?: string; color?: string; description?: string; icon?: string; extraClasses?: string[]; } } @injectable() export class MyTreeDecorator implements TreeDecorator { id = 'myTreeDecorator'; protected readonly emitter = new Emitter<(tree: Tree) => Map>(); get onDidChangeDecorations(): Event<(tree: Tree) => Map> { return this.emitter.event; } decorations(tree: Tree): MaybePromise> { const result = new Map(); if (tree.root === undefined) { return result; } for (const treeNode of new DepthFirstTreeIterator(tree.root)) { result.set(treeNode.id,{backgroundColor:'red'}) } return result; } } ``` -------------------------------- ### Example Usage of ChatContentDeserializer Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_ai-chat.common_chat-content-deserializer.ChatContentDeserializer.html This example demonstrates how to create a concrete implementation of ChatContentDeserializer for text content. It defines the 'kind' as 'text' and provides a 'deserialize' function that constructs a TextChatResponseContentImpl object. ```APIDOC const textDeserializer: ChatContentDeserializer = { kind: 'text', deserialize: (data) => new TextChatResponseContentImpl(data.content) }; ``` -------------------------------- ### Custom Tree Decorator Example Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_filesystem.browser_file-tree_file-tree-decorator-adapter.FileTreeDecoratorAdapter.html Implement a custom tree decorator to change the background color of tree nodes. This example demonstrates how to set a static background color for all nodes. ```typescript import { injectable, inject } from '@theia/core/lib/common/di'; import { Emitter, Event } from '@theia/core/lib/common/event'; import { Tree, TreeDecorator, TreeDecoration } from '@theia/core/lib/browser/tree/tree-decorator'; import { MaybePromise } from '@theia/core/lib/common/types'; import { DepthFirstTreeIterator } from '@theia/core/lib/browser/tree/tree-iterator'; @injectable() export class MyTreeDecorator implements TreeDecorator { id = 'myTreeDecorator'; protected readonly emitter = new Emitter<(tree: Tree) => Map>(); get onDidChangeDecorations(): Event<(tree: Tree) => Map> { return this.emitter.event; } decorations(tree: Tree): MaybePromise> { const result = new Map(); if (tree.root === undefined) { return result; } for (const treeNode of new DepthFirstTreeIterator(tree.root)) { result.set(treeNode.id,{backgroundColor:'red'}) } return result; } } ``` -------------------------------- ### startDebugging Source: https://eclipse-theia.github.io/theia/docs/next/functions/_theia_plugin.theia.debug.startDebugging.html Starts a debugging session. It can use named configurations from '.vscode/launch.json' or a provided DebugConfiguration object. Unsaved files are saved, and configurations are updated before starting. Variables like '${workspaceFolder}' are resolved against the provided folder. ```APIDOC ## Function startDebugging * startDebugging( folder: undefined | WorkspaceFolder, nameOrConfiguration: string | DebugConfiguration, parentSessionOrOptions?: DebugSession | DebugSessionOptions, ): Thenable Start debugging by using either a named launch or named compound configuration, or by directly passing a DebugConfiguration. The named configurations are looked up in '.vscode/launch.json' found in the given folder. Before debugging starts, all unsaved files are saved and the launch configurations are brought up-to-date. Folder specific variables used in the configuration (e.g. '${workspaceFolder}') are resolved against the given folder. #### Parameters * folder: undefined | WorkspaceFolder The workspace folder for looking up named configurations and resolving variables or `undefined` for a non-folder setup. * nameOrConfiguration: string | DebugConfiguration Either the name of a debug or compound configuration or a DebugConfiguration object. * `Optional`parentSessionOrOptions: DebugSession | DebugSessionOptions Debug session options. When passed a parent debug session, assumes options with just this parent session. #### Returns Thenable A thenable that resolves when debugging could be successfully started. ``` -------------------------------- ### initialize Method Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser_frontend-application-contribution.DefaultFrontendApplicationContribution.html Called on application startup before the configure method is invoked. ```APIDOC ## initialize * initialize(): MaybePromise ### Description This method is called during the application startup sequence, prior to the `configure` method. It's intended for initialization tasks that need to be performed early in the frontend application's lifecycle. ### Returns - `MaybePromise`: A promise that resolves when the initialization is complete, or void if the operation is synchronous. ``` -------------------------------- ### Custom Tree Decorator Example Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_editor-preview.browser_editor-preview-tree-decorator.EditorPreviewTreeDecorator.html Implement a custom tree decorator to change the background color of tree nodes. This example demonstrates how to create a decorator that sets the background color of all tree nodes to red. ```typescript import { injectable, inject } from '@theia/core/lib/common/di'; import { Emitter, Event } from '@theia/core/lib/common/event'; import { MaybePromise } from '@theia/core/lib/common/types'; import { Tree, TreeDecorator, TreeDecoration } from '@theia/core/lib/browser/tree/tree-decorator'; import { DepthFirstTreeIterator } from '@theia/core/lib/browser/tree/tree-iterator'; @injectable() export class MyTreeDecorator implements TreeDecorator { id = 'myTreeDecorator'; protected readonly emitter = new Emitter<(tree: Tree) => Map>(); get onDidChangeDecorations(): Event<(tree: Tree) => Map> { return this.emitter.event; } decorations(tree: Tree): MaybePromise> { const result = new Map(); if (tree.root === undefined) { return result; } for (const treeNode of new DepthFirstTreeIterator(tree.root)) { result.set(treeNode.id,{backgroundColor:'red'}) } return result; } } ``` -------------------------------- ### owner Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.main_browser_comments_comment-thread-widget.CommentThreadWidget.html Gets the owner of the widget. ```APIDOC ## owner ### Description Get the owner of the widget. ### Getter * get owner(): string ### Returns string ``` -------------------------------- ### initialize Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext-headless.hosted_node_plugin-host-headless-rpc.HeadlessPluginHostRPC.html Initializes the HeadlessPluginHostRPC. ```APIDOC ## initialize * initialize(): void ### Returns void ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_debug.node_debug-adapter-factory.LaunchBasedDebugAdapterFactory.html Initializes a new instance of the LaunchBasedDebugAdapterFactory class. ```APIDOC ## constructor * new LaunchBasedDebugAdapterFactory(): LaunchBasedDebugAdapterFactory ### Returns LaunchBasedDebugAdapterFactory ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-mcp-server.node_mcp-theia-server-impl.MCPTheiaServerImpl.html Initializes a new instance of the MCPTheiaServerImpl class. ```APIDOC ## constructor * new MCPTheiaServerImpl(): MCPTheiaServerImpl ### Returns MCPTheiaServerImpl ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.electron-browser_window_electron-window-service.ElectronWindowService.html Initializes a new instance of the ElectronWindowService class. ```APIDOC ## constructor * new ElectronWindowService(): ElectronWindowService ### Returns ElectronWindowService ``` -------------------------------- ### $startDebugging Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.main_browser_debug_debug-main.DebugMainImpl.html Starts a debugging session. ```APIDOC ## $startDebugging * $startDebugging( folder: undefined | WorkspaceFolder, nameOrConfiguration: string | DebugConfiguration, options: DebugSessionOptions, ): Promise #### Parameters * folder: undefined | WorkspaceFolder * nameOrConfiguration: string | DebugConfiguration * options: DebugSessionOptions #### Returns Promise ``` -------------------------------- ### Example Tree Decorator Implementation Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_navigator.browser_open-editors-widget_navigator-deleted-editor-decorator.NavigatorDeletedEditorDecorator.html Demonstrates how to implement a custom TreeDecorator to change the background color of tree nodes. This example shows the basic structure for creating a decorator that applies a specific style to all nodes in a tree. ```typescript import { injectable, inject } from '@theia/core/lib/common/di'; import { Tree } from '@theia/core/lib/common/tree'; import { Emitter, Event } from '@theia/core/lib/common/event'; import { DepthFirstTreeIterator } from '@theia/core/lib/common/iterator'; import { TreeDecorator, TreeDecoration } from '@theia/core/lib/browser/tree/tree-decorator'; import { MaybePromise } from '@theia/core/lib/common/types'; @injectable() export class MyTreeDecorator implements TreeDecorator { id = 'myTreeDecorator'; protected readonly emitter = new Emitter<(tree: Tree) => Map>(); get onDidChangeDecorations(): Event<(tree: Tree) => Map> { return this.emitter.event; } decorations(tree: Tree): MaybePromise> { const result = new Map(); if (tree.root === undefined) { return result; } for (const treeNode of new DepthFirstTreeIterator(tree.root)) { result.set(treeNode.id,{backgroundColor:'red'}) } return result; } } ``` -------------------------------- ### SimpleObservableCollection.values Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_test.common_collections.SimpleObservableCollection.html Gets the values contained in the collection. ```APIDOC ## values * get values(): readonly V[] ### Returns * readonly V[] - An array of the values in the collection. ``` -------------------------------- ### widget Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_test.browser_view_test-run-view-contribution.TestRunViewContribution.html Gets the widget associated with the view. ```APIDOC ## widget * get widget(): Promise #### Returns Promise ``` -------------------------------- ### init Method Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.browser-only_messaging_frontend-only-service-connection-provider.FrontendOnlyServiceConnectionProvider.html Initializes the service connection provider. ```APIDOC ## init * init(): void ### Returns void ``` -------------------------------- ### viewLabel Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_test.browser_view_test-run-view-contribution.TestRunViewContribution.html Gets the display label for the view. ```APIDOC ## viewLabel * get viewLabel(): string #### Returns string ``` -------------------------------- ### viewId Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_test.browser_view_test-run-view-contribution.TestRunViewContribution.html Gets the unique identifier for the view. ```APIDOC ## viewId * get viewId(): string #### Returns string ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_filesystem.node_disk-file-system-provider.DiskFileSystemProvider.html Initializes a new instance of the DiskFileSystemProvider class. ```APIDOC ## constructor * new DiskFileSystemProvider(): DiskFileSystemProvider #### Returns DiskFileSystemProvider ``` -------------------------------- ### getDefaultNodeStyle Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_preferences.browser_views_preference-tree-widget.PreferencesTreeWidget.html Gets the default style for a node. ```APIDOC ## getDefaultNodeStyle ### Description Get the default node style. ### Parameters * node: TreeNode the tree node. * props: NodeProps the node properties. ### Returns undefined | CSSProperties the CSS properties if available. ``` -------------------------------- ### onStart Source: https://eclipse-theia.github.io/theia/docs/next/interfaces/_theia_core.node_backend-application.BackendApplicationContribution.html Called right after the server for the Express app is started. Use this to additionally configure the server or as ready-signal for your service. The implementation may be async, however it will still block the startup step until it's resolved. ```APIDOC ## onStart ### Description Called right after the server for the Express app is started. Use this to additionally configure the server or as ready-signal for your service. The implementation may be async, however it will still block the startup step until it's resolved. ### Method onStart?(server: Server): MaybePromise ### Parameters #### Path Parameters * `server` (Server) - the backend server running the express app. ### Returns MaybePromise - either `undefined` or a Promise resolving to `undefined`. ``` -------------------------------- ### getDecorations Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_preferences.browser_views_preference-tree-widget.PreferencesTreeWidget.html Gets the decorations for the tree node. ```APIDOC ## getDecorations ### Parameters * node: TreeNode the tree node. ### Returns WidgetDecoration.Data[] the list of tree decoration data. ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.electron-node_keyboard_electron-keyboard-layout-provider.ElectronKeyboardLayoutProvider.html Initializes a new instance of the ElectronKeyboardLayoutProvider class. ```APIDOC ## constructor * new ElectronKeyboardLayoutProvider(): ElectronKeyboardLayoutProvider ### Returns ElectronKeyboardLayoutProvider ``` -------------------------------- ### getCaptionChildren Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_preferences.browser_views_preference-tree-widget.PreferencesTreeWidget.html Gets the children for the tree caption. ```APIDOC ## getCaptionChildren ### Parameters * node: TreeNode * props: NodeProps ### Returns ReactNode ``` -------------------------------- ### getCaptionAttributes Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_preferences.browser_views_preference-tree-widget.PreferencesTreeWidget.html Gets the attributes for the tree caption. ```APIDOC ## getCaptionAttributes ### Parameters * node: TreeNode * props: NodeProps ### Returns Attributes & HTMLAttributes ``` -------------------------------- ### startTracking Method Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.main_browser_window-activity-tracker.WindowActivityTracker.html Starts tracking window activity. ```APIDOC ## startTracking * startTracking(): void #### Returns void ``` -------------------------------- ### previousRevisionUri Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_scm.browser_dirty-diff_dirty-diff-widget.DirtyDiffWidget.html Gets the URI of the previous revision. ```APIDOC ## previousRevisionUri * get previousRevisionUri(): URI #### Returns URI ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_mini-browser.browser_environment_mini-browser-environment.MiniBrowserEnvironment.html Initializes a new instance of MiniBrowserEnvironment. ```APIDOC ## constructor * new MiniBrowserEnvironment(): MiniBrowserEnvironment #### Returns MiniBrowserEnvironment ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_filesystem.node_filesystem-watcher-client.FileSystemWatcherServerClient.html Initializes a new instance of the FileSystemWatcherServerClient. ```APIDOC ## constructor * new FileSystemWatcherServerClient(): FileSystemWatcherServerClient ### Returns FileSystemWatcherServerClient ``` -------------------------------- ### currentChange Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_scm.browser_dirty-diff_dirty-diff-widget.DirtyDiffWidget.html Gets the currently selected change. ```APIDOC ## currentChange * get currentChange(): undefined | Change #### Returns undefined | Change ``` -------------------------------- ### size Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_test-item.TestItemCollection.html Gets the number of items in the collection. ```APIDOC ## size ### Description Gets the number of items in the collection. ### Returns `number` - The number of items in the collection. ``` -------------------------------- ### Constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_webviews.WebviewPanelImpl.html Initializes a new instance of the WebviewPanelImpl class. ```APIDOC ## constructor * new WebviewPanelImpl( viewId: string, proxy: WebviewsMain, _viewType: string, _title: string, showOptions: ViewColumn | WebviewPanelShowOptions, _options: WebviewPanelOptions, _webview: WebviewImpl, ): WebviewPanelImpl ### Parameters * viewId: string * proxy: WebviewsMain * _viewType: string * _title: string * showOptions: ViewColumn | WebviewPanelShowOptions * _options: WebviewPanelOptions * _webview: WebviewImpl ``` -------------------------------- ### get Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_plugin-storage.GlobalState.html Retrieves a value from the global state. ```APIDOC ## get(key: string): undefined | T ### Description Retrieves a value associated with the given key from the global state. If no value is found, `undefined` is returned. ### Type Parameters - **T**: The expected type of the stored value. ### Parameters - **key** (string) - The key of the value to retrieve. ### Returns - `undefined | T`: The stored value or `undefined` if the key does not exist. ``` ```APIDOC ## get(key: string, defaultValue: T): T ### Description Retrieves a value associated with the given key from the global state. If no value is found, the provided `defaultValue` is returned. ### Type Parameters - **T**: The expected type of the stored value. ### Parameters - **key** (string) - The key of the value to retrieve. - **defaultValue** (T) - The value to return if the key is not found. ### Returns - T: The stored value or the `defaultValue`. ``` -------------------------------- ### initialize Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_workspace.browser_metadata-storage_workspace-metadata-store.WorkspaceMetadataStoreImpl.html Initializes the WorkspaceMetadataStore with the provided parameters. ```APIDOC ## initialize * initialize( key: string, initialLocation: URI, locationProvider: () => Promise, onDispose?: () => void, ): Initializes the WorkspaceMetadataStore. #### Parameters * key: string The key identifying this store * initialLocation: URI The initial location URI * locationProvider: () => Promise Function to resolve the current location based on workspace changes * `Optional`onDispose: () => void Callback invoked when the store is disposed #### Returns void ``` -------------------------------- ### init Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_toolbar.browser_icons_icon-set-provider.IconSetProvider.html Initializes all available icon sets. This is a protected method. ```APIDOC ## `Protected`init * init(): void Initializes all available icon sets #### Returns void ``` -------------------------------- ### Static getIdentifier Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_memory-inspector.browser_memory-widget_memory-widget.MemoryWidget.html Get the identifier for the MemoryWidget. ```APIDOC ## Static getIdentifier ### Description Get the identifier for the MemoryWidget. ### Parameters - **optionsWidgetID** (string) - Required ### Returns string ``` -------------------------------- ### source Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_debug.browser_editor_debug-hover-widget.DebugHoverWidget.html Gets or sets the source for the widget. ```APIDOC ## source ### Description Get or set the source for the widget. ### Getter * get source(): undefined | TreeSource ### Setter * set source(source: undefined | TreeSource): void ### Parameters * source: undefined | TreeSource ### Returns void ``` -------------------------------- ### selectedElement Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_debug.browser_editor_debug-hover-widget.DebugHoverWidget.html Gets the selected element from the tree. ```APIDOC ## selectedElement ### Description Get the selected element from the tree. ### Returns undefined | TreeElement ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.plugin_output-channel-registry.OutputChannelRegistryExtImpl.html Initializes a new instance of the OutputChannelRegistryExtImpl class. ```APIDOC ## constructor * new OutputChannelRegistryExtImpl(rpc: RPCProtocol): OutputChannelRegistryExtImpl #### Parameters * rpc: RPCProtocol #### Returns OutputChannelRegistryExtImpl ``` -------------------------------- ### startPlugins Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_plugin-ext.hosted_common_hosted-plugin.AbstractHostedPluginSupport.html Starts a collection of plugins based on their host and contributions, managing their lifecycle and disconnections. ```APIDOC ## startPlugins ### Description Starts a collection of plugins based on their host and contributions, managing their lifecycle and disconnections. ### Signature `startPlugins(contributionsByHost: Map, toDisconnect: DisposableCollection): Promise` ### Parameters #### Path Parameters - **contributionsByHost** (`Map`) - A map where keys are host identifiers and values are arrays of plugin contributions. - **toDisconnect** (`DisposableCollection`) - A collection to manage disposables for the started plugins. ``` -------------------------------- ### PathIterator.value Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.common_ternary-search-tree.PathIterator.html Gets the current value of the iterator. ```APIDOC ## value * value(): string #### Returns string ``` -------------------------------- ### get Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_core.common_reference.SyncReferenceCollection.html Retrieves a value from the collection if it exists. ```APIDOC ## get * get(args: K): undefined | V #### Parameters * args: K #### Returns undefined | V ``` -------------------------------- ### constructor Source: https://eclipse-theia.github.io/theia/docs/next/classes/_theia_ai-mcp-server.node_mcp-tool-frontend-delegate.MCPToolFrontendDelegateImpl.html Initializes a new instance of MCPToolFrontendDelegateImpl. ```APIDOC ## constructor * new MCPToolFrontendDelegateImpl(): MCPToolFrontendDelegateImpl #### Returns MCPToolFrontendDelegateImpl ```