VS Code API

認証プロバイダーの認証セッションが追加、削除、または変更されたときに発生する イベント。

指定されたプロバイダーに対してユーザーがログインしているすべてのアカウントを取得します。特定のアカウントの認証セッションを取得するには、getSession と組み合わせて使用します。

現在、GitHub および Microsoft 認証を実装するエディターへの組み込み拡張機能から提供されている認証プロバイダーは 2 つのみです。それらの providerId は 'github' と 'microsoft' です。

注: アカウントを取得しても、拡張機能がそのアカウントまたはその認証セッションへのアクセス権を持っているとは限りません。アカウントへのアクセス権があるかどうかは、getSession を呼び出すことで確認できます。

目的のスコープに一致する認証セッションを取得します。providerId を持つプロバイダーが登録されていない場合、またはユーザーが拡張機能との認証情報の共有に同意しない場合は拒否されます。同じスコープを持つセッションが複数ある場合は、使用するアカウントを選択するためのクイックピックがユーザーに表示されます。

現在、GitHub および Microsoft 認証を実装するエディターへの組み込み拡張機能から提供されている認証プロバイダーは 2 つのみです。それらの providerId は 'github' と 'microsoft' です。

目的のスコープに一致する認証セッションを取得します。providerId を持つプロバイダーが登録されていない場合、またはユーザーが拡張機能との認証情報の共有に同意しない場合は拒否されます。同じスコープを持つセッションが複数ある場合は、使用するアカウントを選択するためのクイックピックがユーザーに表示されます。

現在、GitHub および Microsoft 認証を実装するエディターへの組み込み拡張機能から提供されている認証プロバイダーは 2 つのみです。それらの providerId は 'github' と 'microsoft' です。

目的のスコープに一致する認証セッションを取得します。providerId を持つプロバイダーが登録されていない場合、またはユーザーが拡張機能との認証情報の共有に同意しない場合は拒否されます。同じスコープを持つセッションが複数ある場合は、使用するアカウントを選択するためのクイックピックがユーザーに表示されます。

現在、GitHub および Microsoft 認証を実装するエディターへの組み込み拡張機能から提供されている認証プロバイダーは 2 つのみです。それらの providerId は 'github' と 'microsoft' です。

認証プロバイダーを登録します。

ID ごとにプロバイダーは 1 つしか存在できず、ID が別のプロバイダーによって既に使用されている場合はエラーがスローされます。ID は大文字と小文字を区別します。

新しい チャット参加者 インスタンスを作成します。

指定されたコマンド識別子で示されるコマンドを実行します。

• 注 1: エディターコマンドを実行する場合、すべての型を引数として渡すことができるわけではありません。許可されているのは、プリミティブ型 string、boolean、number、undefined、および null、ならびに Position、Range、Uri、および Location です。
• 注 2: 拡張機能によって提供されたコマンドを実行する場合、制限はありません。

使用可能なすべてのコマンドのリストを取得します。アンダースコアで始まるコマンドは、内部コマンドとして扱われます。

キーボードショートカット、メニュー項目、アクション、または直接的に呼び出すことができるコマンドを登録します。

既存のコマンド識別子を持つコマンドを 2 回登録すると、エラーが発生します。

キーボードショートカット、メニュー項目、アクション、または直接的に呼び出すことができるテキストエディターコマンドを登録します。

テキストエディターコマンドは、コマンドが呼び出されたときにアクティブなエディターがある場合にのみ実行されるため、通常の コマンド とは異なります。また、エディターコマンドのコマンドハンドラーは、アクティブなエディターと edit-builder にアクセスできます。edit-builder は、コールバックが実行されている間のみ有効であることに注意してください。

新しい コメントコントローラー インスタンスを作成します。

現在アクティブな デバッグコンソール。デバッグセッションがアクティブでない場合、デバッグコンソールに送信された出力は表示されません。

