AnEvent which fires when the authentication sessions of an authentication provider havebeen added, removed, or changed.

Get all accounts that the user is logged in to for the specified provider.Use this paired withgetSession in order to get an authentication session for a specific account.

Currently, there are only two authentication providers that are contributed from built in extensionsto the editor that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.

Note: Getting accounts does not imply that your extension has access to that account or its authentication sessions. You can verify access to the account by callinggetSession.

Get an authentication session matching the desired scopes. Rejects if a provider with providerId is notregistered, or if the user does not consent to sharing authentication information withthe extension. If there are multiple sessions with the same scopes, the user will be shown aquickpick to select which account they would like to use.

Currently, there are only two authentication providers that are contributed from built in extensionsto the editor that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.

Get an authentication session matching the desired scopes. Rejects if a provider with providerId is notregistered, or if the user does not consent to sharing authentication information withthe extension. If there are multiple sessions with the same scopes, the user will be shown aquickpick to select which account they would like to use.

Currently, there are only two authentication providers that are contributed from built in extensionsto the editor that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.

Get an authentication session matching the desired scopes. Rejects if a provider with providerId is notregistered, or if the user does not consent to sharing authentication information withthe extension. If there are multiple sessions with the same scopes, the user will be shown aquickpick to select which account they would like to use.

Currently, there are only two authentication providers that are contributed from built in extensionsto the editor that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.

Register an authentication provider.

There can only be one provider per id and an error is being thrown when an idhas already been used by another provider. Ids are case-sensitive.

Create a newchat participant instance.

Executes the command denoted by the given command identifier.

• Note 1: When executing an editor command not all types are allowed tobe passed as arguments. Allowed are the primitive typesstring,boolean,number,undefined, andnull, as well asPosition,Range,Uri andLocation.
• Note 2: There are no restrictions when executing commands that have been contributedby extensions.

Retrieve the list of all available commands. Commands starting with an underscore aretreated as internal commands.

Registers a command that can be invoked via a keyboard shortcut,a menu item, an action, or directly.

Registering a command with an existing command identifier twicewill cause an error.

Registers a text editor command that can be invoked via a keyboard shortcut,a menu item, an action, or directly.

Text editor commands are different from ordinarycommands asthey only execute when there is an active editor when the command is called. Also, thecommand handler of an editor command has access to the active editor and to anedit-builder. Note that the edit-builder is only valid while thecallback executes.

Creates a newcomment controller instance.

The currently activedebug console.If no debug session is active, output sent to the debug console is not shown.

The currently activedebug session orundefined. The active debug session is the onerepresented by the debug action floating window or the one currently shown in the drop down menu of the debug action floating window.If no debug session is active, the value isundefined.

The currently focused thread or stack frame, orundefined if nothread or stack is focused. A thread can be focused any time there isan active debug session, while a stack frame can only be focused whena session is paused and the call stack has been retrieved.

List of breakpoints.

AnEvent which fires when theactive debug sessionhas changed.Note that the event also fires when the active debug session changestoundefined.

An event which fires when thedebug.activeStackItem has changed.

AnEvent that is emitted when the set of breakpoints is added, removed, or changed.

AnEvent which fires when a custom DAP event is received from thedebug session.

AnEvent which fires when a newdebug session has been started.

AnEvent which fires when adebug session has terminated.

Add breakpoints.

Converts a "Source" descriptor object received via the Debug Adapter Protocol into a Uri that can be used to load its contents.If the source descriptor is based on a path, a file Uri is returned.If the source descriptor uses a reference number, a specific debug Uri (scheme 'debug') is constructed that requires a corresponding ContentProvider and a running debug session

If the "Source" descriptor has insufficient information for creating the Uri, an error is thrown.

Register adebug adapter descriptor factory for a specific debug type.An extension is only allowed to register a DebugAdapterDescriptorFactory for the debug type(s) defined by the extension. Otherwise an error is thrown.Registering more than one DebugAdapterDescriptorFactory for a debug type results in an error.

