VS Code API

當身份驗證提供程式的身份驗證會話被新增、刪除或更改時觸發的 Event。

獲取使用者登入的指定提供程式的所有賬戶。與 getSession 配對使用，以便獲取特定賬戶的身份驗證會話。

目前，編輯器內建的擴充套件貢獻了兩個身份驗證提供程式，分別實現了 GitHub 和 Microsoft 身份驗證：它們的 providerId 分別是 'github' 和 'microsoft'。

注意：獲取賬戶並不意味著您的擴充套件可以訪問該賬戶或其身份驗證會話。您可以透過呼叫 getSession 來驗證對賬戶的訪問許可權。

獲取匹配所需範圍或滿足 WWW-Authenticate 請求的身份驗證會話。如果未註冊具有 providerId 的提供程式，或者使用者不同意與擴充套件共享身份驗證資訊，則會引發拒絕。如果存在多個具有相同範圍的會話，使用者將看到一個快速選擇器來選擇他們想要使用的賬戶。

內建身份驗證提供程式包括

• 'github' - 用於 GitHub.com
• 'microsoft' - 用於個人和組織 Microsoft 賬戶
• (不太常見) 'github-enterprise' - 用於替代 GitHub 主機，GHE.com，GitHub Enterprise Server
• (不太常見) 'microsoft-sovereign-cloud' - 用於替代 Microsoft 雲

獲取匹配所需範圍或請求的身份驗證會話。如果未註冊具有 providerId 的提供程式，或者使用者不同意與擴充套件共享身份驗證資訊，則會引發拒絕。如果存在多個具有相同範圍的會話，使用者將看到一個快速選擇器來選擇他們想要使用的賬戶。

內建身份驗證提供程式包括

• 'github' - 用於 GitHub.com
• 'microsoft' - 用於個人和組織 Microsoft 賬戶
• (不太常見) 'github-enterprise' - 用於替代 GitHub 主機，GHE.com，GitHub Enterprise Server
• (不太常見) 'microsoft-sovereign-cloud' - 用於替代 Microsoft 雲

獲取匹配所需範圍或請求的身份驗證會話。如果未註冊具有 providerId 的提供程式，或者使用者不同意與擴充套件共享身份驗證資訊，則會引發拒絕。如果存在多個具有相同範圍的會話，使用者將看到一個快速選擇器來選擇他們想要使用的賬戶。

內建身份驗證提供程式包括

• 'github' - 用於 GitHub.com
• 'microsoft' - 用於個人和組織 Microsoft 賬戶
• (不太常見) 'github-enterprise' - 用於替代 GitHub 主機，GHE.com，GitHub Enterprise Server
• (不太常見) 'microsoft-sovereign-cloud' - 用於替代 Microsoft 雲

註冊一個身份驗證提供程式。

每個 ID 只能有一個提供程式，並且當另一個提供程式已使用某個 ID 時會引發錯誤。ID 是區分大小寫的。

建立一個新的 聊天參與者 例項。

執行由給定命令識別符號表示的命令。

• 注意 1：在執行編輯器命令時，並非所有型別都可以作為引數傳遞。允許的型別是原始型別 string、boolean、number、undefined 和 null，以及 Position、Range、Uri 和 Location。
• 注意 2：在執行由擴充套件貢獻的命令時，沒有限制。

檢索所有可用命令的列表。以下劃線開頭的命令被視為內部命令。

註冊一個可以透過鍵盤快捷鍵、選單項、操作或直接呼叫的命令。

使用現有的命令識別符號重複註冊命令將導致錯誤。

註冊一個可以透過鍵盤快捷鍵、選單項、操作或直接呼叫的文字編輯器命令。

文字編輯器命令與普通 命令 不同，它們僅在呼叫命令時存在活動編輯器時執行。此外，編輯器命令的處理程式可以訪問活動編輯器和一個 edit-builder。請注意，edit-builder 僅在回撥執行期間有效。

