VS Code API

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

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

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

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

取得符合所需範圍或滿足 WWW-Authenticate 要求的驗證工作階段。如果未註冊具備該 providerId 的提供者，或者使用者不同意與擴充功能共用驗證資訊，將會拒絕 (reject)。如果有具有相同範圍的多個工作階段，將會向使用者顯示快速挑選 (quickpick) 以選擇他們想要使用的帳戶。

內建驗證提供者包含

• 'github' - 適用於 GitHub.com
• 'microsoft' 適用於個人與組織 Microsoft 帳戶
• (較少見) 'github-enterprise' - 適用於其他 GitHub 主機代管、GHE.com、GitHub Enterprise Server
• (較少見) 'microsoft-sovereign-cloud' - 適用於其他 Microsoft 雲端

取得符合所需範圍或要求的驗證工作階段。如果未註冊具備該 providerId 的提供者，或者使用者不同意與擴充功能共用驗證資訊，將會拒絕 (reject)。如果有具有相同範圍的多個工作階段，將會向使用者顯示快速挑選 (quickpick) 以選擇他們想要使用的帳戶。

內建驗證提供者包含

• 'github' - 適用於 GitHub.com
• 'microsoft' 適用於個人與組織 Microsoft 帳戶
• (較少見) 'github-enterprise' - 適用於其他 GitHub 主機代管、GHE.com、GitHub Enterprise Server
• (較少見) 'microsoft-sovereign-cloud' - 適用於其他 Microsoft 雲端

取得符合所需範圍或要求的驗證工作階段。如果未註冊具備該 providerId 的提供者，或者使用者不同意與擴充功能共用驗證資訊，將會拒絕 (reject)。如果有具有相同範圍的多個工作階段，將會向使用者顯示快速挑選 (quickpick) 以選擇他們想要使用的帳戶。

內建驗證提供者包含

• 'github' - 適用於 GitHub.com
• 'microsoft' 適用於個人與組織 Microsoft 帳戶
• (較少見) 'github-enterprise' - 適用於其他 GitHub 主機代管、GHE.com、GitHub Enterprise Server
• (較少見) 'microsoft-sovereign-cloud' - 適用於其他 Microsoft 雲端

註冊驗證提供者。

每個識別碼 (id) 只能有一個提供者，當某個識別碼已被其他提供者使用時，將會擲回錯誤。識別碼會區分大小寫。

建立新的 聊天參與者 實例。

執行由給定命令識別碼所代表的命令。

• 註解 1：當執行編輯器命令時，並非所有類型都可以作為引數傳遞。允許的類型包括基本類型 string、boolean、number、undefined 和 null，以及 Position、Range、Uri 和 Location。
• 註解 2：執行由擴充功能所提供的命令時，沒有任何限制。

擷取所有可用命令的清單。以底線開頭的命令會被視為內部命令。

註冊一個可以透過鍵盤快速鍵、功能表項目、動作或直接呼叫的命令。

使用現有的命令識別碼註冊命令兩次將會造成錯誤。

註冊一個可以透過鍵盤快速鍵、功能表項目、動作或直接呼叫的文字編輯器命令。

文字編輯器命令與一般 命令 不同，因為它們只有在呼叫命令時有作用中編輯器存在時才會執行。此外，編輯器命令的命令處理常式可以存取作用中編輯器以及 edit 建立器。請注意，edit 建立器僅在回呼執行期間有效。

建立新的 comment controller 實例。

目前作用中的 debug console。如果沒有作用中的偵錯工作階段，傳送到偵錯主控台的輸出將不會顯示。

目前作用中的 debug session 或 undefined。作用中的偵錯工作階段是由偵錯動作浮動視窗所代表的工作階段，或是目前顯示在偵錯動作浮動視窗下拉式功能表中的工作階段。如果沒有作用中的偵錯工作階段，其值為 undefined。

目前取得焦點的執行緒或堆疊框架，如果沒有執行緒或堆疊取得焦點，則為 undefined。只要有作用中的偵錯工作階段，隨時都可以對執行緒取得焦點，而堆疊框架只有在工作階段暫停且已擷取呼叫堆疊時才能取得焦點。

中斷點清單。

當 active debug session 變更時觸發的 Event。注意，當作用中的偵錯工作階段變更為 undefined 時也會觸發此事件。

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

當中斷點集合被新增、移除或變更時發出的 Event。