Register a debug adapter tracker factory for the given debug type.

Register adebug configuration provider for a specific debug type.The optionaltriggerKind can be used to specify when theprovideDebugConfigurations method of the provider is triggered.Currently two trigger kinds are possible: with the valueInitial (or if no trigger kind argument is given) theprovideDebugConfigurations method is used to provide the initial debug configurations to be copied into a newly created launch.json.With the trigger kindDynamic theprovideDebugConfigurations method is used to dynamically determine debug configurations to be presented to the user (in addition to the static configurations from the launch.json).Please note that thetriggerKind argument only applies to theprovideDebugConfigurations method: so theresolveDebugConfiguration methods are not affected at all.Registering a single provider with resolve methods for different trigger kinds, results in the same resolve methods called multiple times.More than one provider can be registered for the same type.

Remove breakpoints.

Start debugging by using either a named launch or named compound configuration,or by directly passing aDebugConfiguration.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.

Stop the given debug session or stop all debug sessions if session is omitted.

The hosted location of the applicationOn desktop this is 'desktop'In the web this is the specified embedder i.e. 'github.dev', 'codespaces', or 'web' if the embedderdoes not provide that information

The application name of the editor, like 'VS Code'.

The application root folder from which the editor is running.

Note that the value is the empty string when running in anenvironment that has no representation of an application root folder.

The system clipboard.

Indicates that this is a fresh install of the application.true if within the first day of installation otherwisefalse.

Indicates whether the users has telemetry enabled.Can be observed to determine if the extension should send telemetry.

Represents the preferred user-language, likede-CH,fr, oren-US.

The current log level of the editor.

A unique identifier for the computer.

The name of a remote. Defined by extensions, popular samples arewsl for the WindowsSubsystem for Linux orssh-remote for remotes using a secure shell.

Note that the value isundefined when there is no remote extension host but that thevalue is defined in all extension hosts (local and remote) in case a remote extension hostexists. UseExtension.extensionKind to know ifa specific extension runs remote or not.

A unique identifier for the current session.Changes each time the editor is started.

The detected default shell for the extension host, this is overridden by theterminal.integrated.defaultProfile setting for the extension host's platform. Note that inenvironments that do not support a shell the value is the empty string.

The UI kind property indicates from which UI extensionsare accessed from. For example, extensions could be accessedfrom a desktop application or a web browser.

The custom uri scheme the editor registers to in the operating system.

AnEvent which fires when the log level of the editor changes.

AnEvent which fires when the default shell changes. This fires with the newshell path.

AnEvent which fires when the user enabled or disables telemetry.true if the user has enabled telemetry orfalse if the user has disabled telemetry.

Resolves a uri to a form that is accessible externally.

http: orhttps: scheme

Resolves anexternal uri, such as ahttp: orhttps: link, from where the extension is running to auri to the same resource on the client machine.

This is a no-op if the extension is running on the client machine.

If the extension is running remotely, this function automatically establishes a port forwarding tunnelfrom the local machine totarget on the remote and returns a local uri to the tunnel. The lifetime ofthe port forwarding tunnel is managed by the editor and the tunnel can be closed by the user.

Note that uris passed throughopenExternal are automatically resolved and you should not callasExternalUri on them.

vscode.env.uriScheme

Creates a uri that - if opened in a browser (e.g. viaopenExternal) - will result in a registeredUriHandlerto trigger.

Extensions should not make any assumptions about the resulting uri and should not alter it in any way.Rather, extensions can e.g. use this uri in an authentication flow, by adding the uri as callback queryargument to the server to authenticate to.

Note that if the server decides to add additional query parameters to the uri (e.g. a token or secret), itwill appear in the uri that is passed to theUriHandler.

Example of an authentication flow:

