VS Code API

當身份驗證提供者的身份驗證會話已新增、移除或變更時觸發的 事件。

取得使用者登入指定提供者的所有帳戶。搭配 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-builder。請注意，edit-builder 僅在回呼執行時有效。

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

目前活動的 除錯主控台。如果沒有活動的除錯會話，則不會顯示傳送到除錯主控台的輸出。

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

目前焦點所在的執行緒或堆疊框架，如果沒有執行緒或堆疊成為焦點，則為 undefined。只要有活動的除錯會話，執行緒就可以成為焦點，而堆疊框架只能在會話暫停且已檢索呼叫堆疊時才能成為焦點。

中斷點列表。

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

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

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

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

當新的 除錯會話 已啟動時觸發的 事件。

當 除錯會話 已終止時觸發的 事件。

新增中斷點。

將透過除錯配接器協定接收的 "Source" 描述符物件轉換為可用於載入其內容的 Uri。如果來源描述符基於路徑，則回傳檔案 Uri。如果來源描述符使用參考編號，則會建構特定的除錯 Uri (scheme 'debug')，這需要對應的 ContentProvider 和正在執行的除錯會話

如果 "Source" 描述符沒有足夠的資訊來建立 Uri，則會拋出錯誤。

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

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

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

移除中斷點。

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

停止給定的除錯會話，如果省略會話，則停止所有除錯會話。

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

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

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

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

系統剪貼簿。

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

指示使用者是否已啟用遙測。可以觀察以確定擴充功能是否應發送遙測。

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

編輯器目前的日誌等級。

電腦的唯一識別碼。

遠端的名稱。由擴充功能定義，常見範例是適用於 Windows Subsystem for Linux 的 wsl 或適用於使用安全 shell 的遠端的 ssh-remote。

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

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

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

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

編輯器在作業系統中註冊的自訂 URI 結構描述。

一個事件，會在編輯器的記錄層級變更時觸發。

一個事件，會在預設 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 (例如權杖或密碼)，則它將會出現在傳遞至 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 時，將會使編輯器開啟工作區。

建立新的 遙測記錄器。

使用預設應用程式從外部開啟連結。根據使用的結構描述，這可以是

• 瀏覽器 (http:, https:)
• 郵件用戶端 (mailto:)
• VSCode 本身 (vscode:，來自 vscode.env.uriScheme)

請注意，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 值)。

一個 事件，會在診斷的整體集合變更時觸發。這是新增和移除的診斷。

建立診斷集合。

建立新的 語言狀態項目。

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

取得所有診斷。

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

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

相符項是根據這些規則計算的

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

註冊程式碼鏡頭提供者。

可以為一種語言註冊多個提供者。在這種情況下，提供者會並行詢問，且結果會合併。失敗的提供者 (拒絕的 Promise 或例外狀況) 不會導致整個操作失敗。

註冊色彩提供者。

可以為一種語言註冊多個提供者。在這種情況下，提供者會並行詢問，且結果會合併。失敗的提供者 (拒絕的 Promise 或例外狀況) 不會導致整個操作失敗。

註冊完成提供者。

可以為一種語言註冊多個提供者。在這種情況下，提供者會依其 分數 排序，且分數相等的群組會依序要求完成項目。當群組中的一個或多個提供者傳回結果時，程序會停止。失敗的提供者 (拒絕的 Promise 或例外狀況) 不會導致整個操作失敗。

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

註冊宣告提供者。

可以為一種語言註冊多個提供者。在這種情況下，提供者會並行詢問，且結果會合併。失敗的提供者 (拒絕的 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 或例外狀況) 不會導致整個操作失敗。

註冊一個連結編輯範圍供應器。

可以為一種語言註冊多個供應器。在這種情況下，供應器會按其 score 排序，並使用具有結果的最佳匹配供應器。選定供應器失敗將導致整個操作失敗。

註冊一個在輸入時工作的格式化供應器。當使用者啟用設定 editor.formatOnType 時，此供應器處於活動狀態。

可以為一種語言註冊多個提供者。在這種情況下，提供者會依其 分數 排序，並使用最相符的提供者。選取的提供者失敗將會導致整個操作失敗。

註冊一個參考供應器。

可以為一種語言註冊多個提供者。在這種情況下，提供者會並行詢問，且結果會合併。失敗的提供者 (拒絕的 Promise 或例外狀況) 不會導致整個操作失敗。

註冊一個重新命名供應器。

可以為一種語言註冊多個供應器。在這種情況下，供應器會按其 score 排序並按順序詢問。第一個產生結果的供應器將定義整個操作的結果。

註冊一個選取範圍供應器。

可以為一種語言註冊多個提供者。在這種情況下，提供者會並行詢問，且結果會合併。失敗的提供者 (拒絕的 Promise 或例外狀況) 不會導致整個操作失敗。

