Edit

Share via

SPHttpClientConfiguration class

  • Reference
Package:
@microsoft/sp-http-base

Configuration for SPHttpClient.

Extends
SPHttpClientCommonConfiguration

Remarks

The SPHttpClientConfiguration object provides a set of switches for enabling/disabling various features of the SPHttpClient class. Normally these switches are set (e.g. when calling SPHttpClient.fetch()) by providing one of the predefined defaults from SPHttpClientConfigurations, however switches can also be changed via the SPHttpClientConfiguration.overrideWith() method.

Constructors

(constructor)(flags, overrideFlags)

Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.

Properties

defaultODataVersion

Automatically configure the "OData-Version" header.
defaultSameOriginCredentials

Automatically configure the RequestInit.credentials.
flags
requestDigest

Automatically provide an "X-RequestDigest" header for authentication.

Methods

initializeFlags()
overrideWith(sourceFlags)

Constructor Details

(constructor)(flags, overrideFlags)

Constructs a new instance of SPHttpClientConfiguration with the specified flags. The default values will be used for any flags that are missing or undefined. If overrideFlags is specified, it takes precedence over flags.

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

Parameters

flags
ISPHttpClientConfiguration
overrideFlags
ISPHttpClientConfiguration

Property Details

defaultODataVersion

Automatically configure the "OData-Version" header.

get defaultODataVersion(): ODataVersion;

Property Value

ODataVersion

Remarks

When this switch is specified (i.e. not undefined): If the "OData-Version" header was not explicitly added for the request, then SPHttpClient will add the header to specify the version indicated by defaultODataVersion.

NOTE: Without an 'OData-Version' header, the SharePoint server currently defaults to Version 3.0 in most cases. The recommended version is 4.0.

defaultSameOriginCredentials

Automatically configure the RequestInit.credentials.

get defaultSameOriginCredentials(): boolean;

Property Value

boolean

Remarks

When this switch is true:

If RequestInit.credentials is not explicitly specified for the request, then SPHttpClient will assign it to be "same-origin". Without this switch, different web browsers may apply different defaults.

For more information, see the spec: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials

flags 

protected flags: ISPHttpClientConfiguration;

Property Value

ISPHttpClientConfiguration

requestDigest

Automatically provide an "X-RequestDigest" header for authentication.

get requestDigest(): boolean;

Property Value

boolean

Remarks

When this switch is true:

If the "X-RequestDigest" header was not explicitly added for the request, then SPHttpClient will add it if the request is a write operation (i.e. an HTTP method other than "GET", "HEAD", or "OPTIONS"). The request digest is managed by the DigestCache service. In the case of a cache miss, an additional network request may be performed.

Method Details

initializeFlags() 

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

Returns

void

overrideWith(sourceFlags) 

/** @override */
overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;

Parameters

sourceFlags
ISPHttpClientConfiguration

Returns

SPHttpClientConfiguration