現在アクティブな デバッグセッション または undefined。アクティブなデバッグセッションは、デバッグアクションフローティングウィンドウで表されるもの、またはデバッグアクションフローティングウィンドウのドロップダウンメニューに現在表示されているものです。デバッグセッションがアクティブでない場合、値は undefined です。

現在フォーカスされているスレッドまたはスタックフレーム、またはスレッドまたはスタックがフォーカスされていない場合は undefined。スレッドはアクティブなデバッグセッションがある場合はいつでもフォーカスできますが、スタックフレームはセッションが一時停止され、コールスタックが取得された場合にのみフォーカスできます。

ブレークポイントのリスト。

アクティブなデバッグセッション が変更されたときに発生する イベント。注 イベントは、アクティブなデバッグセッションが undefined に変更されたときにも発生します。

debug.activeStackItem が変更されたときに発生するイベント。

ブレークポイントのセットが追加、削除、または変更されたときに発行される イベント。

デバッグセッション からカスタム DAP イベントを受信したときに発生する イベント。

新しい デバッグセッション が開始されたときに発生する イベント。

デバッグセッション が終了したときに発生する イベント。

ブレークポイントを追加します。

Debug Adapter Protocol を介して受信した "Source" 記述子オブジェクトを、そのコンテンツをロードするために使用できる Uri に変換します。ソース記述子がパスに基づいている場合は、ファイル Uri が返されます。ソース記述子が参照番号を使用している場合は、対応する ContentProvider と実行中のデバッグセッションを必要とする特定のデバッグ Uri (スキーム 'debug') が構築されます

Uri を作成するための情報が "Source" 記述子に不足している場合は、エラーがスローされます。

特定のデバッグタイプに対して デバッグアダプター記述子ファクトリ を登録します。拡張機能は、拡張機能によって定義されたデバッグタイプに対してのみ DebugAdapterDescriptorFactory を登録できます。そうしないと、エラーがスローされます。デバッグタイプに対して複数の DebugAdapterDescriptorFactory を登録すると、エラーが発生します。

指定されたデバッグタイプに対してデバッグアダプター追跡ファクトリを登録します。

特定のデバッグタイプに対して デバッグ構成プロバイダー を登録します。オプションの triggerKind を使用して、プロバイダーの provideDebugConfigurations メソッドがいつトリガーされるかを指定できます。現在、2 つのトリガーの種類が可能です。値 Initial (またはトリガーの種類引数が指定されていない場合) では、provideDebugConfigurations メソッドは、新しく作成された launch.json にコピーされる初期デバッグ構成を提供するために使用されます。トリガーの種類 Dynamic では、provideDebugConfigurations メソッドは、ユーザーに提示されるデバッグ構成を動的に決定するために使用されます (launch.json からの静的構成に加えて)。triggerKind 引数は provideDebugConfigurations メソッドにのみ適用されることに注意してください。そのため、resolveDebugConfiguration メソッドはまったく影響を受けません。異なるトリガーの種類に対して resolve メソッドを持つ単一のプロバイダーを登録すると、同じ resolve メソッドが複数回呼び出されます。同じタイプに対して複数のプロバイダーを登録できます。

ブレークポイントを削除します。

名前付き起動構成または名前付き複合構成を使用するか、または DebugConfiguration を直接渡すことによってデバッグを開始します。名前付き構成は、指定されたフォルダーにある '.vscode/launch.json' で検索されます。デバッグを開始する前に、保存されていないファイルはすべて保存され、起動構成は最新の状態になります。構成で使用されるフォルダー固有の変数 (例: '${workspaceFolder}') は、指定されたフォルダーに対して解決されます。

指定されたデバッグセッションを停止するか、セッションが省略されている場合はすべてのデバッグセッションを停止します。

appHost: string

appName: string

appRoot: string

エディターが実行されているアプリケーションルートフォルダー。

clipboard: Clipboard

isNewAppInstall: boolean

isTelemetryEnabled: boolean

優先されるユーザー言語を表します。例：de-CH、fr、en-US。

エディターの現在のログレベル。

コンピューターの一意な識別子。