從 debug session 接收到自訂 DAP 事件時觸發的 Event。

當新的 debug session 啟動時觸發的 Event。

當 debug session 終止時觸發的 Event。

新增中斷點。

將透過偵錯介面卡通訊協定 (Debug Adapter Protocol) 接收到的 "Source" 描述元物件轉換為可用於載入其內容的 Uri。如果原始程式描述元是基於路徑，則會傳回檔案 Uri。如果原始程式描述元使用參照編號，則會建構一個需要對應的 ContentProvider 與執行中偵錯工作階段的特定偵錯 Uri（配置為 'debug'）

如果 "Source" 描述元沒有足夠的資訊來建立 Uri，將會擲回錯誤。

為特定的偵錯類型註冊 debug adapter descriptor factory。擴充功能僅被允許為該擴充功能所定義的偵錯類型註冊 DebugAdapterDescriptorFactory。否則將會擲回錯誤。為同一個偵錯類型註冊多個 DebugAdapterDescriptorFactory 會導致錯誤。

為給定的偵錯類型註冊偵錯介面卡追蹤器處理站 (debug adapter tracker factory)。

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

移除中斷點。

使用具名啟動組態、具名複合組態，或直接傳遞 DebugConfiguration 來開始偵錯。具名組態會在給定資料夾中的 '.vscode/launch.json' 內進行尋找。在偵錯開始之前，所有未儲存的檔案都會被儲存，並且啟動組態會更新至最新狀態。組態中使用的資料夾特定變數（例如 '${workspaceFolder}'）會針對給定的資料夾進行解析。

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

應用程式的主機託管位置。在桌面版上這是 'desktop'。在網頁版上這是指定的嵌入器 (embedder)，即 'github.dev'、'codespaces'，如果嵌入器未提供該資訊則為 'web'

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

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

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

系統剪貼簿。

指出應用程式是否以可攜式模式執行。

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

深入了解 可攜式模式。

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

指出使用者是否啟用了遙測 (telemetry)。可以透過觀察它來決定擴充功能是否應該傳送遙測。

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

編輯器的目前記錄層級。

電腦的唯一識別碼。

遠端名稱。由擴充功能定義，常見的範例有用於 Linux Windows 子系統的 wsl，或用於使用安全殼層 (secure shell) 之遠端的 ssh-remote。

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

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

偵測到的擴充功能主機預設命令列殼層 (shell)，這會被擴充功能主機平台的 terminal.integrated.defaultProfile 設定所覆寫。請注意，在不支援 shell 的環境中，該值為空字串。

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

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

當編輯器的記錄層級變更時觸發的 Event。

當預設 shell 變更時觸發的 Event。這會帶著新的 shell 路徑一起觸發。

當使用者啟用或停用遙測時觸發的 Event。如果使用者已啟用遙測則為 true，如果使用者已停用遙測則為 false。

將 uri 解析為可在外部存取的格式。

http: 或 https: 配置

將擴充功能執行所在位置的 外部 uri（例如 http: or https: 連結），解析為用戶端機器上相同資源的 uri。

如果擴充功能正在用戶端機器上執行，這是一個無動作 (no-op)。

如果擴充功能正在遠端執行，此函式會自動建立從本機到遠端 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 來處理。在這種情況下，該方法將傳回一個 URI，當處理該 URI 時，會使編輯器開啟該工作區。

建立新的 telemetry logger。

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

• 瀏覽器 (http:, https:)
• 電郵用戶端 (mailto:)
• VS Code 本身 (來自 vscode.env.uriScheme 的 vscode:)

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

目前系統已知的所有擴充功能。

當 extensions.all 變更時觸發的事件。當安裝、解除安裝、啟用或停用擴充功能時，可能會發生這種情況。

透過其完整識別碼（格式為：publisher.name）取得擴充功能。

已為擴充功能載入的在地化字串組合 (bundle)。如果尚未載入任何組合，則為 undefined。如果找不到組合或我們正在使用預設語言執行時，通常不會載入該組合。

已為擴充功能載入的在地化組合 URI。如果尚未載入任何組合，則為 undefined。如果找不到組合或我們正在使用預設語言執行時，通常不會載入該組合。

將字串標記為需要在地化。如果 env.language 指定的語言有可用的在地化組合，且該組合具有此訊息的在地化值，則會傳回該在地化值（並為任何範本化值注入 args 值）。

