@microsoft/sp-http-base package

AadHttpClient は、Azure AD アプリケーションに対して REST 呼び出しを実行するために使用されます。

HttpClient の構成。

特定のリソース URL に対して事前初期化されたバージョンの AadHttpClient を返します。 詳しくは、https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient をご覧ください

AadHttpClient.fetch() などのメソッドによって返される Response サブクラス。 AadHttpClient に固有の追加機能を追加する HttpClientResponse を拡張するクラス。

このクラスを使用すると、開発者は Azure AD から OAuth2 トークンを取得できます。

OAuth2 トークンは、SharePoint ページから PowerBI、Sway、Exchange、Yammer などの他のサービスに対してユーザーを認証するために使用されます。

AadTokenProviderFactory の初期化済みバージョンを返します。

フル ページ認証のリダイレクト前の の引数

IDigestCache は、SPWeb URL ごとに要求ダイジェストのキャッシュを維持するために SPHttpClient によって使用される内部サービスです。 要求ダイジェストは、SharePoint サーバーが REST 書き込み操作に必要なセキュリティ トークンであり、"X-RequestDigest" HTTP ヘッダーを介して指定されます。 これは、"/_api/contextinfo" REST エンドポイントを呼び出すことによって取得され、サーバーで構成可能な時間が経過すると期限切れになります。

詳細については、MSDN の記事「SharePoint 2013 REST エンドポイントを使用して基本的な操作を完了する」を参照してください。

HttpClient は、汎用サービスに対して REST 操作を実行するための基本的な機能セットを実装します。

HttpClient の構成。

Response サブクラスは、HttpClient.fetch() などのメソッドによって返されます。

Open Data Protocol 標準の一部である "OData-Version" ヘッダーのサポートされているバージョンを表します。

ログイン フロー中に対話が必要な場合のポップアップ イベントの引数。

SPHttpClient は、SharePoint に対して REST 呼び出しを実行するために使用されます。 これは、既定のヘッダーを追加し、書き込みに必要なダイジェストを管理して、テレメトリを収集します。このテレメトリはサービスがアプリケーションのパフォーマンスを監視するために役立ちます。

SPHttpClientBatch クラスは、多数の REST サービス呼び出しを蓄積し、単一の ODATA バッチとして送信します。 このプロトコルは、ここに文書化されています: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html

使用方法は、SPHttpClientBatch.fetch() を呼び出して個別の要求をキューに入れ、SPHttpClientBatch.execute() を呼び出してバッチ処理を実行します。 execute() メソッドは、実際の REST 呼び出しが完了したときに解決するプロミスを返します。 また、fetch() の各呼び出しは、その特定の要求に対する SPHttpClientResponse オブジェクトで解決される約束を返します。

SPHttpClientBatch の構成。

SPHttpClientConfiguration および SPHttpClientBatchConfiguration の共通の基底クラス。

SPHttpClient の構成。

Response サブクラスは、SPHttpClient.fetch() などのメソッドによって返されます。

トークン取得エラー イベントの引数。

HttpClientConfiguration のフラグ インターフェイス。

AadHttpClient の構成をStandardします。

AadHttpClient の既定の動作をオーバーライドするためのインターフェイス。

このクラスを使用すると、開発者は Azure AD から OAuth2 トークンを取得できます。

OAuth2 トークンは、SharePoint ページから PowerBI、Sway、Exchange、Yammer などの他のサービスに対してユーザーを認証するために使用されます。

AadTokenProvider を構築するために必要な文字列。

イベントをリダイレクトする前に使用される引数を表します。

IDigestCache は、SPWeb URL ごとに要求ダイジェストのキャッシュを維持するために SPHttpClient によって使用される内部サービスです。 要求ダイジェストは、SharePoint サーバーが REST 書き込み操作に必要なセキュリティ トークンであり、"X-RequestDigest" HTTP ヘッダーを介して指定されます。 これは、"/_api/contextinfo" REST エンドポイントを呼び出すことによって取得され、サーバーで構成可能な時間が経過すると期限切れになります。

詳細については、MSDN の記事「SharePoint 2013 REST エンドポイントを使用して基本的な操作を完了する」を参照してください。

これは、追加の SharePoint ロジックを使用せずに、ES6 Fetch API の基本コントラクトを表す ServiceScope インターフェイスです。

HttpClientConfiguration のフラグ インターフェイス。

HttpClient の構成をStandardします。

HttpClient のオプション

ポップアップ イベントの前に使用される引数を表します。

SPHttpClientBatchConfiguration のフラグ インターフェイス。

SPHttpClient の構成をStandardします。

このインターフェイスは SPHttpClientBatch コンストラクターに渡されます。 バッチ全体に影響するオプションを指定します。

このインターフェイスは、SPHttpClientBatch の一部である個々の REST 要求のオプションを定義します。 これは、ここに記載されている WHATWG API 標準パラメーターに基づいています。 https://fetch.spec.whatwg.org/

SPHttpClientCommonConfiguration のフラグ インターフェイス

SPHttpClientConfiguration のフラグ インターフェイス。

SPHttpClient の構成をStandardします。

このインターフェイスは、get()、post()、fetch() などの SPHttpClient 操作のオプションを定義します。これは、https://fetch.spec.whatwg.org/ に記載されている WHATWG API の標準的なパラメーターに基づいています。

トークンのアクイシトン エラー イベントの発生に使用される引数を表します。

認証スキームのオプション

SPHttpClient で使用される HTTP ヘッダーのStandard