建立一個新的 評論控制器 例項。

當前活動的 除錯控制檯。如果沒有活動除錯會話，傳送到除錯控制檯的輸出將不會顯示。

當前活動的 除錯會話 或 undefined。活動除錯會話是由除錯操作浮動視窗表示的會話，或者當前顯示在除錯操作浮動視窗下拉選單中的會話。如果沒有活動除錯會話，則值為 undefined。

當前聚焦的執行緒或堆疊幀，或者 undefined（如果沒有聚焦執行緒或堆疊）。只要有活動的除錯會話，執行緒就可以被聚焦；而堆疊幀只有在會話暫停並且已檢索到呼叫堆疊時才能被聚焦。

斷點列表。

當 活動除錯會話 更改時觸發的 Event。注意，當活動除錯會話更改為 undefined 時，該事件也會觸發。

當 debug.activeStackItem 更改時觸發的事件。

當斷點集被新增、刪除或更改時發出的 Event。

當從 除錯會話 收到自定義 DAP 事件時觸發的 Event。

當一個新的 除錯會話 啟動時觸發的 Event。

當 除錯會話 終止時觸發的 Event。

新增斷點。

將透過除錯介面卡協議接收到的“Source”描述符物件轉換為可用於載入其內容的 URI。如果源描述符基於路徑，則返回檔案 URI。如果源描述符使用引用號，則會構造一個特定的除錯 URI（方案為“debug”），該 URI 需要一個相應的 ContentProvider 和一個正在執行的除錯會話。

如果“Source”描述符資訊不足以建立 URI，則會引發錯誤。

為特定除錯型別註冊 除錯介面卡描述符工廠。擴充套件只能為其定義的除錯型別註冊 DebugAdapterDescriptorFactory。否則會引發錯誤。為同一除錯型別註冊多個 DebugAdapterDescriptorFactory 會導致錯誤。

為給定的除錯型別註冊除錯介面卡跟蹤器工廠。

為特定除錯型別註冊 除錯配置提供程式。可選的 triggerKind 可用於指定何時觸發提供程式的 provideDebugConfigurations 方法。目前有兩種觸發方式：使用 Initial（或未提供觸發引數）值時，provideDebugConfigurations 方法用於提供要複製到新建立的 launch.json 的初始除錯配置。使用 Dynamic 觸發方式時，provideDebugConfigurations 方法用於動態確定要呈現給使用者的除錯配置（除了 launch.json 中的靜態配置）。請注意，triggerKind 引數僅適用於 provideDebugConfigurations 方法：因此 resolveDebugConfiguration 方法不受任何影響。為不同觸發方式註冊具有 resolve 方法的單個提供程式會導致相同的 resolve 方法被呼叫多次。可以為同一型別註冊多個提供程式。

刪除斷點。

透過使用命名啟動或命名複合配置，或直接傳遞 DebugConfiguration 來啟動除錯。命名配置在給定資料夾中的 '.vscode/launch.json' 中查詢。在除錯開始之前，所有未儲存的檔案都會被儲存，並且啟動配置會更新到最新。配置中使用的資料夾特定變數（例如 '${workspaceFolder}'）會根據給定的資料夾進行解析。

停止給定的除錯會話，或在省略 session 時停止所有除錯會話。

應用程式的託管位置。在桌面版上是 'desktop'。在 Web 版上是指定的嵌入器，例如 'github.dev'、'codespaces' 或 'web'（如果嵌入器未提供該資訊）。

編輯器的應用程式名稱，例如 'VS Code'。

編輯器執行的應用程式根資料夾。

請注意，當在沒有應用程式根資料夾表示的環境中執行時，該值為空字串。

系統剪貼簿。

指示這是應用程式的全新安裝。如果在安裝後的第一天內為 true，否則為 false。

指示使用者是否啟用了遙測。可以觀察此值來確定擴充套件是否應傳送遙測資料。

