VS Code API

当身份验证提供程序的身份验证会话被添加、移除或更改时触发的 Event。

获取用户已登录到指定提供程序的所有帐户。结合 getSession 使用此方法，以便获取特定帐户的身份验证会话。

目前，编辑器中有两个内置扩展贡献的身份验证提供程序，分别实现了 GitHub 和 Microsoft 身份验证：它们的 providerId 分别是 'github' 和 'microsoft'。

注意：获取帐户并不意味着你的扩展可以访问该帐户或其身份验证会话。你可以通过调用 getSession 来验证对该帐户的访问权限。

获取匹配所需范围的身份验证会话。如果未注册具有 providerId 的提供程序，或者用户不同意与扩展共享身份验证信息，则拒绝。如果存在多个具有相同范围的会话，将向用户显示快速选择以选择要使用的帐户。

目前，编辑器中有两个内置扩展贡献的身份验证提供程序，分别实现了 GitHub 和 Microsoft 身份验证：它们的 providerId 分别是 'github' 和 'microsoft'。

获取匹配所需范围的身份验证会话。如果未注册具有 providerId 的提供程序，或者用户不同意与扩展共享身份验证信息，则拒绝。如果存在多个具有相同范围的会话，将向用户显示快速选择以选择要使用的帐户。

目前，编辑器中有两个内置扩展贡献的身份验证提供程序，分别实现了 GitHub 和 Microsoft 身份验证：它们的 providerId 分别是 'github' 和 'microsoft'。

获取匹配所需范围的身份验证会话。如果未注册具有 providerId 的提供程序，或者用户不同意与扩展共享身份验证信息，则拒绝。如果存在多个具有相同范围的会话，将向用户显示快速选择以选择要使用的帐户。

目前，编辑器中有两个内置扩展贡献的身份验证提供程序，分别实现了 GitHub 和 Microsoft 身份验证：它们的 providerId 分别是 'github' 和 'microsoft'。

注册身份验证提供程序。

每个 id 只能有一个提供程序，如果 id 已被其他提供程序使用，则会抛出错误。Id 是区分大小写的。

创建新的 聊天参与者 实例。

执行由给定命令标识符表示的命令。

• 注 1：执行编辑器命令时，并非所有类型都允许作为参数传递。允许的类型包括原始类型 string、boolean、number、undefined 和 null，以及 Position、Range、Uri 和 Location。
• 注 2：执行由扩展贡献的命令时没有限制。

检索所有可用命令的列表。以下划线开头的命令被视为内部命令。

注册一个命令，该命令可以通过键盘快捷方式、菜单项、操作或直接调用。

使用已存在的命令标识符两次注册命令将导致错误。

注册一个文本编辑器命令，该命令可以通过键盘快捷方式、菜单项、操作或直接调用。

文本编辑器命令与普通命令不同，它们只有在调用命令时有活动编辑器时才会执行。此外，编辑器命令的命令处理程序可以访问活动编辑器和 edit 构建器。请注意，编辑构建器仅在回调执行期间有效。

创建新的 注释控制器 实例。

当前活动的 调试控制台。如果没有活动调试会话，发送到调试控制台的输出不会显示。

当前活动的 调试会话 或 undefined。活动调试会话是指调试操作浮动窗口所代表的会话，或当前显示在调试操作浮动窗口下拉菜单中的会话。如果没有活动调试会话，则值为 undefined。

当前聚焦的线程或堆栈帧，如果没有聚焦的线程或堆栈，则为 undefined。只要有活动调试会话，就可以聚焦线程；而堆栈帧只能在会话暂停且已检索到调用堆栈时聚焦。

断点列表。

当 活动调试会话 发生更改时触发的 Event。注意，当活动调试会话更改为 undefined 时，此事件也会触发。

当 debug.activeStackItem 发生更改时触发的事件。

当断点集被添加、移除或更改时发出的 Event。

当从 调试会话 接收到自定义 DAP 事件时触发的 Event。

当启动新的 调试会话 时触发的 Event。

当 调试会话 终止时触发的 Event。

添加断点。

将通过调试适配器协议接收的“Source”描述符对象转换为可用于加载其内容的 Uri。如果源描述符基于路径，则返回文件 Uri。如果源描述符使用引用号，则会构建一个需要相应 ContentProvider 和正在运行的调试会话的特定调试 Uri（方案 'debug'）。