vscode.window.registerUriHandler({  handleUri(uri:vscode.Uri):vscode.ProviderResult<void> {    if (uri.path ==='/did-authenticate') {      console.log(uri.toString());    }  }});const callableUri =await vscode.env.asExternalUri(  vscode.Uri.parse(vscode.env.uriScheme +'://my.extension/did-authenticate'));await vscode.env.openExternal(callableUri);

Note that extensions should not cache the result ofasExternalUri as the resolved uri may become invalid due toa system or user action — for example, in remote cases, a user may close a port forwarding tunnel that was opened byasExternalUri.

Any other scheme

Any other scheme will be handled as if the provided URI is a workspace URI. In that case, the method will returna URI which, when handled, will make the editor open the workspace.

Creates a newtelemetry logger.

Opens a link externally using the default application. Depending on theused scheme this can be:

• a browser (http:,https:)
• a mail client (mailto:)
• VSCode itself (vscode: fromvscode.env.uriScheme)

Note thatshowTextDocument is the rightway to open a text document inside the editor, not this function.

All extensions currently known to the system.

An event which fires whenextensions.all changes. This can happen when extensions areinstalled, uninstalled, enabled or disabled.

Get an extension by its full identifier in the form of:publisher.name.

The bundle of localized strings that have been loaded for the extension.It's undefined if no bundle has been loaded. The bundle is typically not loaded ifthere was no bundle found or when we are running with the default language.

The URI of the localization bundle that has been loaded for the extension.It's undefined if no bundle has been loaded. The bundle is typically not loaded ifthere was no bundle found or when we are running with the default language.

Marks a string for localization. If a localized bundle is available for the language specified byenv.language and the bundle has a localized value for this message, then that localizedvalue will be returned (with injectedargs values for any templated values).

Example

l10n.t('Hello {0}!','World');

Marks a string for localization. If a localized bundle is available for the language specified byenv.language and the bundle has a localized value for this message, then that localizedvalue will be returned (with injectedargs values for any templated values).

Example

l10n.t('Hello {name}', {name: 'Erich' });

Marks a string for localization. If a localized bundle is available for the language specified byenv.language and the bundle has a localized value for this message, then that localizedvalue will be returned (with injected args values for any templated values).

AnEvent which fires when the global set of diagnostics changes. This isnewly added and removed diagnostics.

Create a diagnostics collection.

Creates a newlanguage status item.

Get all diagnostics for a given resource.

Get all diagnostics.

Return the identifiers of all known languages.

Compute the match between a documentselector and a document. Valuesgreater than zero mean the selector matches the document.

A match is computed according to these rules:

1. WhenDocumentSelector is an array, compute the match for each containedDocumentFilter or language identifier and take the maximum value.
2. A string will be desugared to become thelanguage-part of aDocumentFilter, so"fooLang" is like{ language: "fooLang" }.
3. ADocumentFilter will be matched against the document by comparing its parts with the document. The following rules apply:
   1. When theDocumentFilter is empty ({}) the result is0
   2. Whenscheme,language,pattern, ornotebook are defined but one doesn't match, the result is0
   3. Matching against* gives a score of5, matching via equality or via a glob-pattern gives a score of10
   4. The result is the maximum value of each match

Samples:

// default document from disk (file-scheme)doc.uri;//'file:///my/file.js'doc.languageId;// 'javascript'match('javascript',doc);// 10;match({language: 'javascript' },doc);// 10;match({language: 'javascript',scheme: 'file' },doc);// 10;match('*',doc);// 5match('fooLang',doc);// 0match(['fooLang','*'],doc);// 5// virtual document, e.g. from git-indexdoc.uri;// 'git:/my/file.js'doc.languageId;// 'javascript'match('javascript',doc);// 10;match({language: 'javascript',scheme: 'git' },doc);// 10;match('*',doc);// 5// notebook cell documentdoc.uri;// `vscode-notebook-cell:///my/notebook.ipynb#gl65s2pmha`;doc.languageId;// 'python'match({notebookType: 'jupyter-notebook' },doc);// 10match({notebookType: 'fooNotebook',language: 'python' },doc);// 0match({language: 'python' },doc);// 10match({notebookType: '*' },doc);// 5