表示首選使用者語言，例如 de-CH、fr 或 en-US。

編輯器的當前日誌級別。

計算機的唯一識別符號。

遠端資源的名稱。由擴充套件定義，常見的示例是 Linux 的 Windows 子系統（Windows Subsystem for Linux）的 wsl，或者使用安全外殼（secure shell）的遠端資源的 ssh-remote。

請注意，當沒有遠端擴充套件主機時，該值為 undefined。但如果存在遠端擴充套件主機，則在所有擴充套件主機（本地和遠端）中該值都是已定義的。請使用 Extension.extensionKind 來了解特定擴充套件是否在遠端執行。

當前會話的唯一識別符號。每次啟動編輯器時都會更改。

檢測到的擴充套件主機預設 shell，它會被擴充套件主機平臺的 terminal.integrated.defaultProfile 設定覆蓋。請注意，在不支援 shell 的環境中，此值為空字串。

UI kind 屬性指示從哪個 UI 訪問擴充套件。例如，擴充套件可以從桌面應用程式或 Web 瀏覽器訪問。

編輯器在作業系統中註冊的自定義 URI 方案。

當編輯器的日誌級別發生變化時觸發的 事件。

預設 shell 更改時觸發的 事件。該事件會傳遞新的 shell 路徑。

當用戶啟用或停用遙測時觸發的 事件。如果使用者啟用了遙測，則為 true；如果使用者停用了遙測，則為 false。

將 URI 解析為外部可訪問的形式。

http: 或 https: 方案

將擴充套件正在執行的外部 URI（例如 http: 或 https: 連結）解析為客戶端機器上相同資源的 URI。

如果擴充套件在客戶端機器上執行，則此操作無效。

如果擴充套件在遠端執行，此函式會自動建立從本地機器到遠端 target 的埠轉發隧道，並返回到該隧道的本地 URI。埠轉發隧道的生命週期由編輯器管理，並且使用者可以關閉隧道。

請注意，透過 openExternal 傳遞的 URI 會自動解析，您不應對它們呼叫 asExternalUri。

vscode.env.uriScheme

建立一個 URI，如果該 URI 在瀏覽器中開啟（例如透過 openExternal），將觸發已註冊的 UriHandler。

擴充套件不應假定結果 URI 的任何內容，也不應以任何方式修改它。相反，擴充套件可以使用此 URI 進行身份驗證流程，例如將其作為回撥查詢引數新增到要身份驗證的伺服器。

請注意，如果伺服器決定向 URI 新增額外的查詢引數（例如令牌或金鑰），這些引數將出現在傳遞給 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 開啟的埠轉發隧道。

任何其他方案

任何其他方案都將被視為工作區 URI。在這種情況下，該方法將返回一個 URI，當處理該 URI 時，編輯器將開啟工作區。

建立一個新的 遙測記錄器。

使用預設應用程式在外部開啟連結。根據所使用的方案，這可以是

• 瀏覽器（http:, https:）
• 郵件客戶端（mailto:）
• VSCode 本身（來自 vscode.env.uriScheme 的 vscode:）

請注意，showTextDocument 是在編輯器內部開啟文字文件的正確方法，而不是此函式。

當前系統已知的 au 擴充套件。

當 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 值）。

全域性診斷集發生變化時觸發的 事件。這是新新增和移除的診斷。

建立診斷集合。

建立一個新的 語言狀態項。

獲取給定資源的 au 診斷。

獲取 au 診斷。

返回所有已知語言的識別符號。

計算文件 選擇器 與文件之間的匹配。大於零的值表示選擇器匹配文件。

匹配根據以下規則計算

1. 當 DocumentSelector 為陣列時，計算包含的每個 DocumentFilter 或語言識別符號的匹配項，並取最大值。
2. 字串將被解構，成為 DocumentFilter 的 language 部分，因此 "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 或異常）不會導致整個操作失敗。

