VS Code API

當驗證提供者的驗證工作階段被新增、移除或變更時觸發的 事件 (Event)。

取得使用者針對指定提供者登入的所有帳戶。將此函式與 getSession 搭配使用，以取得特定帳戶的驗證工作階段。

目前，編輯器內建的擴充功能僅提供兩個驗證提供者，分別實現 GitHub 與 Microsoft 驗證：其 providerId 分別為 'github' 與 'microsoft'。

注意：取得帳戶並不代表您的擴充功能擁有存取該帳戶或其驗證工作階段的權限。您可以透過呼叫 getSession 來驗證對該帳戶的存取權。

取得符合所需範圍或滿足 WWW-Authenticate 請求的驗證工作階段。若 providerId 對應的提供者未註冊，或使用者不同意與擴充功能共用驗證資訊，將會拒絕 (Reject)。若存在多個具有相同範圍的工作階段，將會向使用者顯示選單，讓其選擇要使用的帳戶。

內建的驗證提供者包括：

• 'github' - 針對 GitHub.com
• 'microsoft' - 針對個人與組織 Microsoft 帳戶
• (較少見) 'github-enterprise' - 針對替代的 GitHub 託管服務，如 GHE.com、GitHub Enterprise Server
• (較少見) 'microsoft-sovereign-cloud' - 針對替代的 Microsoft 雲端

取得符合所需範圍或請求的驗證工作階段。若 providerId 對應的提供者未註冊，或使用者不同意與擴充功能共用驗證資訊，將會拒絕 (Reject)。若存在多個具有相同範圍的工作階段，將會向使用者顯示選單，讓其選擇要使用的帳戶。

內建的驗證提供者包括：

• 'github' - 針對 GitHub.com
• 'microsoft' - 針對個人與組織 Microsoft 帳戶
• (較少見) 'github-enterprise' - 針對替代的 GitHub 託管服務，如 GHE.com、GitHub Enterprise Server
• (較少見) 'microsoft-sovereign-cloud' - 針對替代的 Microsoft 雲端

取得符合所需範圍或請求的驗證工作階段。若 providerId 對應的提供者未註冊，或使用者不同意與擴充功能共用驗證資訊，將會拒絕 (Reject)。若存在多個具有相同範圍的工作階段，將會向使用者顯示選單，讓其選擇要使用的帳戶。

內建的驗證提供者包括：

• '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)。注意，編輯建構器僅在回呼函式執行期間有效。

建立一個新的 註解控制器 實例。

目前活動的 除錯主控台 (debug console)。若沒有活動的除錯工作階段，傳送到除錯主控台的輸出將不會顯示。

目前活動的 除錯工作階段 (debug session) 或 undefined。活動除錯工作階段是由除錯動作浮動視窗所代表的，或者是目前在除錯動作浮動視窗的下拉式選單中顯示的那一個。若無活動工作階段，則值為 undefined。

目前聚焦的執行緒或堆疊框架；若無聚焦的執行緒或堆疊，則為 undefined。只要有活動的除錯工作階段，執行緒即可隨時被聚焦；而堆疊框架僅在工作階段暫停且已擷取呼叫堆疊時才能被聚焦。

中斷點清單。

當 活動除錯工作階段 變更時觸發的 事件。注意：當活動除錯工作階段變更為 undefined 時，此事件也會觸發。

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

當一組中斷點被新增、移除或變更時發出的 事件。

當從 除錯工作階段 接收到自訂 DAP 事件時觸發的 事件。

當新的 除錯工作階段 啟動時觸發的 事件。

當 除錯工作階段 終止時觸發的 事件。

新增中斷點。

將透過除錯轉接器協定 (Debug Adapter Protocol) 接收的「Source」描述符物件轉換為可用於載入其內容的 Uri。若來源描述符基於路徑，則回傳檔案 Uri。若來源描述符使用參考編號，則會建構一個特定的除錯 Uri（scheme 為 'debug'），這需要對應的 ContentProvider 和正在執行的除錯工作階段。