Register a call hierarchy provider.

Register a code action provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a code lens provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a color provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a completion provider.

Multiple providers can be registered for a language. In that case providers are sortedby theirscore and groups of equal score are sequentially asked forcompletion items. The process stops when one or many providers of a group return aresult. A failing provider (rejected promise or exception) will not fail the wholeoperation.

A completion item provider can be associated with a set oftriggerCharacters. When triggercharacters are being typed, completions are requested but only from providers that registeredthe typed character. Because of that trigger characters should be different thanword characters,a common trigger character is. to trigger member completions.

Register a declaration provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a definition provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Registers a newDocumentDropEditProvider.

Multiple drop providers can be registered for a language. When dropping content into an editor, allregistered providers for the editor's language will be invoked based on the mimetypes they handleas specified by theirDocumentDropEditProviderMetadata.

Each provider can return one or moreDocumentDropEdits. The edits are sortedusing theDocumentDropEdit.yieldTo property. By default the first edit will be applied. If thereare any additional edits, these will be shown to the user as selectable drop options in the drop widget.

Register a formatting provider for a document.

Multiple providers can be registered for a language. In that case providers are sortedby theirscore and the best-matching provider is used. Failureof the selected provider will cause a failure of the whole operation.

Register a document highlight provider.

Multiple providers can be registered for a language. In that case providers are sortedby theirscore and groups sequentially asked for document highlights.The process stops when a provider returns anon-falsy ornon-failure result.

Register a document link provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Registers a newDocumentPasteEditProvider.

Multiple providers can be registered for a language. All registered providers for a language will be invokedfor copy and paste operations based on their handled mimetypes as specified by theDocumentPasteProviderMetadata.

Forcopy operations, changes to theDataTransfermade by each provider will be merged into a singleDataTransfer that is used to populate the clipboard.