リモートの名前。拡張機能によって定義され、一般的な例としては、Windows Subsystem for Linux の場合は wsl、セキュアシェルを使用するリモートの場合は ssh-remote などがあります。

注：リモート拡張機能ホストが存在しない場合、値は undefined ですが、リモート拡張機能ホストが存在する場合、すべての拡張機能ホスト（ローカルおよびリモート）で値は定義されます。特定拡張機能がリモートで実行されているかどうかを知るには、Extension.extensionKind を使用してください。

現在のセッションの一意な識別子。エディターが起動するたびに変更されます。

拡張機能ホストに対して検出されたデフォルトシェル。これは、拡張機能ホストのプラットフォームの terminal.integrated.defaultProfile 設定によってオーバーライドされます。シェルをサポートしない環境では、値は空の文字列になることに注意してください。

UI 種別プロパティは、拡張機能がどの UI からアクセスされているかを示します。たとえば、拡張機能はデスクトップアプリケーションまたは Web ブラウザーからアクセスできます。

エディターがオペレーティングシステムに登録するカスタム URI スキーム。

エディターのログレベルが変更されたときに発生する Event。

デフォルトシェルが変更されたときに発生する Event。新しいシェルパスと共に発生します。

ユーザーがテレメトリーを有効または無効にしたときに発生する Event。ユーザーがテレメトリーを有効にした場合は true、ユーザーがテレメトリーを無効にした場合は false。

URI を外部からアクセス可能な形式に解決します。

http: または https: スキーム

拡張機能が実行されている場所から、クライアントマシン上の同じリソースへの URI に、外部 URI（http: や https: リンクなど）を解決します。

拡張機能がクライアントマシン上で実行されている場合、これは何もしません。

拡張機能がリモートで実行されている場合、この関数は自動的にローカルマシンからリモートの target へのポートフォワーディングトンネルを確立し、トンネルへのローカル URI を返します。ポートフォワーディングトンネルのライフサイクルはエディターによって管理され、トンネルはユーザーによって閉じることができます。

注：openExternal を介して渡される URI は自動的に解決されるため、それらに対して asExternalUri を呼び出すべきではありません。

vscode.env.uriScheme

ブラウザーで開かれた場合（例：openExternal 経由）、登録された UriHandler がトリガーされる URI を作成します。

拡張機能は、結果の 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 を返します。

新しい テレメトリーロガーを作成します。

デフォルトアプリケーションを使用して、リンクを外部で開きます。使用されるスキームに応じて、次のようになります。