註冊程式碼 Lens 提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊顏色提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊補全提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將按其 分數 排序，並且具有相同分數的組將被順序地詢問補全項。當一個或多個提供程式返回結果時，該過程停止。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

補全項提供程式可以與一組 triggerCharacters 關聯。當鍵入觸發字元時，會請求補全，但僅從註冊了鍵入字元的提供程式處請求。因此，觸發字元應與 字詞字元 不同，常見的觸發字元是 . 以觸發成員補全。

註冊宣告提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊定義提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個新的 DocumentDropEditProvider。

可以為一種語言註冊多個拖放提供程式。將內容拖放到編輯器中時，將根據它們處理的 MIME 型別（由其 DocumentDropEditProviderMetadata 指定）呼叫該編輯器註冊的所有提供程式。

每個提供程式可以返回一個或多個 DocumentDropEdits。編輯會根據 DocumentDropEdit.yieldTo 屬性進行排序。預設情況下，將應用第一個編輯。如果存在其他編輯，這些編輯將顯示給使用者，作為拖放控制元件中可選的拖放選項。

註冊文件的格式化提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將按其 分數 排序，並使用最佳匹配的提供程式。所選提供程式的失敗將導致整個操作失敗。

註冊文件高亮提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將按其 分數 排序，並按順序詢問文件高亮。當提供程式返回 非假值 或 非失敗 結果時，該過程停止。

註冊文件連結提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個新的 DocumentPasteEditProvider。

可以為一種語言註冊多個提供程式。所有已註冊的語言提供程式都將根據其處理的 MIME 型別（由 DocumentPasteProviderMetadata 指定）在複製和貼上操作中呼叫。

對於 複製操作，每個提供程式對 DataTransfer 所做的更改將合併到一個用於填充剪貼簿的 DataTransfer 中。

