Partager via

SPHttpClientCommonConfiguration class

  • Référence
Paquet:
@microsoft/sp-http-base

Classe de base courante pour SPHttpClientConfiguration et SPHttpClientBatchConfiguration.

Extends
HttpClientConfiguration

Constructeurs

(constructor)(flags, overrideFlags)

Crée une nouvelle instance de SPHttpClientCommonConfiguration avec les indicateurs spécifiés.

Propriétés

flags
jsonRequest

Configurez automatiquement l’en-tête « Content-Type » pour une charge utile JSON.
jsonResponse

Configurez automatiquement l’en-tête « Accepter » pour une charge utile JSON.

Méthodes

initializeFlags()
overrideWith(sourceFlags)

Détails du constructeur

(constructor)(flags, overrideFlags)

Crée une nouvelle instance de SPHttpClientCommonConfiguration avec les indicateurs spécifiés.

constructor(flags: ISPHttpClientCommonConfiguration, overrideFlags?: ISPHttpClientCommonConfiguration);

Paramètres

flags
ISPHttpClientCommonConfiguration
overrideFlags
ISPHttpClientCommonConfiguration

Remarques

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.

Détails de la propriété

flags 

protected flags: ISPHttpClientCommonConfiguration;

Valeur de propriété

ISPHttpClientCommonConfiguration

jsonRequest

Configurez automatiquement l’en-tête « Content-Type » pour une charge utile JSON.

get jsonRequest(): boolean;

Valeur de propriété

boolean

Remarques

Lorsque ce commutateur a la valeur true :

Si l’en-tête « Content-Type » 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 »).

Pour OData 3.0, la valeur est « application/json;odata=verbose;charset=utf-8 ».

Pour OData 4.0, la valeur est « application/json;charset=utf-8 ».

jsonResponse

Configurez automatiquement l’en-tête « Accepter » pour une charge utile JSON.

get jsonResponse(): boolean;

Valeur de propriété

boolean

Remarques

Lorsque ce commutateur a la valeur true :

Si l’en-tête « Accept » n’a pas été explicitement ajouté pour la requête, SPHttpClient l’ajoute.

Pour OData 3.0, la valeur est « application/json ».

Pour OData 4.0, la valeur est « application/json;odata.metadata=minimal ».

Détails de la méthode

initializeFlags() 

/** @override */
protected initializeFlags(): void;

Retours

void

overrideWith(sourceFlags) 

/** @override */
overrideWith(sourceFlags: ISPHttpClientCommonConfiguration): SPHttpClientCommonConfiguration;

Paramètres

sourceFlags
ISPHttpClientCommonConfiguration

Retours

SPHttpClientCommonConfiguration