Edit

Share via

ISPHttpClientConfiguration interface

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

Flags interface for SPHttpClientConfiguration.

Extends
ISPHttpClientCommonConfiguration

Properties

defaultODataVersion

Automatically configure the "OData-Version" header.
defaultSameOriginCredentials

Automatically configure the RequestInit.credentials.
requestDigest

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

Property Details

defaultODataVersion

Automatically configure the "OData-Version" header.

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.

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

requestDigest

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

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.