如果“Source”描述符没有足够的信息来创建 Uri，则会抛出错误。

为特定的调试类型注册 调试适配器描述符工厂。扩展只能为其定义的调试类型注册 DebugAdapterDescriptorFactory。否则将抛出错误。为一个调试类型注册多个 DebugAdapterDescriptorFactory 将导致错误。

为给定的调试类型注册调试适配器跟踪器工厂。

为特定的调试类型注册 调试配置提供程序。可选的 triggerKind 可用于指定何时触发提供程序的 provideDebugConfigurations 方法。目前有两种触发类型：值为 Initial（或未提供触发类型参数）时，provideDebugConfigurations 方法用于提供要复制到新创建的 launch.json 中的初始调试配置。触发类型为 Dynamic 时，provideDebugConfigurations 方法用于动态确定要呈现给用户的调试配置（除了 launch.json 中的静态配置之外）。请注意，triggerKind 参数仅适用于 provideDebugConfigurations 方法：因此 resolveDebugConfiguration 方法完全不受影响。为不同触发类型注册具有解析方法的单个提供程序会导致多次调用相同的解析方法。同一种类型可以注册多个提供程序。

移除断点。

通过使用命名启动或命名复合配置，或直接传递 DebugConfiguration 来开始调试。命名配置在给定文件夹中的 '.vscode/launch.json' 中查找。调试开始前，所有未保存的文件都会保存，并且启动配置会更新到最新。配置中使用的文件夹特定变量（例如 '${workspaceFolder}'）会根据给定文件夹解析。

停止给定的调试会话，如果省略 session，则停止所有调试会话。

应用程序的托管位置。在桌面上是 'desktop'，在 web 上是指定的嵌入者，即 'github.dev'、'codespaces'，如果嵌入者未提供该信息，则为 'web'。

编辑器的应用程序名称，例如 'VS Code'。

编辑器运行的应用程序根文件夹。

注意，当在没有应用程序根文件夹表示的环境中运行时，该值为空字符串。

系统剪贴板。

指示这是应用程序的新安装。如果在安装的第一天内，则为 true，否则为 false。

指示用户是否已启用遥测。可以观察此值以确定扩展是否应发送遥测数据。

表示用户首选语言，例如 de-CH、fr 或 en-US。

编辑器当前的日志级别。

计算机的唯一标识符。

远程的名称。由扩展定义，常见的示例是用于适用于 Linux 的 Windows 子系统的 wsl 或用于使用安全 shell 的远程的 ssh-remote。

注意，当没有远程扩展宿主时，该值为 undefined，但如果存在远程扩展宿主，则该值在所有扩展宿主（本地和远程）中都会定义。使用 Extension.extensionKind 来判断特定扩展是否在远程运行。

当前会话的唯一标识符。每次启动编辑器时都会更改。

检测到的扩展宿主的默认 shell，此值会被扩展宿主平台的 terminal.integrated.defaultProfile 设置覆盖。请注意，在不支持 shell 的环境中，该值为空字符串。

UI 类型属性指示从哪个 UI 访问扩展。例如，可以从桌面应用程序或 Web 浏览器访问扩展。

编辑器在操作系统中注册的自定义 uri scheme。

当编辑器日志级别更改时触发的 Event。

当默认 shell 更改时触发的 Event。此事件会带上新的 shell 路径。

当用户启用或禁用遥测时触发的 Event。如果用户已启用遥测，则为 true；如果用户已禁用遥测，则为 false。

将 uri 解析为可在外部访问的形式。

http: 或 https: scheme

将扩展运行位置的外部 uri（例如 http: 或 https: 链接）解析为客户端计算机上同一资源的 uri。

如果扩展在客户端计算机上运行，则此操作是空操作。

如果扩展在远程运行，此函数会自动在本地计算机和远程的 target 之间建立端口转发隧道，并返回指向隧道的本地 uri。端口转发隧道的生命周期由编辑器管理，用户可以关闭隧道。

注意，通过 openExternal 传递的 uri 会自动解析，因此你不应在其上调用 asExternalUri。

vscode.env.uriScheme

创建一个 uri，如果在浏览器中打开（例如通过 openExternal），将触发已注册的 UriHandler。