若「Source」描述符沒有足夠的資訊來建立 Uri，將會拋出錯誤。

為特定的除錯類型註冊 除錯轉接器描述符工廠。擴充功能僅允許為該擴充功能所定義的除錯類型註冊 DebugAdapterDescriptorFactory，否則會拋出錯誤。為同一種除錯類型註冊多個 DebugAdapterDescriptorFactory 會導致錯誤。

為給定的除錯類型註冊除錯轉接器追蹤工廠。

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

移除中斷點。

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

停止指定的除錯工作階段，若省略則停止所有除錯工作階段。

應用程式的託管位置。在桌機版上為 'desktop'，在 Web 上則是指定的嵌入器，即 'github.dev'、'codespaces'；若嵌入器未提供該資訊，則為 'web'。

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

執行編輯器的應用程式根目錄。

註：在沒有應用程式根目錄概念的環境中執行時，該值為空字串。

系統剪貼簿。

指出應用程式是否以可攜模式 (portable mode) 執行。

當應用程式從包含 data 目錄的資料夾執行時，便會啟用可攜模式，這允許自包含的安裝。

深入了解 可攜模式。

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

指出使用者是否啟用了遙測功能。可用於觀察擴充功能是否應該傳送遙測資料。

代表使用者偏好的語言，如 de-CH、fr 或 en-US。

編輯器目前的紀錄等級。

電腦的唯一識別碼。

遠端名稱。由擴充功能定義，常見範例有用於 Windows Linux 子系統的 wsl，或用於使用 Secure Shell 之遠端的 ssh-remote。

註：當沒有遠端擴充功能主機時，該值為 undefined；若存在遠端擴充功能主機，則該值在所有擴充功能主機（本機與遠端）中均有定義。請使用 Extension.extensionKind 來確認特定擴充功能是否在遠端執行。

目前工作階段的唯一識別碼。每次啟動編輯器時都會變更。

擴充功能主機偵測到的預設 Shell，此值會被 terminal.integrated.defaultProfile 設定（針對擴充功能主機的平台）所覆蓋。注意：在不支援 Shell 的環境中，該值為空字串。

UI 類型屬性指示擴充功能從哪個 UI 存取。例如，擴充功能可以從桌面應用程式或網頁瀏覽器存取。

編輯器在作業系統中註冊的自訂 URI 配置 (scheme)。

當編輯器的紀錄等級變更時觸發的 事件。

當預設 Shell 變更時觸發的 事件。此事件會伴隨新的 Shell 路徑觸發。

當使用者啟用或停用遙測功能時觸發的 事件。若使用者啟用遙測則為 true，若停用則為 false。

將 URI 解析為外部可存取的形式。

http: 或 https: 配置

將從擴充功能執行位置解析到的「外部」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 開啟的連接埠轉發通道。

任何其他配置

任何其他配置將會被視為工作區 URI 處理。在此情況下，該方法將回傳一個 URI，處理後將會使編輯器開啟該工作區。

建立新的 遙測紀錄器 (telemetry logger)。

使用預設應用程式在外部開啟連結。根據所使用的配置，這可能是：

