SPHttpClientConfiguration class
Configuration de SPHttpClient.
- Extends
Remarques
L’objet SPHttpClientConfiguration fournit un ensemble de commutateurs permettant d’activer/désactiver diverses fonctionnalités de la classe SPHttpClient. Normalement, ces commutateurs sont définis (par exemple, lors de l’appel de SPHttpClient.fetch()) en fournissant l’une des valeurs par défaut prédéfinies à partir de SPHttpClientConfigurations, mais les commutateurs peuvent également être modifiés via la méthode SPHttpClientConfiguration.overrideWith().
Constructeurs
| (constructor)(flags, override |
Crée une nouvelle instance de SPHttpClientConfiguration avec les indicateurs spécifiés. Les valeurs par défaut seront utilisées pour tous les indicateurs manquants ou non définis. Si overrideFlags est spécifié, il est prioritaire sur les indicateurs. |
Propriétés
| default |
Configurez automatiquement l’en-tête « OData-Version ». |
| default |
Configurez automatiquement RequestInit.credentials. |
| flags | |
| request |
Fournissez automatiquement un en-tête « X-RequestDigest » pour l’authentification. |
Méthodes
| initialize |
|
| override |
Détails du constructeur
(constructor)(flags, overrideFlags)
Crée une nouvelle instance de SPHttpClientConfiguration avec les indicateurs spécifiés. Les valeurs par défaut seront utilisées pour tous les indicateurs manquants ou non définis. Si overrideFlags est spécifié, il est prioritaire sur les indicateurs.
constructor(flags: ISPHttpClientConfiguration, overrideFlags?: ISPHttpClientConfiguration);Paramètres
- overrideFlags
- ISPHttpClientConfiguration
Détails de la propriété
defaultODataVersion
Configurez automatiquement l’en-tête « OData-Version ».
get defaultODataVersion(): ODataVersion;Valeur de propriété
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.
get 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
flags
requestDigest
Fournissez automatiquement un en-tête « X-RequestDigest » pour l’authentification.
get 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.
Détails de la méthode
initializeFlags()
/** @override */
protected initializeFlags(): void;Retours
void
overrideWith(sourceFlags)
/** @override */
overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;Paramètres
- sourceFlags
- ISPHttpClientConfiguration