@microsoft/sp-http package
Couche de communication de base pour le SharePoint Framework
Classes
AadHttpClient |
AadHttpClient est utilisé pour effectuer des appels REST sur une application Azure AD. |
AadHttpClientConfiguration |
Configuration pour HttpClient. |
AadHttpClientFactory |
Retourne une version préinitialisée de l’AadHttpClient pour une URL de ressource donnée. Pour plus d’informations : https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient |
AadHttpClientResponse |
Sous-classe Response retournée par des méthodes telles que |
AadTokenProvider |
Cette classe permet à un développeur d’obtenir des jetons OAuth2 à partir d’Azure AD. Les jetons OAuth2 sont utilisés pour authentifier l’utilisateur à partir de la page SharePoint à d’autres services tels que PowerBI, Sway, Exchange, Yammer, etc. |
AadTokenProviderFactory |
Retourne une version préinitialisée d’AadTokenProviderFactory. |
BeforeRedirectEventArgs |
Arguments pour avant la redirection pour une authentification de page complète |
DigestCache |
IDigestCache est un service interne utilisé par SPHttpClient pour gérer un cache de synthèses de requêtes pour chaque URL SPWeb. Un condensé de demande est un jeton de sécurité requis par le serveur SharePoint pour toute opération d’écriture REST, spécifié via l’en-tête HTTP « X-RequestDigest ». Il est obtenu en appelant le point de terminaison REST « /_api/contextinfo » et expire après une durée configurable par le serveur. Pour plus d’informations, consultez l’article MSDN « Effectuer des opérations de base à l’aide de points de terminaison REST SharePoint 2013 » |
HttpClient |
HttpClient implémente un ensemble de fonctionnalités de base pour effectuer des opérations REST sur un service générique. |
HttpClientConfiguration |
Configuration pour HttpClient. |
HttpClientResponse |
Sous-classe Response renvoyée par des méthodes telles que HttpClient.fetch(). |
MSGraphClient |
MSGraphClient est utilisé pour effectuer des appels REST sur Microsoft Graph. |
MSGraphClientFactory |
Retourne une version préinitialisée de MSGraphClient. Pour plus d’informations : https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-msgraph |
MSGraphClientV3 |
MSGraphClient est utilisé pour effectuer des appels REST sur Microsoft Graph. |
ODataVersion |
Représente la version prise en charge de l’en-tête « OData-Version », qui fait partie de la norme Open Data Protocol. |
SPHttpClient |
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. |
SPHttpClientBatch |
La classe SPHttpClientBatch accumule un certain nombre d’appels de service REST et les transmet sous la forme d’un lot ODATA unique. Ce protocole est documenté ici : http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html L’utilisation consiste à appeler SPHttpClientBatch.fetch() pour mettre en file d’attente chaque requête individuelle, puis à appeler SPHttpClientBatch.execute() pour exécuter l’opération de lot. La méthode execute() retourne une promesse qui se résout une fois l’appel REST réel terminé. Chaque appel à fetch() retourne également une promesse qui sera résolue avec un objet SPHttpClientResponse pour cette requête particulière. |
SPHttpClientBatchConfiguration |
Configuration pour SPHttpClientBatch. |
SPHttpClientCommonConfiguration |
Classe de base courante pour SPHttpClientConfiguration et SPHttpClientBatchConfiguration. |
SPHttpClientConfiguration |
Configuration pour SPHttpClient. |
SPHttpClientResponse |
Sous-classe Response renvoyée par des méthodes telles que SPHttpClient.fetch(). |
TokenAcquisitionEventArgs |
Arguments pour un événement d’échec d’acquisition de jeton. |
Interfaces
GraphRequest |
Saisies pour l’objet GraphRequest Pour plus d’informations : https://github.com/microsoftgraph/msgraph-sdk-javascript |
IAadHttpClientConfiguration |
Interface d’indicateurs pour HttpClientConfiguration. |
IAadHttpClientConfigurations |
Configurations standard pour AadHttpClient. |
IAadHttpClientOptions |
Interface permettant de remplacer le comportement par défaut d’AadHttpClient. |
IAadTokenProvider |
Cette classe permet à un développeur d’obtenir des jetons OAuth2 à partir d’Azure AD. Les jetons OAuth2 sont utilisés pour authentifier l’utilisateur à partir de la page SharePoint à d’autres services tels que PowerBI, Sway, Exchange, Yammer, etc. |
IAadTokenProviderConfiguration |
Chaînes requises pour la construction d’un AadTokenProvider. |
IBeforeRedirectEventArgs |
Représente les arguments utilisés avant la redirection de l’événement. |
IDigestCache |
IDigestCache est un service interne utilisé par SPHttpClient pour gérer un cache de synthèses de requêtes pour chaque URL SPWeb. Un condensé de demande est un jeton de sécurité requis par le serveur SharePoint pour toute opération d’écriture REST, spécifié via l’en-tête HTTP « X-RequestDigest ». Il est obtenu en appelant le point de terminaison REST « /_api/contextinfo » et expire après une durée configurable par le serveur. Pour plus d’informations, consultez l’article MSDN « Effectuer des opérations de base à l’aide de points de terminaison REST SharePoint 2013 » |
IHttpClientConfiguration |
Interface d’indicateurs pour HttpClientConfiguration. |
IHttpClientConfigurations |
Configurations standard pour HttpClient. |
IHttpClientOptions |
Options pour HttpClient |
ISPHttpClientBatchConfiguration |
Interface Indicateurs pour SPHttpClientBatchConfiguration. |
ISPHttpClientBatchConfigurations |
Configurations standard pour SPHttpClient. |
ISPHttpClientBatchCreationOptions |
Cette interface est passée au constructeur SPHttpClientBatch. Il spécifie les options qui affectent l’intégralité du lot. |
ISPHttpClientBatchOptions |
Cette interface définit les options d’une requête REST individuelle qui fait partie d’un SPHttpClientBatch. Il est basé sur les paramètres standard de l’API WHATWG qui sont documentés ici : https://fetch.spec.whatwg.org/ |
ISPHttpClientCommonConfiguration |
Interface indicateurs pour SPHttpClientCommonConfiguration |
ISPHttpClientConfiguration |
Interface d’indicateurs pour SPHttpClientConfiguration. |
ISPHttpClientConfigurations |
Configurations standard pour SPHttpClient. |
ISPHttpClientOptions |
Cette interface définit les options pour les opérations SPHttpClient comme get(), post(), fetch(), etc. Elle est basée sur les paramètres standard de l’API WHATWG qui sont décrits ici : https://fetch.spec.whatwg.org/ |
ITokenAcquisitionEventArgs |
Représente les arguments utilisés pour déclencher un événement d’échec d’acquisiton de jeton. |
Énumérations
SPHttpHeader |
En-têtes HTTP standard utilisés avec SPHttpClient |