扩展不应对生成的 uri 做任何假设，也不应以任何方式对其进行更改。相反，扩展可以例如在身份验证流程中使用此 uri，通过将 uri 作为回调查询参数添加到要进行身份验证的服务器。

注意，如果服务器决定向 uri 添加额外的查询参数（例如 token 或 secret），这些参数将出现在传递给 UriHandler 的 uri 中。

示例身份验证流程

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);

注意，扩展不应缓存 asExternalUri 的结果，因为解析后的 uri 可能会由于系统或用户操作而失效——例如，在远程情况下，用户可能会关闭由 asExternalUri 打开的端口转发隧道。

任何其他 scheme

任何其他 scheme 都将像提供的 URI 是工作区 URI 一样处理。在这种情况下，该方法将返回一个 URI，处理该 URI 将使编辑器打开工作区。

创建新的 遥测记录器。

使用默认应用程序外部打开链接。根据使用的 scheme，这可以是：

• 浏览器（http:, https:）
• 邮件客户端（mailto:）
• VS Code 本身（来自 vscode.env.uriScheme 的 vscode:）

注意，在编辑器内部打开文本文档的正确方法是 showTextDocument，而不是此函数。

系统当前已知的所有扩展。

当 extensions.all 更改时触发的事件。这可能发生在安装、卸载、启用或禁用扩展时。

通过其完整标识符（格式为：publisher.name）获取扩展。

已为扩展加载的本地化字符串包。如果没有加载包，则为 undefined。如果找不到包或运行时使用默认语言，通常不会加载包。

已为扩展加载的本地化包的 URI。如果没有加载包，则为 undefined。如果找不到包或运行时使用默认语言，通常不会加载包。

将字符串标记为需要本地化。如果 env.language 指定的语言有可用的本地化包，并且该包对此消息有本地化值，则将返回该本地化值（对于任何模板值，注入 args 值）。

示例

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

将字符串标记为需要本地化。如果 env.language 指定的语言有可用的本地化包，并且该包对此消息有本地化值，则将返回该本地化值（对于任何模板值，注入 args 值）。

示例

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

将字符串标记为需要本地化。如果 env.language 指定的语言有可用的本地化包，并且该包对此消息有本地化值，则将返回该本地化值（对于任何模板值，注入 args 值）。

当全局诊断集发生变化时触发的 Event。这包括新添加和移除的诊断。

创建一个诊断集合。

创建一个新的语言状态栏项。

获取给定资源的全部诊断。

获取全部诊断。

返回所有已知语言的标识符。

计算文档选择器与文档之间的匹配度。大于零的值表示选择器匹配文档。

匹配度根据以下规则计算

1. 当DocumentSelector是一个数组时，计算其中包含的每个 DocumentFilter 或语言标识符的匹配度，并取最大值。
2. 字符串将被解构为DocumentFilter的语言部分，因此 "fooLang" 类似于 { language: "fooLang" }。
3. DocumentFilter 将通过将其各部分与文档进行比较来匹配文档。遵循以下规则：
   1. 当 DocumentFilter 为空 ({}) 时，结果为 0
   2. 当 scheme、language、pattern 或 notebook 已定义但其中之一不匹配时，结果为 0
   3. 与 * 匹配的分数为 5，通过相等或 glob 模式匹配的分数为 10
   4. 结果为各项匹配的最大值

示例

// 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); // 5
match('fooLang', doc); // 0
match(['fooLang', '*'], doc); // 5

// virtual document, e.g. from git-index
doc.uri; // 'git:/my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript', scheme: 'git' }, doc); // 10;
match('*', doc); // 5

// notebook cell document
doc.uri; // `vscode-notebook-cell:///my/notebook.ipynb#gl65s2pmha`;
doc.languageId; // 'python'
match({ notebookType: 'jupyter-notebook' }, doc); // 10
match({ notebookType: 'fooNotebook', language: 'python' }, doc); // 0
match({ language: 'python' }, doc); // 10
match({ notebookType: '*' }, doc); // 5

注册一个调用层次结构提供程序。

注册一个代码操作提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个代码镜头提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个颜色提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个补全提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序按其分数排序，并按顺序请求分数相同的提供程序组提供补全项。当一个组中的一个或多个提供程序返回结果时，该过程停止。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

