Partager via


@microsoft/sp-http-base 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 de HttpClient.

AadHttpClientFactory

Retourne une version préinitialisée d’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 AadHttpClient.fetch(). Classe qui étend HttpClientResponse en ajoutant des fonctionnalités supplémentaires spécifiques à AadHttpClient.

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 de la page SharePoint auprès d’autres services tels que PowerBI, Sway, Exchange, Yammer, etc.

AadTokenProviderFactory

Retourne une version préinitialisée d’AadTokenProviderFactory.

BeforeRedirectEventArgs

Arguments pour avant de rediriger pour une authentification pleine page

DigestCache

IDigestCache est un service interne utilisé par SPHttpClient pour gérer un cache de synthèses de requêtes pour chaque URL SPWeb. Une synthèse de requête est un jeton de sécurité dont le serveur SharePoint a besoin 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 un délai 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 de HttpClient.

HttpClientResponse

Sous-classe Response renvoyée par des méthodes telles que HttpClient.fetch().

ODataVersion

Représente la version prise en charge de l’en-tête « OData-Version », qui fait partie de la norme Open Data Protocol.

PopupEventArgs

Arguments d’un événement de fenêtre contextuelle si une interaction est requise pendant le flux de connexion.

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 seul lot ODATA. 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 traitement par lots. La méthode execute() retourne une promesse qui se résout lorsque l’appel REST réel est terminé. Chaque appel à fetch() retourne également une promesse qui sera résolue avec un objet SPHttpClientResponse pour cette requête particulière.

SPHttpClientBatchConfiguration

Configuration de SPHttpClientBatch.

SPHttpClientCommonConfiguration

Classe de base courante pour SPHttpClientConfiguration et SPHttpClientBatchConfiguration.

SPHttpClientConfiguration

Configuration de SPHttpClient.

SPHttpClientResponse

Sous-classe Response renvoyée par des méthodes telles que SPHttpClient.fetch().

TokenAcquisitionEventArgs

Arguments d’un événement d’échec d’acquisition de jeton.

Interfaces

IAadHttpClientConfiguration

Interface d’indicateurs pour HttpClientConfiguration.

IAadHttpClientConfigurations

Standard configurations 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 de la page SharePoint auprès d’autres services tels que PowerBI, Sway, Exchange, Yammer, etc.

IAadTokenProviderConfiguration

Chaînes requises pour construire 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. Une synthèse de requête est un jeton de sécurité dont le serveur SharePoint a besoin 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 un délai 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 »

IGetTokenOptions
IHttpClientConfiguration

Interface d’indicateurs pour HttpClientConfiguration.

IHttpClientConfigurations

Standard configurations pour HttpClient.

IHttpClientOptions

Options pour HttpClient

IPopupEventArgs

Représente les arguments utilisés avant l’événement de fenêtre contextuelle.

ISPHttpClientBatchConfiguration

Interface flags pour SPHttpClientBatchConfiguration.

ISPHttpClientBatchConfigurations

Standard configurations pour SPHttpClient.

ISPHttpClientBatchCreationOptions

Cette interface est passée au constructeur SPHttpClientBatch. Il spécifie les options qui affectent l’ensemble 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

Standard configurations 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 de défaillance acquisiton de jeton.

Énumérations

IAuthenticationScheme

Options pour le schéma d’authentification

SPHttpHeader

Standard en-têtes HTTP utilisés avec SPHttpClient