ISPHttpClientConfiguration interface

Paquet:

@microsoft/sp-http-base

Interface d’indicateurs pour SPHttpClientConfiguration.

Extends

ISPHttpClientCommonConfiguration

Propriétés

defaultODataVersion	Configurez automatiquement l’en-tête « OData-Version ».
defaultSameOriginCredentials	Configurez automatiquement RequestInit.credentials.
requestDigest	Fournissez automatiquement un en-tête « X-RequestDigest » pour l’authentification.
usePopupForCookieRefresh	Gérer l’actualisation des cookies avec une boîte de dialogue contextuelle

Détails de la propriété

defaultODataVersion

Configurez automatiquement l’en-tête « OData-Version ».

defaultODataVersion?: ODataVersion;

Valeur de propriété

ODataVersion

Remarques

Lorsque ce commutateur est spécifié (c’est-à-dire non défini) : si l’en-tête « OData-Version » n’a pas été explicitement ajouté pour la requête, SPHttpClient ajoute l’en-tête pour spécifier la version indiquée par defaultODataVersion.

REMARQUE : Sans en-tête « OData-Version », le serveur SharePoint est, dans la plupart des cas, défini par défaut sur la Version 3.0. La version recommandée est la version 4.0.

defaultSameOriginCredentials

Configurez automatiquement RequestInit.credentials.

defaultSameOriginCredentials?: boolean;

Valeur de propriété

boolean

Remarques

Lorsque ce commutateur a la valeur true :

Si RequestInit.credentials n’est pas explicitement spécifié pour la requête, SPHttpClient l’affectera à « same-origin ». Sans ce commutateur, différents navigateurs web peuvent appliquer différentes valeurs par défaut.

Pour plus d’informations, consultez les spécifications : https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials

requestDigest

Fournissez automatiquement un en-tête « X-RequestDigest » pour l’authentification.

requestDigest?: boolean;

Valeur de propriété

boolean

Remarques

Lorsque ce commutateur a la valeur true :

Si l’en-tête « X-RequestDigest » n’a pas été explicitement ajouté pour la requête, SPHttpClient l’ajoute si la requête est une opération d’écriture (c’est-à-dire une méthode HTTP autre que « GET », « HEAD » ou « OPTIONS »). La requête Digest est gérée par le service DigestCache. Dans le cas d’une absence de cache, une demande de réseau supplémentaire peut être effectuée.

usePopupForCookieRefresh

Gérer l’actualisation des cookies avec une boîte de dialogue contextuelle

usePopupForCookieRefresh?: boolean;

Valeur de propriété

boolean

Remarques

Lorsque ce commutateur a la valeur true, l’authentification contextuelle est utilisée pour gérer une actualisation de cookie. Cela signifie que l’appelant doit gérer les événements de fenêtre contextuelle. S’il n’est pas défini ou s’il a la valeur false full page, la redirection est définie par défaut.