补全项提供程序可以关联一组 triggerCharacters。当输入触发字符时，会请求补全，但只从注册了输入字符的提供程序请求。因此，触发字符应与词字符不同，常见的触发字符是 .，用于触发成员补全。

注册一个声明提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个定义提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个新的DocumentDropEditProvider。

可以为一个语言注册多个拖放提供程序。将内容拖放到编辑器中时，将根据其DocumentDropEditProviderMetadata中指定的处理的 MIME 类型调用该编辑器语言的所有注册提供程序。

每个提供程序可以返回一个或多个DocumentDropEdits。编辑使用DocumentDropEdit.yieldTo属性进行排序。默认情况下将应用第一个编辑。如果有其他编辑，这些编辑将作为可选择的拖放选项显示在拖放小部件中。

注册一个文档格式化提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序按其分数排序，并使用最佳匹配的提供程序。选定提供程序的失败将导致整个操作失败。

注册一个文档高亮提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序按其分数排序，并按顺序请求组提供文档高亮。当提供程序返回非假值或非失败结果时，该过程停止。

注册一个文档链接提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个新的DocumentPasteEditProvider。

可以为一个语言注册多个提供程序。对于复制和粘贴操作，将根据DocumentPasteProviderMetadata中指定的处理的 MIME 类型调用该语言的所有注册提供程序。

对于复制操作，每个提供程序对DataTransfer所做的更改将合并到一个用于填充剪贴板的单一DataTransfer中。

对于[DocumentPasteEditProvider.providerDocumentPasteEdits 粘贴操作](#DocumentPasteEditProvider.providerDocumentPasteEdits paste operations)，将调用每个提供程序，并且每个提供程序可以返回一个或多个DocumentPasteEdits。编辑使用DocumentPasteEdit.yieldTo属性进行排序。默认情况下将应用第一个编辑，其余编辑将作为可选择的粘贴选项显示在粘贴小部件中。

registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable

注册一个文档范围格式化提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序按其分数排序，并使用最佳匹配的提供程序。选定提供程序的失败将导致整个操作失败。

registerDocumentRangeSemanticTokensProvider(selector: DocumentSelector, provider: DocumentRangeSemanticTokensProvider, legend: SemanticTokensLegend): Disposable

注册一个文档范围的语义标记提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序按其分数排序，并使用最佳匹配的提供程序。选定提供程序的失败将导致整个操作失败。

为整个文档注册一个语义令牌提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序按其分数排序，并使用最佳匹配的提供程序。选定提供程序的失败将导致整个操作失败。

一个文档语义标记提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

关于提供程序的元数据

registerEvaluatableExpressionProvider(selector: DocumentSelector, provider: EvaluatableExpressionProvider): Disposable

一个可求值表达式提供程序。

registerFoldingRangeProvider(selector: DocumentSelector, provider: FoldingRangeProvider): Disposable

注册一个折叠范围提供程序。

一个折叠范围提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

一个 hover 提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

一个实现提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

一个内嵌提示提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

一个行内补全提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

一个行内值提供程序。

registerLinkedEditingRangeProvider(selector: DocumentSelector, provider: LinkedEditingRangeProvider): Disposable

一个链接编辑范围提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序按其分数排序，并使用最佳匹配的提供程序。选定提供程序的失败将导致整个操作失败。

更多触发字符。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

一个引用提供程序。

registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable

一个重命名提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

一个选择范围提供程序。

registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable

当用户键入其中一个字符（例如 , 或 (）时触发签名帮助。

关于提供程序的信息。

可以为一个语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（被拒绝的 Promise 或异常）不会导致整个操作失败。

一个类型定义提供程序。

一个类型层次结构提供程序。

registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider<SymbolInformation>): Disposable

一个工作区符号提供程序。

一个释放时取消此配置的Disposable。

setTextDocumentLanguage(document: TextDocument, languageId: string): Thenable<TextDocument>

语言模型相关功能的命名空间。

使用lm.registerTool注册的所有扩展提供的所有可用工具的列表。可以通过lm.invokeTool调用这些工具，输入与它们声明的inputSchema相匹配。

当可用聊天模型集合发生变化时触发的事件。

invokeTool(name: string, options: LanguageModelToolInvocationOptions<object>, token?: CancellationToken): Thenable<LanguageModelToolResult>

通过名称调用lm.tools中列出的工具，并提供给定输入。输入将根据工具声明的 schema 进行验证。

工具可以由聊天参与者在处理聊天请求的上下文中调用，也可以由任何扩展在全球范围内以任何自定义流程调用。

在前一种情况下，调用者应传递toolInvocationToken，该 token 随聊天请求一起提供。这确保聊天 UI 为正确的会话显示工具调用。

工具调用的结果。

registerMcpServerDefinitionProvider(id: string, provider: McpServerDefinitionProvider<McpServerDefinition>): Disposable

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

注册一个提供程序，用于发布供编辑器使用的 Model Context Protocol 服务器。这使得 MCP 服务器可以除了用户在其配置文件中创建的服务器外，还可以动态地提供给编辑器。

释放时注销提供程序的 disposable。

通过一个 selector 选择聊天模型。这可能会产生多个或零个聊天模型，扩展必须妥善处理这些情况，尤其是在不存在聊天模型时。

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
}