• ブラウザー (http:, https:)
• メールクライアント (mailto:)
• VSCode 自体 (vscode: from 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 値が挿入されます）。

グローバルな診断セットが変更されたときに発生する Event。これは、新しく追加および削除された診断です。

診断コレクションを作成します。

新しい 言語ステータスアイテム を作成します。

指定されたリソースのすべての診断を取得します。

すべての診断を取得します。

既知のすべての言語の識別子を返します。

ドキュメント セレクター とドキュメント間のマッチを計算します。ゼロより大きい値は、セレクターがドキュメントに一致することを意味します。

マッチは、次のルールに従って計算されます。

1. DocumentSelector が配列の場合、含まれている各 DocumentFilter または言語識別子のマッチを計算し、最大値を取得します。
2. 文字列は、DocumentFilter の language 部分になるように脱糖されます。したがって、"fooLang" は { language: "fooLang" } のようなものです。
3. DocumentFilter は、その部分をドキュメントと比較することによってドキュメントと照合されます。次のルールが適用されます。
   1. DocumentFilter が空の場合 ({})、結果は 0 です。
   2. scheme、language、pattern、または notebook が定義されているが、いずれかが一致しない場合、結果は 0 です。
   3. * との一致は 5 のスコアを与え、等価性またはグロブパターンによる一致は 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 または例外）は、操作全体を失敗させる原因にはなりません。

補完プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは スコア でソートされ、同じスコアのグループは順番に補完項目を要求されます。プロセスは、グループの 1 つまたは複数のプロバイダーが結果を返すと停止します。失敗したプロバイダー（拒否された Promise または例外）は、操作全体を失敗させることはありません。

補完項目プロバイダーは、triggerCharacters のセットに関連付けることができます。トリガー文字が入力されると、補完が要求されますが、入力された文字を登録したプロバイダーからのみ要求されます。そのため、トリガー文字は 単語文字 とは異なる必要があります。一般的なトリガー文字は、メンバー補完をトリガーする . です。

宣言プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー（拒否された Promise または例外）は、操作全体を失敗させる原因にはなりません。

定義プロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー（拒否された Promise または例外）は、操作全体を失敗させる原因にはなりません。

新しい DocumentDropEditProvider を登録します。

複数のドロッププロバイダーを言語に登録できます。コンテンツをエディターにドロップすると、エディターの言語に登録されているすべてのプロバイダーが、DocumentDropEditProviderMetadata で指定されている処理対象のマイムタイプに基づいて呼び出されます。

各プロバイダーは、1 つ以上の DocumentDropEdits を返すことができます。編集は、DocumentDropEdit.yieldTo プロパティを使用してソートされます。デフォルトでは、最初の編集が適用されます。追加の編集がある場合は、これらの編集は、ドロップウィジェットの選択可能なドロップオプションとしてユーザーに表示されます。

ドキュメントのフォーマットプロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは スコア でソートされ、最適な一致プロバイダーが使用されます。選択されたプロバイダーの失敗は、操作全体の失敗を引き起こします。

ドキュメントハイライトプロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは スコア でソートされ、グループは順番にドキュメントハイライトを要求されます。プロセスは、プロバイダーが 非 falsy または 非失敗 の結果を返すと停止します。

ドキュメントリンクプロバイダーを登録します。

複数のプロバイダーを言語に登録できます。その場合、プロバイダーは並行して要求され、結果はマージされます。失敗したプロバイダー（拒否された Promise または例外）は、操作全体を失敗させる原因にはなりません。

新しい DocumentPasteEditProvider を登録します。

複数のプロバイダーを言語に登録できます。言語に登録されているすべてのプロバイダーは、DocumentPasteProviderMetadata で指定されている処理対象のマイムタイプに基づいて、コピーアンドペースト操作に対して呼び出されます。

コピー操作 の場合、各プロバイダーによって行われた DataTransfer への変更は、クリップボードへの入力に使用される単一の DataTransfer にマージされます。

[DocumentPasteEditProvider.providerDocumentPasteEdits ペースト操作](#DocumentPasteEditProvider.providerDocumentPasteEdits paste operations)では、各プロバイダーが呼び出され、1つ以上のDocumentPasteEditを返すことができます。エディットは、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が正しい会話のツール呼び出しを表示することが保証されます。

ツールの結果は、テキストパートとプロンプトtsxパートの配列です。ツール呼び出し元がvscode/prompt-tsxを使用している場合、ToolResultを使用して応答パートをプロンプトに組み込むことができます。そうでない場合、パートはLanguageModelToolResultPartを持つユーザーメッセージを介してLanguageModelChatに渡すことができます。

チャット参加者が複数のターンのリクエストに対してツールの結果を保持したい場合、ハンドラーから返された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で1つのモデルを狭く選択することもできます。利用可能なモデルのセットは時間の経過とともに変化しますが、プロンプトは異なるモデルで異なる動作をする可能性があることにも注意してください。

注 拡張機能は、この関数によって返された結果を保持し、後で使用できます。ただし、onDidChangeChatModelsイベントが発生すると、チャットモデルのリストが変更されている可能性があり、拡張機能は再クエリする必要があります。

新しいノートブックコントローラーを作成します。

特定のレンダラーとの通信に使用される新しいメッセージングインスタンスを作成します。

• 注1: 拡張機能は、package.jsonファイルで定義したレンダラーのみを作成できます。
• 注2: レンダラーがメッセージングにアクセスできるのは、notebookRendererコントリビューションでrequiresMessagingがalwaysまたはoptionalに設定されている場合のみです。

指定されたノートブックタイプのセルステータスバーアイテムプロバイダーを登録します。

拡張機能によって作成された最後のソース管理の入力ボックス。

• 非推奨 - 代わりにSourceControl.inputBoxを使用してください

新しいソース管理インスタンスを作成します。

現在アクティブなタスク実行、または空の配列。

タスクが終了したときに発生します。

基盤となるプロセスが終了したときに発生します。このイベントは、基盤となるプロセスを実行しないタスクに対しては発生しません。

タスクが開始したときに発生します。

基盤となるプロセスが開始されたときに発生します。このイベントは、基盤となるプロセスを実行しないタスクに対しては発生しません。

エディターによって管理されるタスクを実行します。返されたタスク実行を使用して、タスクを終了できます。

• throws - 新しいプロセスを開始できない環境で ShellExecution または ProcessExecution タスクを実行する場合。そのような環境では、CustomExecution タスクのみを実行できます。

システムで利用可能なすべてのタスクをフェッチします。これには、tasks.jsonファイルからのタスクと、拡張機能を通じて提供されるタスクプロバイダーからのタスクが含まれます。

タスクプロバイダーを登録します。

新しいテストコントローラーを作成します。

設定で構成された現在のアクティブなカラーテーマ。アクティブなテーマは、workbench.colorTheme設定で変更できます。

現在アクティブなノートブックエディターまたはundefined。アクティブなエディターは、現在フォーカスがあるエディター、またはフォーカスがない場合は、最近入力が変更されたエディターです。

現在アクティブなターミナル、またはundefined。アクティブなターミナルは、現在フォーカスがあるターミナル、または最近フォーカスがあったターミナルです。

現在アクティブなエディター、またはundefined。アクティブなエディターは、現在フォーカスがあるエディター、またはフォーカスがない場合は、最近入力が変更されたエディターです。

現在のウィンドウの状態を表します。

メインエディター領域内のグリッドウィジェットを表します

現在開いているターミナル、または空の配列。

現在表示されているノートブックエディター、または空の配列。

現在表示されているエディター、または空の配列。

アクティブなカラーテーマが変更または変化したときに発生するイベント。

アクティブなノートブックエディターが変更されたときに発生するイベント。Note イベントは、アクティブなエディターがundefinedに変更されたときにも発生します。

アクティブなターミナルが変更されたときに発生するイベント。Note イベントは、アクティブなターミナルがundefinedに変更されたときにも発生します。

アクティブなエディターが変更されたときに発生するイベント。Note イベントは、アクティブなエディターがundefinedに変更されたときにも発生します。

ノートブックエディターの選択が変更されたときに発生するイベント。

ノートブックエディターの表示範囲が変更されたときに発生するイベント。

ターミナルでシェル統合がアクティブになるか、そのプロパティのいずれかが変更されたときに発生します。

ターミナルの状態が変更されたときに発生するイベント。

エディターのオプションが変更されたときに発生するイベント。

エディター内の選択範囲が変更されたときに発生するイベント。

エディターのビュー列が変更されたときに発生するイベント。

エディターの表示範囲が変更されたときに発生するイベント。

表示されているノートブックエディターが変更されたときに発生するイベント。

表示されているエディターの配列が変更されたときに発生するイベント。

現在のウィンドウのフォーカスまたはアクティビティ状態が変化したときに発生するイベント。イベントの値は、ウィンドウがフォーカスされているかどうかを表します。

ターミナルが破棄されたときに発生するイベント。

ターミナルコマンドが終了したときに発生します。このイベントは、シェル統合がターミナルに対してアクティブになっている場合にのみ発生します。

createTerminal APIまたはコマンドを通じてターミナルが作成されたときに発生するイベント。

ターミナルコマンドが開始されたときに発生します。このイベントは、シェル統合がターミナルに対してアクティブになっている場合にのみ発生します。

ユーザーがテキスト入力を入力できるようにするInputBoxを作成します。

多くの場合、より便利なwindow.showInputBoxの方が使いやすいことに注意してください。window.showInputBoxでは必要な柔軟性が提供されない場合は、window.createInputBoxを使用する必要があります。

指定された名前と言語IDを持つ新しい出力チャンネルを作成します。言語IDが指定されていない場合、デフォルトの言語IDとしてログが使用されます。

表示されているエディターまたはアクティブなエディターから、表示またはアクティブな出力チャンネルをテキストドキュメントとしてアクセスし、言語IDを使用して、構文の色付け、コードレンズなどの言語機能を提供できます。

指定された名前を持つ新しいログ出力チャンネルを作成します。

ユーザーがタイプTのアイテムのリストからアイテムを選択できるようにするQuickPickを作成します。

多くの場合、より便利なwindow.showQuickPickの方が使いやすいことに注意してください。window.showQuickPickでは必要な柔軟性が提供されない場合は、window.createQuickPickを使用する必要があります。

ステータスバーのアイテムを作成します。

ステータスバーのアイテムを作成します。

参照 識別子を持つステータスバーアイテムを作成するには、createStatusBarItemを参照してください。

バッキングシェルプロセスを持つTerminalを作成します。ターミナルのcwdは、ワークスペースディレクトリが存在する場合はワークスペースディレクトリになります。

• throws - 新しいプロセスを開始できない環境で実行する場合。

バッキングシェルプロセスを持つTerminalを作成します。

• throws - 新しいプロセスを開始できない環境で実行する場合。

拡張機能が入力と出力を制御する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ハンドラーのみを登録できます。

• 注: 現在の拡張機能に向けられたuriが処理されようとしているときに発生するアクティベーションイベントonUriがあります。

webviewパネルシリアライザーを登録します。

復元をサポートする拡張機能には、"onWebviewPanel:viewType"アクティベーションイベントがあり、アクティベーション中にregisterWebviewPanelSerializerが呼び出されていることを確認する必要があります。

特定のviewTypeに対して一度に登録できるシリアライザーは1つだけです。

webviewビューの新しいプロバイダーを登録します。

ステータスバーにメッセージを設定します。これは、より強力なステータスバーのアイテムの簡単な方法です。

ステータスバーにメッセージを設定します。これは、より強力なステータスバーのアイテムの簡単な方法です。

ステータスバーにメッセージを設定します。これは、より強力なステータスバーのアイテムの簡単な方法です。

注意: ステータスバーメッセージはスタックされ、不要になった場合は破棄する必要があります。

エラーメッセージを表示します。

参照: showInformationMessage

エラーメッセージを表示します。

参照: showInformationMessage

エラーメッセージを表示します。

参照: showInformationMessage

エラーメッセージを表示します。

参照: showInformationMessage

ユーザーに情報メッセージを表示します。オプションで、クリック可能なボタンとして表示されるアイテムの配列を提供します。

ユーザーに情報メッセージを表示します。オプションで、クリック可能なボタンとして表示されるアイテムの配列を提供します。

情報メッセージを表示します。

参照: showInformationMessage

情報メッセージを表示します。

参照: showInformationMessage

ユーザーに入力を求める入力ボックスを開きます。

入力ボックスがキャンセルされた場合（例：ESCキーを押した場合）、返される値はundefinedになります。それ以外の場合、返される値はユーザーが入力した文字列、またはユーザーが何も入力せずにOKで入力ボックスを閉じた場合は空の文字列になります。

指定されたNotebookDocumentをnotebook editorに表示します。

ファイルを開く目的でファイルを選択できるファイルオープンダイアログをユーザーに表示します。

複数選択を可能にする選択リストを表示します。

選択リストを表示します。

複数選択を可能にする選択リストを表示します。

選択リストを表示します。

ファイルを保存する目的でファイルを選択できるファイル保存ダイアログをユーザーに表示します。

指定されたドキュメントをテキストエディターに表示します。columnを指定して、エディターを表示する場所を制御できます。アクティブなエディターが変更される可能性があります。