註冊一個簽名幫助供應器。

可以為一種語言註冊多個供應器。在這種情況下，供應器會按其 score 排序，並依序呼叫，直到供應器傳回有效結果。

另請參閱 languages.registerSignatureHelpProvider

註冊一個類型定義供應器。

可以為一種語言註冊多個提供者。在這種情況下，提供者會並行詢問，且結果會合併。失敗的提供者 (拒絕的 Promise 或例外狀況) 不會導致整個操作失敗。

註冊一個類型階層供應器。

註冊一個工作區符號供應器。

可以註冊多個供應器。在這種情況下，將並行詢問供應器並合併結果。失敗的供應器（拒絕的 Promise 或異常）不會導致整個操作失敗。

為語言設定語言組態。

設定（和變更）與給定文件相關聯的 語言。

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

所有擴充功能使用 lm.registerTool 註冊的所有可用工具的清單。可以使用 lm.invokeTool 和符合其宣告的 inputSchema 的輸入來呼叫它們。

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

使用給定的輸入，依名稱呼叫 lm.tools 中列出的工具。輸入將根據工具宣告的結構描述進行驗證

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

在前一種情況下，呼叫者應傳遞 toolInvocationToken，它隨附於 聊天請求。這可確保聊天 UI 顯示正確對話的工具調用。

工具結果是 文字和 提示-tsx 部件的陣列。如果工具呼叫者正在使用 vscode/prompt-tsx，它可以將回應部件合併到其提示中，使用 ToolResult。如果沒有，則可以透過使用者訊息將部件與 LanguageModelToolResultPart 一起傳遞給 LanguageModelChat。

如果聊天參與者想要跨多個回合保留請求的工具結果，它可以將工具結果儲存在從處理常式傳回的 ChatResult.metadata 中，並在下一個回合從 ChatResponseTurn.result 中檢索它們。

註冊 LanguageModelTool。該工具也必須在 package.json languageModelTools 貢獻點中註冊。註冊的工具在 lm.tools 清單中可供任何擴充功能查看。但是，為了讓語言模型看到它，它必須在 LanguageModelChatRequestOptions.tools 中可用的工具清單中傳遞。

依 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
}

可以編寫選取器以廣泛匹配給定供應商或系列的所有模型，或者它可以狹義地依 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 時，也會觸發事件。

當事件在使用中終端機變更時觸發。請注意，當使用中終端機變更為 undefined 時，此事件也會觸發。

當事件在使用中編輯器變更時觸發。請注意，當使用中編輯器變更為 undefined 時，此事件也會觸發。

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

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

當終端機中的 Shell 整合啟用或其屬性之一變更時觸發。

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

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

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

當事件在編輯器的檢視欄變更時觸發。

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

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

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

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

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

當終端機命令結束時，將會觸發此事件。此事件僅在終端機啟用 Shell 整合 時觸發。

當事件在終端機已建立時觸發，無論是透過 createTerminal API 或命令。

當終端機命令開始時，將會觸發此事件。此事件僅在終端機啟用 Shell 整合 時觸發。

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

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

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

您可以從 可見編輯器 或 使用中編輯器 存取可見或使用中的輸出通道作為 文字文件，並使用語言 ID 來貢獻語法色彩標示、程式碼鏡頭等語言功能。

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

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

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

建立狀態列 項目。

建立狀態列 項目。

另請參閱 createStatusBarItem，以建立具有識別碼的狀態列項目。

建立具有後端 Shell 程序的 Terminal。如果工作區目錄存在，則終端機的 cwd 將會是該目錄。

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

建立具有後端 Shell 程序的 Terminal。

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

建立 Terminal，其中擴充功能控制其輸入和輸出。

建立可用於將裝飾新增至文字編輯器的 TextEditorDecorationType。

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

建立並顯示新的 Webview 面板。

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

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

註冊檔案裝飾提供者。

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

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

為使用擴充功能點 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 檢視註冊新的提供者。

將訊息設定到狀態列。這是更強大的狀態列 項目 的簡短方式。

將訊息設定到狀態列。這是更強大的狀態列 項目 的簡短方式。

將訊息設定到狀態列。這是更強大的狀態列 項目 的簡短方式。

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

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

向使用者顯示資訊訊息。選擇性地提供將呈現為可點擊按鈕的項目陣列。

向使用者顯示資訊訊息。選擇性地提供將呈現為可點擊按鈕的項目陣列。

顯示資訊訊息。

另請參閱 showInformationMessage

顯示資訊訊息。

另請參閱 showInformationMessage

開啟輸入框以詢問使用者輸入內容。

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

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

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

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

顯示選取清單。

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

顯示選取清單。

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