範例

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

將字串標記為需要在地化。如果 env.language 指定的語言有可用的在地化組合，且該組合具有此訊息的在地化值，則會傳回該在地化值（並為任何範本化值注入 args 值）。

範例

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

將字串標記為需要在地化。如果 env.language 指定的語言有可用的在地化組合，且該組合具有此訊息的在地化值，則會傳回該在地化值（並為任何範本化值注入 args 值）。

當全域診斷集合變更時觸發的 Event。這是指新新增和移除的診斷。

建立診斷集合。

建立新的 language status item。

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

取得所有診斷。

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

計算文件 selector 與文件之間的符合度。大於零的值表示選取器與文件相符。

符合度是根據以下規則計算的

1. 當 DocumentSelector 是陣列時，計算其中包含的每個 DocumentFilter 或語言識別碼的符合度，並取其最大值。
2. 字串將被去糖化 (desugared) 成為 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

註冊呼叫階層提供者 (call hierarchy provider)。

註冊程式碼動作提供者 (code action provider)。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊程式碼透鏡提供者 (code lens provider)。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊顏色提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊完成提供者 (completion provider)。

可以為某個語言註冊多個提供者。在這種情況下，提供者會根據其 score 進行排序，並依序向相同分數群組的提供者請求完成項目。當某個群組的一個或多個提供者傳回結果時，程序即會停止。失敗的提供者（拒絕的 promise 或例外狀況）不會使整個操作失敗。

完成項目提供者可以與一組 triggerCharacters 關聯。當輸入觸發字元時，會要求提供完成，但僅限於註冊了該輸入字元的提供者。因此，觸發字元應與 word characters 不同，常見的觸發字元是 .，用於觸發成員完成。

註冊宣告提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊定義提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊新的 DocumentDropEditProvider。

針對單一語言可以註冊多個放置提供者。當將內容拖放至編輯器時，將會根據其 DocumentDropEditProviderMetadata 所指定的處理 MIME 類型，來叫用編輯器語言的所有已註冊提供者。

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

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

針對單一語言可以註冊多個提供者。在該情況下，提供者會根據其 評分 進行排序，並使用最佳符合的提供者。所選提供者失敗將導致整個操作失敗。

註冊文件醒目提示提供者。

針對單一語言可以註冊多個提供者。在該情況下，提供者會根據其 評分 進行排序，並依序詢問各群組以取得文件醒目提示。當某個提供者傳回 non-falsy 或 non-failure 結果時，程序即會停止。

註冊文件連結提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊新的 DocumentPasteEditProvider。

針對單一語言可以註冊多個提供者。針對複製與貼上操作，語言的所有已註冊提供者將根據 DocumentPasteProviderMetadata 所指定的其所處理的 MIME 類型來叫用。

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

