HttpClient class
HttpClient implémente un ensemble de fonctionnalités de base pour effectuer des opérations REST sur un service générique.
Remarques
Pour communiquer avec SharePoint, utilisez plutôt la classe SPHttpClient .
Constructeurs
| (constructor)(service |
Construit une nouvelle instance de la |
Propriétés
| configurations | Objets HttpClientConfiguration prédéfinis standard à utiliser avec la classe HttpClient. |
| service |
Clé de service pour HttpClient. |
Méthodes
| fetch(url, configuration, options) | Effectue un appel du service Rest. |
| get(url, configuration, options) | Appelle fetch(), mais définit la méthode sur « GET ». |
| post(url, configuration, options) | Appelle fetch(), mais définit la méthode sur « POST ». |
Détails du constructeur
(constructor)(serviceScope)
Construit une nouvelle instance de la HttpClient classe
constructor(serviceScope: ServiceScope);Paramètres
- serviceScope
- ServiceScope
Détails de la propriété
configurations
Objets HttpClientConfiguration prédéfinis standard à utiliser avec la classe HttpClient.
static readonly configurations: IHttpClientConfigurations;Valeur de propriété
serviceKey
Clé de service pour HttpClient.
static readonly serviceKey: ServiceKey<HttpClient>;Valeur de propriété
Détails de la méthode
fetch(url, configuration, options)
Effectue un appel du service Rest.
fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Paramètres
- url
-
string
URL à récupérer
- configuration
- HttpClientConfiguration
détermine le comportement par défaut de HttpClient. Il s’agit généralement du dernier numéro de version de HttpClientConfigurations
- options
- IHttpClientOptions
options supplémentaires qui affectent la requête
Retours
Promise<HttpClientResponse>
Promesse avec un comportement similaire à WHATWG fetch(). Cette promesse se résout normalement (httpClientResponse.ok étant false) pour les codes d’erreur status tels que HTTP 404 ou 500. La promesse est rejetée uniquement pour les défaillances réseau ou d’autres erreurs qui empêchent la communication avec le serveur.
Remarques
Bien que la sous-classe SPHttpClient ajoute des améliorations, les paramètres et la sémantique relatifs à HttpClient.fetch() sont globalement identiques à la norme de l’API WHATWG décrite ici : https://fetch.spec.whatwg.org/
get(url, configuration, options)
Appelle fetch(), mais définit la méthode sur « GET ».
get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;Paramètres
- url
-
string
URL à récupérer
- configuration
- HttpClientConfiguration
détermine le comportement par défaut de HttpClient. Il s’agit généralement du dernier numéro de version de HttpClientConfigurations
- options
- IHttpClientOptions
options supplémentaires qui affectent la requête
Retours
Promise<HttpClientResponse>
Promesse avec un comportement similaire à WHATWG fetch(). Cette promesse se résout normalement (httpClientResponse.ok étant false) pour les codes d’erreur status tels que HTTP 404 ou 500. La promesse est rejetée uniquement pour les défaillances réseau ou d’autres erreurs qui empêchent la communication avec le serveur.
post(url, configuration, options)
Appelle fetch(), mais définit la méthode sur « POST ».
post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Paramètres
- url
-
string
URL à récupérer
- configuration
- HttpClientConfiguration
détermine le comportement par défaut de HttpClient. Il s’agit généralement du dernier numéro de version de HttpClientConfigurations
- options
- IHttpClientOptions
options supplémentaires qui affectent la requête
Retours
Promise<HttpClientResponse>
Promesse avec un comportement similaire à WHATWG fetch(). Cette promesse se résout normalement (httpClientResponse.ok étant false) pour les codes d’erreur status tels que HTTP 404 ou 500. La promesse est rejetée uniquement pour les défaillances réseau ou d’autres erreurs qui empêchent la communication avec le serveur.