• 瀏覽器 (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 值）。

當全域診斷集變更時觸發的 事件。這包括新增和移除的診斷。

建立診斷集合。

建立新的 語言狀態項目。

取得給定資源的所有診斷資訊。

取得所有診斷資訊。

回傳所有已知語言的識別碼。

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

匹配程度根據以下規則計算：

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 或例外）不會導致整個操作失敗。

註冊 Code Lens 提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊色彩提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊自動完成提供者。

可以為一種語言註冊多個提供者。在此情況下，提供者會根據其 評分 進行排序，並循序詢問評分相同的組別以取得完成項目。當群組中的一個或多個提供者回傳結果時，程序即停止。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

自動完成項目提供者可以關聯一組 triggerCharacters。當輸入觸發字元時，會請求自動完成，但僅從註冊該觸發字元的提供者請求。因此，觸發字元應與 單字字元 不同，常見的觸發字元是 . 以觸發成員自動完成。

註冊宣告提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊定義提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊新的 DocumentDropEditProvider。

可以為一種語言註冊多個放置 (drop) 提供者。將內容拖放至編輯器時，所有已註冊的該語言提供者會根據其 DocumentDropEditProviderMetadata 中指定的 MIME 類型進行呼叫。

每個提供者可以回傳一個或多個 DocumentDropEdits。編輯結果會使用 DocumentDropEdit.yieldTo 屬性進行排序。預設會套用第一個編輯。若有任何額外的編輯，將會作為可選的放置選項顯示給使用者。

註冊文件格式化提供者。

可以為一種語言註冊多個提供者。在此情況下，提供者會根據其 評分 進行排序，並使用最匹配的提供者。選定的提供者失敗會導致整個操作失敗。

註冊文件標示 (highlight) 提供者。

可以為一種語言註冊多個提供者。在此情況下，提供者會根據其 評分 進行排序，並循序詢問群組以取得文件標示。當提供者回傳 non-falsy 或 non-failure 結果時，程序即停止。

註冊文件連結提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊新的 DocumentPasteEditProvider。

可以為一種語言註冊多個提供者。所有已註冊的該語言提供者會根據 DocumentPasteProviderMetadata 中指定的處理 MIME 類型，針對複製與貼上操作進行呼叫。

針對 複製操作，每個提供者對 DataTransfer 所做的變更會合併為單一 DataTransfer，用於填入剪貼簿。

針對 貼上操作，會呼叫每個提供者，它們可以回傳一個或多個 DocumentPasteEdits。編輯結果會使用 DocumentPasteEdit.yieldTo 屬性進行排序。預設會套用第一個編輯，其餘編輯則會作為可選的貼上選項顯示於貼上小工具中。

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

註：文件範圍提供者同時也是 文件格式化器，這意味著當註冊範圍提供者時，無需再 註冊 文件格式化器。

可以為一種語言註冊多個提供者。在此情況下，提供者會根據其 評分 進行排序，並使用最匹配的提供者。選定的提供者失敗會導致整個操作失敗。

註冊文件範圍語義 Token 提供者。

註：若文件同時擁有 DocumentSemanticTokensProvider 和 DocumentRangeSemanticTokensProvider，範圍提供者僅會在初始階段呼叫，直到完整文件提供者解析完第一個請求為止。一旦完整文件提供者解析了第一個請求，透過範圍提供者提供的語義 Token 將會被捨棄，此後將僅使用文件提供者。

可以為一種語言註冊多個提供者。在此情況下，提供者會根據其 評分 進行排序，並使用最匹配的提供者。選定的提供者失敗會導致整個操作失敗。

為整個文件註冊語意標記提供者。

可以為一種語言註冊多個提供者。在此情況下，提供者會根據其 評分 進行排序，並使用最匹配的提供者。選定的提供者失敗會導致整個操作失敗。

註冊文件符號提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊一個在文字文件中定位可評估表達式的提供者。編輯器將在活躍的除錯階段中評估該表達式，並在除錯懸停視窗中顯示結果。

如果為某種語言註冊了多個提供者，則會使用任意一個提供者。

註冊折疊範圍提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問這些提供者，並將結果合併。如果多個折疊範圍在相同位置開始，則僅使用第一個註冊的提供者的範圍。如果折疊範圍與另一個位置更小的範圍重疊，它也會被忽略。

失敗的提供者（被拒絕的 Promise 或例外狀況）不會導致整個操作失敗。

註冊懸停（Hover）提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊實作（Implementation）提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊內嵌提示（Inlay Hints）提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊行內補全提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊一個為偵錯器的「行內值（inline value）」功能回傳資料的提供者。每當通用偵錯器在原始檔案中暫停時，就會呼叫為該檔案語言註冊的提供者，以回傳將顯示在編輯器行尾的文字資料。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊關聯編輯範圍提供者。

可以為一種語言註冊多個提供者。在此情況下，提供者會根據其 評分 進行排序，並使用具有結果且最相符的提供者。所選提供者失敗將導致整個操作失敗。

註冊一個在輸入時進行格式化的提供者。當使用者啟用設定 editor.formatOnType 時，該提供者將處於活動狀態。

可以為一種語言註冊多個提供者。在此情況下，提供者會根據其 評分 進行排序，並使用最匹配的提供者。選定的提供者失敗會導致整個操作失敗。

註冊參照提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊重新命名（Rename）提供者。

可以為一種語言註冊多個提供者。在此情況下，提供者會根據其 評分 排序並依序詢問。第一個產生結果的提供者將決定整個操作的結果。

註冊選擇範圍提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊簽章說明（Signature Help）提供者。

可以為一種語言註冊多個提供者。在此情況下，提供者會根據其 評分 排序，並依序呼叫直到某個提供者回傳有效結果為止。

請參閱 languages.registerSignatureHelpProvider

註冊型別定義提供者。

可以為一種語言註冊多個提供者。在此情況下，將會平行詢問提供者並合併結果。失敗的提供者（被拒絕的 promise 或例外）不會導致整個操作失敗。

註冊型別階層提供者。

註冊工作區符號提供者。

可以註冊多個提供者。在此情況下，會平行詢問這些提供者，並合併結果。失敗的提供者（被拒絕的 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 貢獻點定義語言模型聊天提供者。

註冊一個提供者，該提供者發布模型內容協定（Model Context Protocol）伺服器供編輯器使用。這允許除了使用者在設定檔中建立的伺服器外，還能動態地向編輯器提供 MCP 伺服器。

在呼叫此方法之前，擴充功能必須註冊 contributes.mcpServerDefinitionProviders 擴充點，並附上對應的 id，例如：

    "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。活躍編輯器是當前擁有焦點的編輯器；如果沒有焦點，則是最近變更過輸入的編輯器。

代表當前視窗的狀態。

代表主編輯器區域內的網格小工具（grid widget）。

當前開啟的終端機或空陣列。

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

當前可見的編輯器或空陣列。

當活躍色彩主題變更或有所變更時觸發的 事件。

當 活躍筆記本編輯器 變更時觸發的 事件。注意，當活躍編輯器變更為 undefined 時，此事件也會觸發。

當 活躍終端機 變更時觸發的 事件。注意，當活躍終端機變更為 undefined 時，此事件也會觸發。

當 活躍編輯器 變更時觸發的 事件。注意，當活躍編輯器變更為 undefined 時，此事件也會觸發。

當 筆記本編輯器選擇範圍 變更時觸發的 事件。

當 筆記本編輯器可見範圍 變更時觸發的 事件。

當 Shell 整合啟動，或終端機中的任一屬性變更時觸發。

當 終端機狀態 變更時觸發的 事件。

當編輯器的選項變更時觸發的 事件。

當編輯器中的選擇範圍變更時觸發的 事件。

當編輯器的檢視欄（view column）變更時觸發的 事件。

當編輯器的可見範圍變更時觸發的 事件。

當 可見筆記本編輯器 變更時觸發的 事件。

當 可見編輯器 陣列變更時觸發的 事件。

當當前視窗的焦點或活動狀態變更時觸發的 事件。事件的值表示視窗是否具有焦點。

當終端機被處置時觸發的 事件。

當終端機指令結束時會觸發此事件。此事件僅在終端機啟動 Shell 整合 時才會觸發。

當終端機透過 createTerminal API 或命令建立時觸發的 事件。

當終端機指令開始時會觸發此事件。此事件僅在終端機啟動 Shell 整合 時才會觸發。

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

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

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

您可以從 可見編輯器 或 活躍編輯器 將可見或活躍的輸出頻道存取為 文字文件，並使用語言 ID 來貢獻語法著色、程式碼透鏡（code lens）等語言功能。

建立一個具有給定名稱的新 日誌輸出頻道。

建立一個 QuickPick 以讓使用者從 T 類型項目的清單中選擇一個項目。

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

建立狀態列 項目。

建立狀態列 項目。

請參閱 createStatusBarItem，了解如何建立帶有識別碼的狀態列項目。

建立一個帶有後端 Shell 處理序的 終端機。如果工作區目錄存在，終端機的 cwd 將為該工作區目錄。

• 丟出 - 當在無法啟動新處理序的環境中執行時。

建立一個帶有後端 Shell 處理序的 終端機。

• 丟出 - 當在無法啟動新處理序的環境中執行時。

建立一個由擴充功能控制其輸入和輸出的 終端機。

建立一個可用於將裝飾（decorations）新增至文字編輯器的 TextEditorDecorationType。

為使用擴充點 views 貢獻的檢視建立 TreeView。

建立並顯示一個新的 Webview 面板。

為 customEditors 擴充點所貢獻的 viewType 註冊自訂編輯器提供者。

當開啟自訂編輯器時，會觸發 onCustomEditor:viewType 啟動事件。您的擴充功能必須註冊 CustomTextEditorProvider、CustomReadonlyEditorProvider 或 CustomEditorProvider 作為啟動的一部分，以對應 viewType。

註冊檔案裝飾提供者。

註冊啟用終端機內連結檢測和處理的提供者。

為貢獻的終端機設定檔註冊提供者。

為使用擴充點 views 貢獻的檢視註冊 TreeDataProvider。這將允許您將資料貢獻給 TreeView，並在資料變更時進行更新。

注意：若要存取 TreeView 並執行操作，請使用 createTreeView。

註冊一個能夠處理全系統 uris 的 uri 處理器。如果開啟了多個視窗，最上層視窗將處理該 uri。uri 處理器的範圍限於貢獻它的擴充功能；它只能處理指向該擴充功能本身的 uris。uri 必須遵守以下規則：

• uri-scheme 必須是 vscode.env.uriScheme；
• uri-authority 必須是擴充功能 ID（例如 my.extension）；
• uri-path、-query 和 -fragment 部分可以是任意的。

例如，如果 my.extension 擴充功能註冊了一個 uri 處理器，它將只能處理具有前綴 product-name://my.extension 的 uris。

擴充功能在其整個啟動生命週期中只能註冊一個 uri 處理器。

• 注意：有一個啟動事件 onUri，當即將處理指向當前擴充功能的 uri 時會觸發。

註冊 Webview 面板序列化器。

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

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

為 Webview 檢視註冊一個新的提供者。

在狀態列設定訊息。這是功能更強大的狀態列 項目 的簡寫。

在狀態列設定訊息。這是功能更強大的狀態列 項目 的簡寫。

在狀態列設定訊息。這是功能更強大的狀態列 項目 的簡寫。

注意，狀態列訊息會堆疊，並且在不再使用時必須進行處置。

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

向使用者顯示資訊訊息。可選擇性地提供一組項目，這些項目將呈現為可點選的按鈕。

向使用者顯示資訊訊息。可選擇性地提供一組項目，這些項目將呈現為可點選的按鈕。

顯示資訊訊息。

另請參閱 showInformationMessage

顯示資訊訊息。

另請參閱 showInformationMessage

開啟輸入框以要求使用者輸入。

若輸入框被取消（例如按下 ESC），回傳值將為 undefined。否則，回傳值為使用者輸入的字串；若使用者未輸入任何內容但透過 OK 按鈕關閉輸入框，則回傳空字串。

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

向使用者顯示檔案開啟對話框，允許選擇檔案進行開啟操作。

顯示一個允許進行多重選擇的清單。

顯示一個選擇清單。

顯示一個允許進行多重選擇的清單。