對於 [DocumentPasteEditProvider.providerDocumentPasteEdits 貼上操作](#DocumentPasteEditProvider.providerDocumentPasteEdits 貼上操作)，將叫用每個提供者並可傳回一或多個 DocumentPasteEdits。編輯會使用 DocumentPasteEdit.yieldTo 屬性進行排序。依預設將會套用第一個編輯，其餘編輯將在貼上小工具中作為可選取的貼上選項顯示給使用者。

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

注意：文件範圍提供者同時也是 文件格式化工具，這表示在註冊範圍提供者時，不需要另外 註冊 文件格式化工具。

針對單一語言可以註冊多個提供者。在該情況下，提供者會根據其 評分 進行排序，並使用最佳符合的提供者。所選提供者失敗將導致整個操作失敗。

註冊文件範圍的語意標記提供者。

注意：如果文件同時具有 DocumentSemanticTokensProvider 與 DocumentRangeSemanticTokensProvider，則範圍提供者僅會在最初叫用，即完整文件提供者解析第一個要求所需的時間內。一旦完整文件提供者解析了第一個要求，透過範圍提供者提供的語意標記將被捨棄，並且從該時間點開始，將僅使用文件提供者。

針對單一語言可以註冊多個提供者。在該情況下，提供者會根據其 評分 進行排序，並使用最佳符合的提供者。所選提供者失敗將導致整個操作失敗。

註冊整份文件的語意標記提供者。

針對單一語言可以註冊多個提供者。在該情況下，提供者會根據其 評分 進行排序，並使用最佳符合的提供者。所選提供者失敗將導致整個操作失敗。

註冊文件符號提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊一個可在文字文件中尋找可評估運算式的提供者。編輯器會在現用偵錯工作階段中評估該運算式，並在偵錯懸停提示中顯示結果。

如果針對某個語言註冊了多個提供者，將會任意使用其中一個提供者。

註冊摺疊範圍提供者。

針對單一語言可以註冊多個提供者。在該情況下，會以平行方式詢問提供者並合併結果。如果多個摺疊範圍從相同位置開始，則僅使用第一個註冊提供者的範圍。如果某個摺疊範圍與具有較小位置的其他範圍重疊，也會被忽略。

失敗的提供者 (拒絕的 promise 或例外狀況) 不會導致整個操作失敗。

註冊懸停提示提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊實作提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊內嵌提示提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊內嵌完成提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊一個傳回偵錯工具「內嵌值」功能資料的提供者。每當通用偵錯工具在原始程式檔中暫停時，就會呼叫針對該檔案語言註冊的提供者來傳回文字資料，該資料將顯示在編輯器行尾。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊連結編輯範圍提供者。

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

註冊在輸入時運作的格式化提供者。當使用者啟用設定 editor.formatOnType 時，此提供者會處於作用中狀態。

針對單一語言可以註冊多個提供者。在該情況下，提供者會根據其 評分 進行排序，並使用最佳符合的提供者。所選提供者失敗將導致整個操作失敗。

註冊參考提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊重新命名提供者。

針對單一語言可以註冊多個提供者。在該情況下，提供者會根據其 評分 進行排序並依序詢問。產生結果的第一個提供者會定義整個操作的結果。

註冊選取範圍提供者。

可以為某個語言註冊多個提供者。在這種情況下，會平行向各個提供者發出請求並將結果合併。失敗的提供者（拒絕的 promise 或例外狀況）不會導致整個操作失敗。

註冊簽章說明提供者。

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

另請參閱 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 伺服器給編輯器，作為使用者在其組態檔中所建立伺服器的補充。

在呼叫此方法之前，擴充功能必須使用對應的 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。現用編輯器是目前具有焦點的編輯器，或者當沒有任何編輯器具有焦點時，是最近變更輸入的編輯器。

表示目前視窗的狀態。

表示主編輯器區域內的網格小工具

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

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

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

當現用色彩佈景主題變更或有變更時引發的 事件。

當 現用筆記本編輯器 變更時引發的 事件。請注意，當現用編輯器變更為 undefined 時也會引發此事件。

當 現用終端機 變更時引發的 事件。請注意，當現用終端機變更為 undefined 時也會引發此事件。

當 現用編輯器 變更時引發的 事件。請注意，當現用編輯器變更為 undefined 時也會引發此事件。

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

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

當終端機中的 shell 整合啟動或其其中一個屬性變更時引發。

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

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

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

當編輯器的檢視欄位變更時引發的 事件。

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

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

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

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

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

當終端機命令結束時將會引發此事件。唯有針對該終端機啟動 shell 整合 時，才會引發此事件。

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

當終端機命令啟動時將會引發此事件。唯有針對該終端機啟動 shell 整合 時，才會引發此事件。

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

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

使用指定的名稱與語言識別項建立新的 輸出通道。如果未提供語言識別項，則會將 Log 用作預設語言識別項。

您可以從 可見編輯器 或 現用編輯器 將可見或現用的輸出通道存取為 文字文件，並使用語言識別項來貢獻語言功能，例如語法著色、程式碼透鏡等。

使用指定的名稱建立新的 記錄輸出通道。

建立 QuickPick 以讓使用者從 T 類型的一系列項目中挑選一個項目。

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

建立狀態列 項目。

建立狀態列 項目。

另請參閱 用於建立具有識別項之狀態列項目的 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-scheme 必須是 vscode.env.uriScheme；
• uri-authority 必須是擴充功能識別碼 (例如 my.extension)；
• uri-path、-query 和 -fragment 部分是任意的。

例如，如果 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。否則，傳回的值將會是使用者輸入的字串，或者如果使用者未輸入任何內容但透過 [確定] 關閉輸入方塊，則為空字串。

在 notebook 編輯器中顯示指定的 NotebookDocument。

向使用者顯示檔案開啟對話方塊，允許選取要開啟的檔案。

顯示允許多重選取的選取清單。

顯示選取清單。

顯示允許多重選取的選取清單。