對於 [DocumentPasteEditProvider.providerDocumentPasteEdits 貼上操作](#_DocumentPasteEditProvider.providerDocumentPasteEdits 貼上操作)，將呼叫每個提供程式，並且它們可以返回一個或多個 DocumentPasteEdits。編輯會根據 DocumentPasteEdit.yieldTo 屬性進行排序。預設情況下，將應用第一個編輯，其餘編輯將顯示給使用者，作為貼上控制元件中可選的貼上選項。

為文件範圍註冊格式化提供程式。

注意： 文件範圍提供程式也是一個 文件格式化程式，這意味著在註冊範圍提供程式時，無需 註冊 文件格式化程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將按其 分數 排序，並使用最佳匹配的提供程式。所選提供程式的失敗將導致整個操作失敗。

為文件範圍註冊語義令牌提供程式。

注意： 如果一個文件同時擁有 DocumentSemanticTokensProvider 和 DocumentRangeSemanticTokensProvider，則範圍提供程式僅在最初被呼叫，用於完全文件提供程式解析第一個請求所需的時間。一旦完全文件提供程式解析了第一個請求，透過範圍提供程式提供的語義令牌將被丟棄，此後將僅使用文件提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將按其 分數 排序，並使用最佳匹配的提供程式。所選提供程式的失敗將導致整個操作失敗。

為整個文件註冊語義令牌提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將按其 分數 排序，並使用最佳匹配的提供程式。所選提供程式的失敗將導致整個操作失敗。

註冊文件符號提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個用於在文字文件中定位可求值表示式的提供程式。編輯器將在活動除錯會話中求值表示式，並在除錯懸停時顯示結果。

如果為語言註冊了多個提供程式，則將使用任意一個提供程式。

註冊摺疊範圍提供程式。

可以為語言註冊多個提供程式。在這種情況下，提供程式會並行請求，並將結果合併。如果多個摺疊範圍從同一位置開始，則僅使用第一個註冊提供程式的結果。如果摺疊範圍與一個位置更小的範圍重疊，它也會被忽略。

失敗的提供程式（承諾被拒絕或丟擲異常）不會導致整個操作失敗。

註冊懸停提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊實現提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊內嵌提示提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊內聯完成提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊一個為偵錯程式的“內聯值”功能提供資料的提供程式。每當通用偵錯程式在原始檔中停止時，就會呼叫為該檔案語言註冊的提供程式，以返回將在編輯器行末顯示的文字資料。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊連結編輯範圍提供程式。

可以為語言註冊多個提供程式。在這種情況下，提供程式將按其 得分 進行排序，並使用具有結果的最佳匹配提供程式。選定提供程式的失敗將導致整個操作失敗。

註冊一個在鍵入時工作的格式化提供程式。當用戶啟用 editor.formatOnType 設定時，該提供程式將處於活動狀態。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將按其 分數 排序，並使用最佳匹配的提供程式。所選提供程式的失敗將導致整個操作失敗。

註冊引用提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊重新命名提供程式。

可以為語言註冊多個提供程式。在這種情況下，提供程式將按其 得分 進行排序，並按順序請求。第一個生成結果的提供程式定義了整個操作的結果。

註冊選擇範圍提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊簽名幫助提供程式。

可以為語言註冊多個提供程式。在這種情況下，提供程式將按其 得分 進行排序，並按順序呼叫，直到某個提供程式返回有效結果。

另請參閱 languages.registerSignatureHelpProvider

註冊型別定義提供程式。

可以為一種語言註冊多個提供程式。在這種情況下，提供程式將並行被呼叫，結果將被合併。失敗的提供程式（拒絕的 Promise 或異常）不會導致整個操作失敗。

註冊型別層次結構提供程式。

註冊工作區符號提供程式。

可以註冊多個提供程式。在這種情況下，提供程式會並行請求，並將結果合併。失敗的提供程式（承諾被拒絕或丟擲異常）不會導致整個操作失敗。

為語言設定 語言配置。

設定（並更改）與給定文件關聯的 語言。

注意，呼叫此函式將觸發 onDidCloseTextDocument 事件，然後是 onDidOpenTextDocument 事件。

所有可用工具的列表，這些工具已透過 lm.registerTool 由所有擴充套件程式註冊。它們可以使用 lm.invokeTool 呼叫，其輸入應與宣告的 inputSchema 匹配。

當可用聊天模型集發生變化時觸發的事件。

透過名稱和給定的輸入呼叫 lm.tools 中列出的工具。輸入將根據工具宣告的模式進行驗證。

工具可以由聊天參與者在處理聊天請求的上下文中呼叫，也可以由任何擴充套件在任何自定義流程中全域性呼叫。

在前一種情況下，呼叫者應傳遞 toolInvocationToken（來自 聊天請求），這可以確保聊天 UI 為正確的對話顯示工具呼叫。

工具 結果 是一個由 文字 和 prompt-tsx 部分組成的陣列。如果工具呼叫者使用 vscode/prompt-tsx，它可以將響應部分合併到其提示中使用 ToolResult。如果不是，則可以將這些部分透過帶有 LanguageModelToolResultPart 的使用者訊息傳遞給 LanguageModelChat。

如果聊天參與者希望保留跨多輪的工具結果，它可以將工具結果儲存在處理程式返回的 ChatResult.metadata 中，並在下一輪從 ChatResponseTurn.result 中檢索它們。

註冊一個 LanguageModelChatProvider。注意：您還必須透過 package.json 中的 languageModelChatProviders 貢獻點來定義語言模型聊天提供程式。

註冊一個提供程式，該程式釋出模型上下文協議（MCP）伺服器供編輯器使用。這允許 MCP 伺服器動態地提供給編輯器，而不僅僅是使用者在其配置檔案中建立的伺服器。

在此方法呼叫之前，擴充套件必須使用相應的 id 註冊 contributes.mcpServerDefinitionProviders 擴充套件點，例如：

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

當新的 McpServerDefinitionProvider 可用時，編輯器預設會在提交聊天訊息時自動呼叫它來發現新伺服器和工具。要啟用此流程，擴充套件應在啟用期間呼叫 registerMcpServerDefinitionProvider。

註冊一個 LanguageModelTool。該工具還必須在 package.json 的 languageModelTools 貢獻點中註冊。註冊的工具可在 lm.tools 列表中供任何擴充套件檢視。但是，為了讓語言模型看到它，它必須在 LanguageModelChatRequestOptions.tools 中提供的可用工具列表中。

透過 選擇器 選擇聊天模型。這可能會產生零個或多個聊天模型，擴充套件程式必須優雅地處理這些情況，特別是當不存在聊天模型時。

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
}

