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 建置器。請注意，edit 建置器僅在回呼執行時有效。

建立新的 註解控制器 執行個體。

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

目前作用中的 偵錯工作階段 或 undefined。作用中的偵錯工作階段是由偵錯動作浮動視窗表示的工作階段，或是目前顯示在偵錯動作浮動視窗下拉式選單中的工作階段。如果沒有作用中的偵錯工作階段，則值為 undefined。

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

中斷點清單。

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

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

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

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

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

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

新增中斷點。

將透過偵錯配接器通訊協定接收的 "Source" 描述元物件轉換為可用於載入其內容的 Uri。如果來源描述元是以路徑為基礎，則會傳回檔案 Uri。如果來源描述元使用參考編號，則會建構特定的偵錯 Uri (配置 'debug')，這需要對應的 ContentProvider 和執行中的偵錯工作階段

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

為特定的偵錯類型註冊 偵錯配接器描述元 Factory。擴充功能僅允許為擴充功能定義的偵錯類型註冊 DebugAdapterDescriptorFactory。否則會擲回錯誤。為偵錯類型註冊多個 DebugAdapterDescriptorFactory 會導致錯誤。

為給定的偵錯類型註冊偵錯配接器追蹤器 Factory。

為特定的偵錯類型註冊 偵錯組態提供者。選用的 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。

編輯器目前的記錄層級。

電腦的唯一識別碼。

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

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

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

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

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

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

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

當預設 Shell 變更時觸發的 Event。這會以新的 Shell 路徑觸發。

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

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

http: 或 https: 結構描述

從擴充功能執行的位置，將外部 URI (例如 http: 或 https: 連結) 解析為用戶端電腦上相同資源的 URI。

如果擴充功能在用戶端電腦上執行，則這是 no-op。

如果擴充功能在遠端執行，此函式會自動建立從本機電腦到遠端 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.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 的 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 屬性進行排序。預設情況下，第一個編輯會被套用。如果還有其他編輯，這些編輯將會以可選取的下拉選項顯示在下拉小工具中，供使用者選擇。

為文件註冊格式化供應商。

可以為一種語言註冊多個供應商。在這種情況下，供應商會依據其 score 進行排序，並使用最佳匹配的供應商。選定供應商的失敗將導致整個操作失敗。

註冊文件反白供應商。

可以為一種語言註冊多個供應商。在這種情況下，供應商會依據其 score 進行排序，並依序詢問群組以取得文件反白。當供應商回傳 non-falsy 或 non-failure 結果時，程序會停止。

註冊文件連結供應商。

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

註冊新的 DocumentPasteEditProvider。

可以為一種語言註冊多個供應商。將會根據 DocumentPasteProviderMetadata 指定的它們處理的 mimetype，針對複製和貼上操作調用所有已註冊的語言供應商。

對於 複製操作，每個供應商對 DataTransfer 所做的變更將會合併到單一的 DataTransfer 中，該 DataTransfer 用於填充剪貼簿。

