SPHttpClient class
SPHttpClient est utilisé pour effectuer des appels REST dans SharePoint. Il ajoute des en-têtes par défaut, gère le résumé requis pour les écritures et recueille les données télémétriques qui permettent au service de surveiller les performances d’une application.
Remarques
Cette classe est marquée comme @sealed. Les sous-classes ne doivent pas l’étendre.
Pour communiquer avec d’autres services Internet, utilisez la classe HttpClient .
Constructeurs
| (constructor)(service |
Construit une nouvelle instance de la |
Propriétés
| configurations | Objets SPHttpClientConfiguration prédéfinis standard à utiliser avec la classe SPHttpClient. |
| is |
|
| service |
Clé de service pour SPHttpClient. |
Méthodes
| _fetch(url, configuration, options) | |
| begin |
Commence un lot ODATA qui permet de regrouper plusieurs requêtes REST dans une requête web unique. |
| fetch(url, configuration, options) | Effectuez un appel de service REST. |
| get(url, configuration, options) | Appelle fetch(), mais définit la méthode sur « GET ». |
| get |
Utilisez une heuristique pour déduire l’URL de base pour l’authentification. |
| 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 SPHttpClient classe
constructor(serviceScope: ServiceScope);Paramètres
- serviceScope
- ServiceScope
Détails de la propriété
configurations
Objets SPHttpClientConfiguration prédéfinis standard à utiliser avec la classe SPHttpClient.
static readonly configurations: ISPHttpClientConfigurations;Valeur de propriété
isNavigate
get isNavigate(): boolean;
set isNavigate(isNavigate: boolean);Valeur de propriété
boolean
serviceKey
Clé de service pour SPHttpClient.
static readonly serviceKey: ServiceKey<SPHttpClient>;Valeur de propriété
Détails de la méthode
_fetch(url, configuration, options)
protected _fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;Paramètres
- url
-
string
- configuration
- SPHttpClientConfiguration
- options
- ISPHttpClientOptions
Retours
Promise<SPHttpClientResponse>
beginBatch(batchCreationOptions)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Commence un lot ODATA qui permet de regrouper plusieurs requêtes REST dans une requête web unique.
beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;Paramètres
- batchCreationOptions
- ISPHttpClientBatchCreationOptions
Retours
Objet SPHttpClientBatch utilisé pour gérer l’opération de traitement par lots.
fetch(url, configuration, options)
Effectuez un appel de service REST.
fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;Paramètres
- url
-
string
URL à récupérer
- configuration
- SPHttpClientConfiguration
Détermine le comportement par défaut de SPHttpClient. Il s’agit généralement du dernier numéro de version de HttpClientConfigurations
- options
- ISPHttpClientOptions
options supplémentaires qui affectent la requête
Retours
Promise<SPHttpClientResponse>
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
En règle générale, les paramètres et la sémantique pour SPHttpClient.fetch() sont essentiellement identiques à la norme d’API WHATWG documentée ici : https://fetch.spec.whatwg.org/
La sous-classe SPHttpClient ajoute des comportements supplémentaires qui sont pratiques lors de l’utilisation des API ODATA SharePoint (qui peuvent être évités en utilisant HttpClient à la place) :
Les en-têtes « Accept » et « Content-Type » par défaut sont ajoutés s’ils ne sont pas explicitement spécifiés.
Pour les opérations d’écriture, un en-tête « X-RequestDigest » est automatiquement ajouté
Le jeton de synthèse de la demande est automatiquement extrait et stocké dans un cache, avec prise en charge du préchargement
Pour une opération d’écriture, SPHttpClient ajoute automatiquement l’en-tête « X-RequestDigest », qui peut avoir besoin d’être obtenu en émettant une requête distincte telle que «https://example.com/sites/sample/_api/contextinfo" ; ». En règle générale, l’URL SPWeb appropriée peut être devinée en recherchant un segment d’URL réservé tel que « _api » dans l’URL d’origine passée à fetch() ; Si ce n’est pas le cas, utilisez ISPHttpClientOptions.webUrl pour le spécifier explicitement.
get(url, configuration, options)
Appelle fetch(), mais définit la méthode sur « GET ».
get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): Promise<SPHttpClientResponse>;Paramètres
- url
-
string
URL à récupérer
- configuration
- SPHttpClientConfiguration
Détermine le comportement par défaut de SPHttpClient. Il s’agit généralement du dernier numéro de version de HttpClientConfigurations
- options
- ISPHttpClientOptions
options supplémentaires qui affectent la requête
Retours
Promise<SPHttpClientResponse>
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.
getWebUrlFromRequestUrl(requestUrl)
Utilisez une heuristique pour déduire l’URL de base pour l’authentification.
static getWebUrlFromRequestUrl(requestUrl: string): string;Paramètres
- requestUrl
-
string
URL d’un service REST SharePoint
Retours
string
l’URL SPWeb déduite
Remarques
Tente de déduire l’URL SPWeb associée à l’URL REST fournie en recherchant des composants de chemin d’accès SharePoint courants tels que « _api », « _layouts » ou « _vit_bin ». Cette méthode est nécessaire pour les opérations telles que le X-RequestDigest et le traitement par lots ODATA, qui requièrent une publication à un point de terminaison REST distinct pour terminer une demande.
Par exemple, si requestUrl est « /sites/site/web/_api/service », l’URL renvoyée est « /sites/site/web ». Ou si requestUrl a la valeur « http://example.com/_layouts/service", l’URL retournée serait « http://example.com".
Si l’URL ne peut pas être déterminée, une exception est levée.
post(url, configuration, options)
Appelle fetch(), mais définit la méthode sur « POST ».
post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;Paramètres
- url
-
string
URL à récupérer
- configuration
- SPHttpClientConfiguration
Détermine le comportement par défaut de SPHttpClient. Il s’agit généralement du dernier numéro de version de HttpClientConfigurations
- options
- ISPHttpClientOptions
options supplémentaires qui affectent la requête
Retours
Promise<SPHttpClientResponse>
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.