可以選擇器來廣泛匹配特定供應商或系列的模型，也可以透過 ID 來精確選擇單個模型。請記住，可用模型的集合會隨時間變化，而且提示在不同模型上的表現也可能不同。

注意，擴充套件程式可以保留此函式返回的結果並稍後使用。但是，當 onDidChangeChatModels 事件觸發時，聊天模型列表可能會發生變化，擴充套件程式應重新查詢。

建立一個新的筆記本控制器。

建立一個用於與特定渲染器通訊的新訊息例項。

• 注意 1：擴充套件只能建立它們在其 package.json 檔案中定義的渲染器。
• 注意 2：只有當渲染器的 notebookRenderer 貢獻中 requiresMessaging 設定為 always 或 optional 時，渲染器才能訪問訊息功能。

為給定的筆記本型別註冊一個 單元格狀態列項提供程式。

擴充套件建立的最後一個源控制元件的 輸入框。

• 已棄用 - 請改用 SourceControl.inputBox

建立一個新的 源控制元件 例項。

當前活動的任務執行，或者一個空陣列。

任務結束時觸發。

底層程序結束時觸發。此事件不會為不執行底層程序的任務觸發。

任務開始時觸發。

底層程序啟動時觸發。此事件不會為不執行底層程序的任務觸發。

執行由編輯器管理的任務。返回的任務執行可用於終止任務。

• 丟擲 - 當在無法啟動新程序的環境中執行 ShellExecution 或 ProcessExecution 任務時。在此類環境中，只能執行 CustomExecution 任務。

獲取系統中所有可用的任務。這包括來自 tasks.json 檔案的任務，以及透過擴充套件貢獻的任務提供程式中的任務。

註冊一個任務提供程式。

建立一個新的測試控制器。

根據設定配置的當前活動顏色主題。活動主題可以透過 workbench.colorTheme 設定進行更改。

當前活動的 筆記本編輯器 或 undefined。活動編輯器是當前具有焦點編輯器，或者在沒有編輯器有焦點時，是最近更改輸入的編輯器。

當前活動的終端或 undefined。活動終端是當前具有焦點或最近擁有焦點的終端。

當前活動的編輯器或 undefined。活動編輯器是當前具有焦點編輯器，或者在沒有編輯器有焦點時，是最近更改輸入的編輯器。

表示當前視窗的狀態。

表示主編輯器區域內的網格小部件

當前開啟的終端，或者一個空陣列。

當前可見的 筆記本編輯器，或者一個空陣列。

當前可見的編輯器，或者一個空陣列。

當活動顏色主題更改或發生更改時觸發的 Event。

當 活動筆記本編輯器 更改時觸發的 Event。注意，當活動編輯器更改為 undefined 時，事件也會觸發。

當 活動終端 更改時觸發的 Event。注意，當活動終端更改為 undefined 時，事件也會觸發。

當 活動編輯器 更改時觸發的 Event。注意，當活動編輯器更改為 undefined 時，事件也會觸發。

當 筆記本編輯器選擇 更改時觸發的 Event。

當 筆記本編輯器可見範圍 更改時觸發的 Event。

