SPHttpClientBatch class
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
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 クラスを展開するサブクラスを作成したりすることはできません。
プロパティ
| configurations | 標準の事前定義済み SPHttpClientBatchConfigurations オブジェクトは、SPHttpClientBatch クラスで使用します。 |
メソッド
| execute() | SPHttpClientBatch.fetch() を使用してキューに入ったバッチ済みクエリを実行します。 |
| fetch(url, configuration, options) | 新しいリクエストをキューに入れ、(execute() を完了した後に) サーバーの応答にアクセスするために使用できる約束を返します。 |
| get(url, configuration, options) | fetch() を呼び出しますが、メソッドを 'GET' に設定します。 |
| post(url, configuration, options) | fetch() を呼び出しますが、メソッドを 'POST' に設定します。 |
プロパティの詳細
configurations
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
標準の事前定義済み SPHttpClientBatchConfigurations オブジェクトは、SPHttpClientBatch クラスで使用します。
static readonly configurations: ISPHttpClientBatchConfigurations;プロパティ値
メソッドの詳細
execute()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
SPHttpClientBatch.fetch() を使用してキューに入ったバッチ済みクエリを実行します。
execute(): Promise<SPHttpClientBatch>;戻り値
Promise<SPHttpClientBatch>
fetch(url, configuration, options)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
新しいリクエストをキューに入れ、(execute() を完了した後に) サーバーの応答にアクセスするために使用できる約束を返します。
fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;パラメーター
- url
-
string
フェッチする URL
- configuration
- SPHttpClientBatchConfiguration
このリクエストの既定の動作を決定します。通常これは SPHttpClientBatchConfigurations からの最新のバージョン番号である必要があります
- options
- ISPHttpClientBatchOptions
要求に影響する追加オプション
戻り値
Promise<SPHttpClientResponse>
WHATWG fetch() に類似した挙動を持つ約束です。 この約束は、HTTP404 や HTTP500 などのエラー状態コードに対して、正常に (HttpClientResponse.ok を false にして) 解決します。 約束が拒否するのは、ネットワーク障害やその他のエラーでサーバーとの通信ができない場合のみです。
注釈
この関数のパラメータは、ここで説明する WHATWG API 規格と基本的に同じです。
https://fetch.spec.whatwg.org/
ただし、バッチ内では特定の REST ヘッダーが無視されたり、許可されなかったりすることがあるので注意してください。 詳細については、ODATA のドキュメントを参照してください。
execute() が呼び出されると、「http://example.com/sites/sample/_api/$batch」のような URL に投稿されます。 通常、SPHttpClientBatch は、fetch() に渡された最初の URL で "_api" などの予約 URL セグメントを検索することで、適切な SPWeb URL を正常に推測できます。 そうでない場合はISPHttpClientBatchCreationOptions.webUrl を使用して、明示的に指定します。
get(url, configuration, options)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
fetch() を呼び出しますが、メソッドを 'GET' に設定します。
get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;パラメーター
- url
-
string
フェッチする URL
- configuration
- SPHttpClientBatchConfiguration
このリクエストの既定の動作を決定します。通常これは SPHttpClientBatchConfigurations からの最新のバージョン番号である必要があります
- options
- ISPHttpClientBatchOptions
要求に影響する追加オプション
戻り値
Promise<SPHttpClientResponse>
WHATWG fetch() に類似した挙動を持つ約束です。 この約束は、HTTP404 や HTTP500 などのエラー状態コードに対して、正常に (HttpClientResponse.ok を false にして) 解決します。 約束が拒否するのは、ネットワーク障害やその他のエラーでサーバーとの通信ができない場合のみです。
post(url, configuration, options)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
fetch() を呼び出しますが、メソッドを 'POST' に設定します。
post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;パラメーター
- url
-
string
フェッチする URL
- configuration
- SPHttpClientBatchConfiguration
このリクエストの既定の動作を決定します。通常これは SPHttpClientBatchConfigurations からの最新のバージョン番号である必要があります
- options
- ISPHttpClientBatchOptions
要求に影響する追加オプション
戻り値
Promise<SPHttpClientResponse>
WHATWG fetch() に類似した挙動を持つ約束です。 この約束は、HTTP404 や HTTP500 などのエラー状態コードに対して、正常に (HttpClientResponse.ok を false にして) 解決します。 約束が拒否するのは、ネットワーク障害やその他のエラーでサーバーとの通信ができない場合のみです。