For [DocumentPasteEditProvider.providerDocumentPasteEdits paste operations](#DocumentPasteEditProvider.providerDocumentPasteEdits paste operations), each provider will be invokedand can return one or moreDocumentPasteEdits. The edits are sorted usingtheDocumentPasteEdit.yieldTo property. By default the first edit will be appliedand the rest of the edits will be shown to the user as selectable paste options in the paste widget.

Register a formatting provider for a document range.

Note: A document range provider is also adocument formatterwhich means there is no need toregister a documentformatter when also registering a range provider.

Multiple providers can be registered for a language. In that case providers are sortedby theirscore and the best-matching provider is used. Failureof the selected provider will cause a failure of the whole operation.

Register a semantic tokens provider for a document range.

Note: If a document has both aDocumentSemanticTokensProvider and aDocumentRangeSemanticTokensProvider,the range provider will be invoked only initially, for the time in which the full document provider takesto resolve the first request. Once the full document provider resolves the first request, the semantic tokensprovided via the range provider will be discarded and from that point forward, only the document providerwill be used.

Multiple providers can be registered for a language. In that case providers are sortedby theirscore and the best-matching provider is used. Failureof the selected provider will cause a failure of the whole operation.

Register a semantic tokens provider for a whole document.

Multiple providers can be registered for a language. In that case providers are sortedby theirscore and the best-matching provider is used. Failureof the selected provider will cause a failure of the whole operation.

Register a document symbol provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a provider that locates evaluatable expressions in text documents.The editor will evaluate the expression in the active debug session and will show the result in the debug hover.

If multiple providers are registered for a language an arbitrary provider will be used.

Register a folding range provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged.If multiple folding ranges start at the same position, only the range of the first registered provider is used.If a folding range overlaps with an other range that has a smaller position, it is also ignored.

A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a hover provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register an implementation provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a inlay hints provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Registers an inline completion provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a provider that returns data for the debugger's 'inline value' feature.Whenever the generic debugger has stopped in a source file, providers registered for the language of the fileare called to return textual data that will be shown in the editor at the end of lines.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a linked editing range provider.

Multiple providers can be registered for a language. In that case providers are sortedby theirscore and the best-matching provider that has a result is used. Failureof the selected provider will cause a failure of the whole operation.

Register a formatting provider that works on type. The provider is active when the user enables the settingeditor.formatOnType.

Multiple providers can be registered for a language. In that case providers are sortedby theirscore and the best-matching provider is used. Failureof the selected provider will cause a failure of the whole operation.

Register a reference provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a rename provider.

Multiple providers can be registered for a language. In that case providers are sortedby theirscore and asked in sequence. The first provider producing a resultdefines the result of the whole operation.

Register a selection range provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a signature help provider.

Multiple providers can be registered for a language. In that case providers are sortedby theirscore and called sequentially until a provider returns avalid result.

See alsolanguages.registerSignatureHelpProvider

Register a type definition provider.

Multiple providers can be registered for a language. In that case providers are asked inparallel and the results are merged. A failing provider (rejected promise or exception) willnot cause a failure of the whole operation.

Register a type hierarchy provider.

Register a workspace symbol provider.

Multiple providers can be registered. In that case providers are asked in parallel andthe results are merged. A failing provider (rejected promise or exception) will not causea failure of the whole operation.

Set alanguage configuration for a language.

Set (and change) thelanguage that is associatedwith the given document.

Note that calling this function will trigger theonDidCloseTextDocument eventfollowed by theonDidOpenTextDocument event.

A list of all available tools that were registered by all extensions usinglm.registerTool. They can be calledwithlm.invokeTool with input that match their declaredinputSchema.

An event that is fired when the set of available chat models changes.

Invoke a tool listed inlm.tools by name with the given input. The input will be validated againstthe schema declared by the tool

A tool can be invoked by a chat participant, in the context of handling a chat request, or globally by any extension inany custom flow.

In the former case, the caller shall pass thetoolInvocationToken, which comes with the achat request. This makes sure the chat UI shows the tool invocation for thecorrect conversation.

A toolresult is an array oftext- andprompt-tsx-parts. If the tool caller is usingvscode/prompt-tsx, it canincorporate the response parts into its prompt using aToolResult. If not, the parts can be passed along to theLanguageModelChat via a user message with aLanguageModelToolResultPart.

If a chat participant wants to preserve tool results for requests across multiple turns, it can store tool results intheChatResult.metadata returned from the handler and retrieve them on the next turn fromChatResponseTurn.result.

Registers a provider that publishes Model Context Protocol servers for the editor toconsume. This allows MCP servers to be dynamically provided to the editor inaddition to those the user creates in their configuration files.

Before calling this method, extensions must register thecontributes.mcpServerDefinitionProvidersextension point with the correspondingid, for example:

    "contributes": {        "mcpServerDefinitionProviders": [            {                "id": "cool-cloud-registry.mcp-servers",                "label": "Cool Cloud Registry",            }        ]    }

When a new McpServerDefinitionProvider is available, the editor will present a 'refresh'action to the user to discover new servers. To enable this flow, extensions shouldcallregisterMcpServerDefinitionProvider during activation.

Register a LanguageModelTool. The tool must also be registered in the package.jsonlanguageModelTools contributionpoint. A registered tool is available in thelm.tools list for any extension to see. But in order for it tobe seen by a language model, it must be passed in the list of available tools inLanguageModelChatRequestOptions.tools.

Select chat models by aselector. This can yield multiple or no chat models andextensions must handle these cases, esp. when no chat model exists, gracefully.

const models =await vscode.lm.selectChatModels({family: 'gpt-3.5-turbo' });if (models.length >0) {    const [first] =models;    const response =await first.sendRequest(...)    // ...}else {    // NO chat models available}

A selector can be written to broadly match all models of a given vendor or family, or it can narrowly select one model by ID.Keep in mind that the available set of models will change over time, but also that prompts may perform differently indifferent models.

Note that extensions can hold on to the results returned by this function and use them later. However, when theonDidChangeChatModels-event is fired the list of chat models might have changed and extensions should re-query.

Creates a new notebook controller.

Creates a new messaging instance used to communicate with a specific renderer.

• Note 1: Extensions can only create renderer that they have defined in theirpackage.json-file
• Note 2: A renderer only has access to messaging ifrequiresMessaging is set toalways oroptional initsnotebookRenderer contribution.

Register acell statusbar item provider for the given notebook type.

Theinput box for the last source controlcreated by the extension.

• deprecated - Use SourceControl.inputBox instead

Creates a newsource control instance.

The currently active task executions or an empty array.

Fires when a task ends.

Fires when the underlying process has ended.This event will not fire for tasks that don'texecute an underlying process.

Fires when a task starts.

Fires when the underlying process has been started.This event will not fire for tasks that don'texecute an underlying process.

Executes a task that is managed by the editor. The returnedtask execution can be used to terminate the task.

• throws - When running a ShellExecution or a ProcessExecutiontask in an environment where a new process cannot be started.In such an environment, only CustomExecution tasks can be run.

Fetches all tasks available in the systems. This includes tasksfromtasks.json files as well as tasks from task providerscontributed through extensions.

Register a task provider.

Creates a new test controller.

The currently active color theme as configured in the settings. The activetheme can be changed via theworkbench.colorTheme setting.

The currently activenotebook editor orundefined. The active editor is the onethat currently has focus or, when none has focus, the one that has changedinput most recently.

The currently active terminal orundefined. The active terminal is the one thatcurrently has focus or most recently had focus.

The currently active editor orundefined. The active editor is the onethat currently has focus or, when none has focus, the one that has changedinput most recently.

Represents the current window's state.

Represents the grid widget within the main editor area

The currently opened terminals or an empty array.

The currently visiblenotebook editors or an empty array.

The currently visible editors or an empty array.

AnEvent which fires when the active color theme is changed or has changes.

AnEvent which fires when theactive notebook editorhas changed.Note that the event also fires when the active editor changestoundefined.

AnEvent which fires when theactive terminalhas changed.Note that the event also fires when the active terminal changestoundefined.

AnEvent which fires when theactive editorhas changed.Note that the event also fires when the active editor changestoundefined.

AnEvent which fires when thenotebook editor selectionshave changed.

AnEvent which fires when thenotebook editor visible rangeshave changed.

Fires when shell integration activates or one of its properties changes in a terminal.

AnEvent which fires when aterminal's state has changed.

AnEvent which fires when the options of an editor have changed.

AnEvent which fires when the selection in an editor has changed.

AnEvent which fires when the view column of an editor has changed.

AnEvent which fires when the visible ranges of an editor has changed.

AnEvent which fires when thevisible notebook editorshas changed.

AnEvent which fires when the array ofvisible editorshas changed.

AnEvent which fires when the focus or activity state of the current windowchanges. The value of the event represents whether the window is focused.

AnEvent which fires when a terminal is disposed.

This will be fired when a terminal command is ended. This event will fire only whenshell integration isactivated for the terminal.

AnEvent which fires when a terminal has been created, either through thecreateTerminal API or commands.

This will be fired when a terminal command is started. This event will fire only whenshell integration isactivated for the terminal.

Creates aInputBox to let the user enter some text input.

Note that in many cases the more convenientwindow.showInputBoxis easier to use.window.createInputBox should be usedwhenwindow.showInputBox does not offer the required flexibility.

Creates a newoutput channel with the given name and language idIf language id is not provided, thenLog is used as default language id.

You can access the visible or active output channel as atext document fromvisible editors oractive editorand use the language id to contribute language features like syntax coloring, code lens etc.,

Creates a newlog output channel with the given name.

Creates aQuickPick to let the user pick an item from a listof items of type T.

Note that in many cases the more convenientwindow.showQuickPickis easier to use.window.createQuickPick should be usedwhenwindow.showQuickPick does not offer the required flexibility.

Creates a status baritem.

Creates a status baritem.

See alsocreateStatusBarItem for creating a status bar item with an identifier.

Creates aTerminal with a backing shell process. The cwd of the terminal will be the workspacedirectory if it exists.

• throws - When running in an environment where a new process cannot be started.

Creates aTerminal with a backing shell process.

• throws - When running in an environment where a new process cannot be started.

Creates aTerminal where an extension controls its input and output.

Create a TextEditorDecorationType that can be used to add decorations to text editors.

Create aTreeView for the view contributed using the extension pointviews.

Create and show a new webview panel.

Register a provider for custom editors for theviewType contributed by thecustomEditors extension point.

When a custom editor is opened, anonCustomEditor:viewType activation event is fired. Your extensionmust register aCustomTextEditorProvider,CustomReadonlyEditorProvider,CustomEditorProviderforviewType as part of activation.

Register a file decoration provider.

Register provider that enables the detection and handling of links within the terminal.

Registers a provider for a contributed terminal profile.

Register aTreeDataProvider for the view contributed using the extension pointviews.This will allow you to contribute data to theTreeView and update if the data changes.

Note: To get access to theTreeView and perform operations on it, usecreateTreeView.

Registers auri handler capable of handling system-wideuris.In case there are multiple windows open, the topmost window will handle the uri.A uri handler is scoped to the extension it is contributed from; it will onlybe able to handle uris which are directed to the extension itself. A uri must respectthe following rules:

• The uri-scheme must bevscode.env.uriScheme;
• The uri-authority must be the extension id (e.g.my.extension);
• The uri-path, -query and -fragment parts are arbitrary.

For example, if themy.extension extension registers a uri handler, it will onlybe allowed to handle uris with the prefixproduct-name://my.extension.

An extension can only register a single uri handler in its entire activation lifetime.

• Note: There is an activation eventonUri that fires when a uri directed forthe current extension is about to be handled.

Registers a webview panel serializer.

Extensions that support reviving should have an"onWebviewPanel:viewType" activation event andmake sure thatregisterWebviewPanelSerializer is called during activation.

Only a single serializer may be registered at a time for a givenviewType.

Register a new provider for webview views.

Set a message to the status bar. This is a short hand for the more powerfulstatus baritems.

Set a message to the status bar. This is a short hand for the more powerfulstatus baritems.

Set a message to the status bar. This is a short hand for the more powerfulstatus baritems.

Note that status bar messages stack and that they must be disposed when nolonger used.

Show an error message.

See alsoshowInformationMessage

Show an error message.

See alsoshowInformationMessage

Show an error message.

See alsoshowInformationMessage

Show an error message.

See alsoshowInformationMessage

Show an information message to users. Optionally provide an array of items which will be presented asclickable buttons.

Show an information message to users. Optionally provide an array of items which will be presented asclickable buttons.

Show an information message.

See alsoshowInformationMessage

Show an information message.

See alsoshowInformationMessage

Opens an input box to ask the user for input.

The returned value will beundefined if the input box was canceled (e.g. pressing ESC). Otherwise thereturned value will be the string typed by the user or an empty string if the user did not typeanything but dismissed the input box with OK.

Show the givenNotebookDocument in anotebook editor.

Shows a file open dialog to the user which allows to select a filefor opening-purposes.

Shows a selection list allowing multiple selections.

Shows a selection list.

Shows a selection list allowing multiple selections.

Shows a selection list.

Shows a file save dialog to the user which allows to select a filefor saving-purposes.