當終端中的 Shell Integration 啟用或其某個屬性更改時觸發。

當 終端狀態 更改時觸發的 Event。

當編輯器的選項更改時觸發的 Event。

當編輯器中的選區更改時觸發的 Event。

當編輯器的檢視列更改時觸發的 Event。

當編輯器的可見範圍更改時觸發的 Event。

當 可見筆記本編輯器 陣列更改時觸發的 Event。

當 可見編輯器 陣列更改時觸發的 Event。

噹噹前視窗的焦點或活動狀態更改時觸發的 Event。事件的值表示視窗是否獲得焦點。

當終端被釋放時觸發的 Event。

當終端命令結束時觸發。此事件僅在終端 激活了 Shell Integration 時觸發。

當終端被建立時（透過 createTerminal API 或命令）觸發的 Event。

當終端命令開始時觸發。此事件僅在終端 激活了 Shell Integration 時觸發。

建立一個 InputBox，讓使用者輸入文字。

請注意，在許多情況下，更方便的 window.showInputBox 更易於使用。window.createInputBox 應在 window.showInputBox 不提供所需靈活性時使用。

使用給定的名稱和語言 ID 建立一個新的 輸出通道。如果未提供語言 ID，則使用 Log 作為預設語言 ID。

您可以從 可見編輯器 或 活動編輯器 訪問可見或活動的輸出通道，作為 文字文件，並使用語言 ID 來貢獻語言功能，如語法著色、程式碼 Lens 等。

使用給定的名稱建立一個新的 日誌輸出通道。

建立一個 QuickPick，讓使用者從 T 型別項的列表中選擇一個項。

請注意，在許多情況下，更方便的 window.showQuickPick 更易於使用。window.createQuickPick 應在 window.showQuickPick 不提供所需靈活性時使用。

建立一個狀態列 項。

建立一個狀態列 項。

另請參閱 createStatusBarItem，用於建立帶識別符號的狀態列項。

使用後備 shell 程序建立一個 Terminal。終端的 cwd 將是工作區目錄（如果存在）。

• 丟擲 - 當在無法啟動新程序的環境中執行時。

使用後備 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 處理程式。

• 注意：存在一個 onUri 啟用事件，當一個指向當前擴充套件程式的 URI 即將處理時，該事件會被觸發。

註冊 Webview 面板序列化器。

支援恢復的擴充套件程式應具有 "onWebviewPanel:viewType" 啟用事件，並確保在啟用期間呼叫 registerWebviewPanelSerializer。

對於給定的 viewType，一次只能註冊一個序列化器。

為 Webview 檢視註冊新的提供程式。

在狀態列上設定一條訊息。這是更強大的狀態列 專案 的簡寫。

在狀態列上設定一條訊息。這是更強大的狀態列 專案 的簡寫。

在狀態列上設定一條訊息。這是更強大的狀態列 專案 的簡寫。

注意狀態列訊息會堆疊，並且在使用完畢後必須將其 disposed。

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

向用戶顯示資訊訊息。可以選擇提供一個數組的專案，這些專案將顯示為可點選的按鈕。

向用戶顯示資訊訊息。可以選擇提供一個數組的專案，這些專案將顯示為可點選的按鈕。

顯示資訊訊息。

另請參閱 showInformationMessage

顯示資訊訊息。

另請參閱 showInformationMessage

開啟一個輸入框，要求使用者輸入。

如果輸入框被取消（例如，按 ESC 鍵），則返回值將是 undefined。否則，返回值將是使用者鍵入的字串，如果使用者未鍵入任何內容但用 OK 按鈕關閉了輸入框，則返回空字串。

在 筆記本編輯器 中顯示給定的 NotebookDocument。

向用戶顯示檔案開啟對話方塊，允許選擇要開啟的檔案。

顯示一個允許多選的選項列表。

顯示一個選項列表。

顯示一個允許多選的選項列表。

顯示一個選項列表。