释放时注销工具的Disposable。

selectChatModels(selector?: LanguageModelChatSelector): Thenable<LanguageModelChat[]>

NotebookController 管理 Notebook 的执行，例如它们从代码单元格生成输出。

控制器的执行处理程序。

• NotebookController
• 一个新的 Notebook 控制器。

要与之通信的渲染器 ID

provider: NotebookCellStatusBarItemProvider

• 一个单元格状态栏提供程序。

inputBox: SourceControlInputBox

SourceControl

Task 功能的命名空间。

当前活动的任务执行或一个空数组。

当任务结束时触发。

当底层进程结束时触发。对于不执行底层进程的任务，此事件不会触发。

当任务开始时触发。

• onDidStartTaskProcess: Event<TaskProcessStartEvent>

要执行的任务

可选的筛选器，用于选择特定类型或版本的任务。

provider: TaskProvider<Task>

TestController

用于处理编辑器当前窗口的命名空间。即可见的和活动的编辑器，以及用于显示消息、选区和请求用户输入的 UI 元素。

设置中配置的当前活动颜色主题。活动主题可以通过 workbench.colorTheme 设置进行更改。

当前活动的Notebook 编辑器或 undefined。活动编辑器是当前具有焦点或在没有焦点时最近更改输入的编辑器。

当前活动的终端或 undefined。活动终端是当前具有焦点或最近具有焦点的终端。

当前活动的编辑器或 undefined。活动编辑器是当前具有焦点或在没有焦点时最近更改输入的编辑器。

表示当前窗口的状态。

表示主编辑器区域内的网格小部件。

当前打开的终端或一个空数组。

当前可见的Notebook 编辑器或一个空数组。

当前可见的编辑器或一个空数组。

当活动颜色主题更改或发生更改时触发的Event。

当活动 Notebook 编辑器更改时触发的Event。*注意*，当活动编辑器更改为 undefined 时，此事件也会触发。

当活动终端更改时触发的Event。*注意*，当活动终端更改为 undefined 时，此事件也会触发。

当活动编辑器更改时触发的Event。*注意*，当活动编辑器更改为 undefined 时，此事件也会触发。

当Notebook 编辑器选区更改时触发的Event。

当Notebook 编辑器可见范围更改时触发的Event。

当终端中的 shell 集成激活或其属性之一更改时触发。

当终端的状态更改时触发的Event。

当编辑器选项更改时触发的Event。

当编辑器选区更改时触发的Event。

当编辑器视图列更改时触发的Event。

当编辑器可见范围更改时触发的Event。

当可见 Notebook 编辑器更改时触发的Event。

当终端被释放时触发的 Event。

当终端命令结束时将触发此事件。仅当终端的 shell 集成被激活时才会触发此事件。

当通过 createTerminal API 或命令创建终端时触发的 Event。

当终端命令开始时将触发此事件。仅当终端的 shell 集成被激活时才会触发此事件。

创建一个 InputBox，用于让用户输入一些文本。

请注意，在许多情况下，更便捷的 window.showInputBox 更易于使用。window.createInputBox 应在 window.showInputBox 无法提供所需灵活性时使用。

创建一个新的输出通道，具有给定的名称和语言 ID。如果未提供语言 ID，则默认使用 Log 作为语言 ID。

