HttpClient class
HttpClient は、汎用サービスに対して REST 操作を実行するための基本的な機能セットを実装します。
注釈
SharePoint と通信する場合は、代わりに SPHttpClient クラスを使用します。
コンストラクター
| (constructor)(service |
|
プロパティ
| configurations | HttpClient クラスで使用する標準の定義済みの HttpClientConfiguration オブジェクト。 |
| service |
HttpClient のサービス キー。 |
メソッド
| fetch(url, configuration, options) | REST サービス呼び出しを実行します。 |
| get(url, configuration, options) | fetch() を呼び出しますが、メソッドを "GET" に設定します。 |
| post(url, configuration, options) | fetch() を呼び出しますが、メソッドを "POST" に設定します。 |
コンストラクターの詳細
(constructor)(serviceScope)
HttpClient クラスの新しいインスタンスを構築します
constructor(serviceScope: ServiceScope);パラメーター
- serviceScope
- ServiceScope
プロパティの詳細
configurations
HttpClient クラスで使用する標準の定義済みの HttpClientConfiguration オブジェクト。
static readonly configurations: IHttpClientConfigurations;プロパティ値
serviceKey
HttpClient のサービス キー。
static readonly serviceKey: ServiceKey<HttpClient>;プロパティ値
メソッドの詳細
fetch(url, configuration, options)
REST サービス呼び出しを実行します。
fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;パラメーター
- url
-
string
フェッチする URL
- configuration
- HttpClientConfiguration
HttpClient の既定の動作を決定します。通常これは HttpClientConfigurations からの最新のバージョン番号である必要があります
- options
- IHttpClientOptions
要求に影響する追加オプション
戻り値
Promise<HttpClientResponse>
WHATWG fetch() に類似した挙動を持つ約束です。 この約束は、HTTP404 や HTTP500 などのエラー状態コードに対して、正常に (HttpClientResponse.ok を false にして) 解決します。 約束が拒否するのは、ネットワーク障害やその他のエラーでサーバーとの通信ができない場合のみです。
注釈
SPHttpClient サブクラスは機能拡張を追加していますが、HttpClient.fetch() のパラメーターとセマンティクスは本質的に、https://fetch.spec.whatwg.org/ に記載されている WHATWG API 標準と同じです。
get(url, configuration, options)
fetch() を呼び出しますが、メソッドを "GET" に設定します。
get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;パラメーター
- url
-
string
フェッチする URL
- configuration
- HttpClientConfiguration
HttpClient の既定の動作を決定します。通常これは HttpClientConfigurations からの最新のバージョン番号である必要があります
- options
- IHttpClientOptions
要求に影響する追加オプション
戻り値
Promise<HttpClientResponse>
WHATWG fetch() に類似した挙動を持つ約束です。 この約束は、HTTP404 や HTTP500 などのエラー状態コードに対して、正常に (HttpClientResponse.ok を false にして) 解決します。 約束が拒否するのは、ネットワーク障害やその他のエラーでサーバーとの通信ができない場合のみです。
post(url, configuration, options)
fetch() を呼び出しますが、メソッドを "POST" に設定します。
post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;パラメーター
- url
-
string
フェッチする URL
- configuration
- HttpClientConfiguration
HttpClient の既定の動作を決定します。通常これは HttpClientConfigurations からの最新のバージョン番号である必要があります
- options
- IHttpClientOptions
要求に影響する追加オプション
戻り値
Promise<HttpClientResponse>
WHATWG fetch() に類似した挙動を持つ約束です。 この約束は、HTTP404 や HTTP500 などのエラー状態コードに対して、正常に (HttpClientResponse.ok を false にして) 解決します。 約束が拒否するのは、ネットワーク障害やその他のエラーでサーバーとの通信ができない場合のみです。