對於 [DocumentPasteEditProvider.providerDocumentPasteEdits 貼上操作](#DocumentPasteEditProvider.providerDocumentPasteEdits paste operations)，每個供應商都會被調用，並且可以回傳一個或多個 DocumentPasteEdits。這些編輯會使用 DocumentPasteEdit.yieldTo 屬性進行排序。預設情況下，第一個編輯會被套用，其餘的編輯將會以可選取的貼上選項顯示在貼上小工具中，供使用者選擇。

為文件範圍註冊格式化供應商。

注意： 文件範圍供應商也是一個 文件格式化器，這表示當同時註冊範圍供應商時，無需 註冊 文件格式化器。

可以為一種語言註冊多個供應商。在這種情況下，供應商會依據其 score 進行排序，並使用最佳匹配的供應商。選定供應商的失敗將導致整個操作失敗。

為文件範圍註冊語意符記供應商。

注意： 如果文件同時具有 DocumentSemanticTokensProvider 和 DocumentRangeSemanticTokensProvider，則範圍供應商只會在初始階段被調用，這段時間是完整文件供應商解析第一個請求所需的時間。一旦完整文件供應商解析了第一個請求，透過範圍供應商提供的語意符記將會被丟棄，並且從那時起，只會使用文件供應商。

可以為一種語言註冊多個供應商。在這種情況下，供應商會依據其 score 進行排序，並使用最佳匹配的供應商。選定供應商的失敗將導致整個操作失敗。

為整個文件註冊語意符記供應商。

可以為一種語言註冊多個供應商。在這種情況下，供應商會依據其 score 進行排序，並使用最佳匹配的供應商。選定供應商的失敗將導致整個操作失敗。

註冊文件符號供應商。

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

註冊一個供應商，用於在文字文件中定位可評估的表達式。編輯器將會在作用中的偵錯工作階段中評估表達式，並將結果顯示在偵錯浮動視窗中。

如果為一種語言註冊了多個供應商，將會使用任意一個供應商。

註冊摺疊範圍供應商。

可以為一種語言註冊多個供應商。在這種情況下，供應商會被平行詢問，並且結果會被合併。如果多個摺疊範圍在相同的位置開始，則只會使用第一個註冊供應商的範圍。如果摺疊範圍與另一個位置較小的範圍重疊，則也會被忽略。

失敗的供應商（拒絕的 Promise 或例外）不會導致整個操作失敗。

註冊浮動提示供應商。

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

註冊實作供應商。

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

註冊內嵌提示供應商。

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

註冊一個內嵌完成供應商。

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

註冊一個供應商，該供應商回傳除錯工具「內嵌值」功能的資料。每當通用除錯工具在原始碼檔案中停止時，就會調用為該檔案語言註冊的供應商，以回傳將顯示在編輯器行尾的文字資料。

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

註冊連結編輯範圍供應商。

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

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

可以為一種語言註冊多個供應商。在這種情況下，供應商會依據其 score 進行排序，並使用最佳匹配的供應商。選定供應商的失敗將導致整個操作失敗。

註冊參考供應商。

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

註冊重新命名供應商。

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

註冊選取範圍供應商。

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

註冊簽名提示供應商。

可以為一種語言註冊多個供應商。在這種情況下，供應商會依據其 score 進行排序，並依序調用，直到供應商回傳有效的結果。

另請參閱 languages.registerSignatureHelpProvider

註冊類型定義供應商。

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

註冊類型階層供應商。

註冊工作區符號供應商。

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

為語言設定 語言組態。

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

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

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

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

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

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

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

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

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

註冊 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 時，渲染器才能存取訊息傳遞。

為指定的 notebook 類型註冊 cell statusbar item provider。

擴充功能建立的最後一個 原始檔控制輸入框。

• 已過時 - 請改用 SourceControl.inputBox

建立新的 原始檔控制 實例。

目前啟用的工作執行，或空陣列。

當工作結束時觸發。

當底層程序結束時觸發。 此事件不會為未執行底層程序的工作觸發。

當工作開始時觸發。

當底層程序已啟動時觸發。 此事件不會為未執行底層程序的工作觸發。

執行由編輯器管理的工作。 傳回的工作執行可用於終止工作。

• 拋出 - 在無法啟動新程序的環境中執行 ShellExecution 或 ProcessExecution 工作時。 在這種環境中，只能執行 CustomExecution 工作。

擷取系統中所有可用的工作。 這包括來自 tasks.json 檔案的工作，以及透過擴充功能貢獻的工作提供者。

註冊工作提供者。

建立新的測試控制器。

目前在設定中配置的啟用色彩主題。 可以透過 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。

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

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

這會在終端機命令結束時觸發。 只有在終端機啟用 shell 整合 時，才會觸發此事件。

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

這會在終端機命令啟動時觸發。 只有在終端機啟用 shell 整合 時，才會觸發此事件。

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

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

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

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

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

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

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

建立狀態列 項目。

建立狀態列 項目。

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

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

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

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

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

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

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

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

建立並顯示新的 webview 面板。

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

當自訂編輯器開啟時，會觸發 onCustomEditor: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 檢視畫面註冊新的提供者。

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

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

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

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

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

顯示錯誤訊息。

另請參閱 showInformationMessage

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

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

顯示資訊訊息。

另請參閱 showInformationMessage

顯示資訊訊息。

另請參閱 showInformationMessage

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

如果輸入框被取消 (例如按下 ESC 鍵)，則傳回值將為 undefined。否則，傳回值將是使用者輸入的字串，如果使用者未輸入任何內容但按一下 [確定] 關閉輸入框，則傳回空字串。

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

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

顯示允許選取多個選項的選取清單。

顯示選取清單。

顯示允許選取多個選項的選取清單。

顯示選取清單。

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

在文字編輯器中顯示給定的文件。欄可以用於控制編輯器顯示的位置。可能會變更作用中編輯器。