您可以从可见编辑器或活动编辑器中将可见或活动的输出通道作为文本文档进行访问，并使用语言 ID 来贡献语法高亮、Code Lens 等语言特性。

创建一个新的日志输出通道，具有给定的名称。

创建一个 QuickPick，用于让用户从 T 类型列表中选取一项。

请注意，在许多情况下，更便捷的 window.showQuickPick 更易于使用。window.createQuickPick 应在 window.showQuickPick 无法提供所需灵活性时使用。

创建状态栏项。

创建状态栏项。

另请参见 createStatusBarItem，用于创建带有标识符的状态栏项。

创建一个具有支持 shell 进程的 Terminal。如果存在，终端的当前工作目录将是工作区目录。

• 抛出 - 在无法启动新进程的环境中运行时。

创建一个具有支持 shell 进程的 Terminal。

• 抛出 - 在无法启动新进程的环境中运行时。

创建一个 Terminal，其输入和输出由扩展控制。

创建可用于向文本编辑器添加装饰的 TextEditorDecorationType。

使用扩展点 views 创建一个贡献视图的 TreeView。

创建并显示一个新的 webview 面板。

为由 customEditors 扩展点贡献的 viewType 注册自定义编辑器提供程序。

打开自定义编辑器时，将触发 onCustomEditor:viewType 激活事件。您的扩展必须在激活过程中为 viewType 注册一个 CustomTextEditorProvider、CustomReadonlyEditorProvider、CustomEditorProvider。

注册文件装饰提供程序。

注册一个提供程序，用于在终端内启用链接检测和处理。

注册一个贡献终端配置文件的提供程序。

为使用扩展点 views 贡献的视图注册一个 TreeDataProvider。这将允许您向 TreeView 贡献数据并在数据更改时更新。

注意： 要访问 TreeView 并对其执行操作，请使用 createTreeView。

注册一个能够处理系统级 uri 的 uri 处理程序。如果打开了多个窗口，最顶层的窗口将处理 uri。uri 处理程序的作用范围限定在其贡献扩展内；它只能处理指向扩展自身的 uri。uri 必须遵守以下规则：

• uri 方案必须是 vscode.env.uriScheme；
• uri 授权必须是扩展 ID（例如 my.extension）；
• uri 路径、查询和片段部分是任意的。

例如，如果 my.extension 扩展注册了 uri 处理程序，它将只被允许处理前缀为 product-name://my.extension 的 uri。

扩展在其整个激活生命周期内只能注册一个 uri 处理程序。

• 注意：当指向当前扩展的 uri 即将被处理时，会触发一个激活事件 onUri。

注册 webview 面板序列化程序。

支持恢复的扩展应具有 "onWebviewPanel:viewType" 激活事件，并确保在激活期间调用 registerWebviewPanelSerializer。

对于给定的 viewType，一次只能注册一个序列化程序。

注册一个新的 webview 视图提供程序。

在状态栏设置一条消息。这是功能更强大的状态栏项的简写形式。

在状态栏设置一条消息。这是功能更强大的状态栏项的简写形式。

在状态栏设置一条消息。这是功能更强大的状态栏项的简写形式。

注意，状态栏消息会堆叠，并且在使用完毕后必须释放。

显示一条错误消息。

另请参见 showInformationMessage

显示一条错误消息。

另请参见 showInformationMessage

显示一条错误消息。

另请参见 showInformationMessage

显示一条错误消息。

另请参见 showInformationMessage

向用户显示一条信息消息。可选地提供一个项数组，这些项将显示为可点击的按钮。

向用户显示一条信息消息。可选地提供一个项数组，这些项将显示为可点击的按钮。

显示一条信息消息。

另请参见 showInformationMessage

显示一条信息消息。

另请参见 showInformationMessage

打开一个输入框，请求用户输入。

如果输入框被取消（例如按 ESC 键），返回的值将是 undefined。否则，返回的值将是用户输入的字符串，如果用户没有输入任何内容但按 OK 关闭了输入框，则返回空字符串。

在笔记本编辑器中显示给定的NotebookDocument。

向用户显示一个文件打开对话框，允许选择要打开的文件。

显示一个允许多选的选取列表。

显示一个选取列表。

显示一个允许多选的选取列表。

显示一个选取列表。