ISPHttpClientConfiguration interface

Paquete:

@microsoft/sp-http-base

Interfaz de marcas para SPHttpClientConfiguration.

Extends

ISPHttpClientCommonConfiguration

Propiedades

defaultODataVersion	Configure automáticamente el encabezado "OData-Version".
defaultSameOriginCredentials	Configure automáticamente RequestInit.credentials.
requestDigest	Proporcione automáticamente un encabezado "X-RequestDigest" para la autenticación.
usePopupForCookieRefresh	Controlar la actualización de cookies con un cuadro de diálogo emergente

Detalles de las propiedades

defaultODataVersion

Configure automáticamente el encabezado "OData-Version".

defaultODataVersion?: ODataVersion;

Valor de propiedad

ODataVersion

Comentarios

Cuando se especifica este modificador (es decir, no está indefinido): si el encabezado "OData-Version" no se agregó explícitamente para la solicitud, SPHttpClient agregará el encabezado para especificar la versión indicada por defaultODataVersion.

NOTA: Si no hay un encabezado "OData-Version", el servidor de SharePoint tiene actualmente como valor predeterminado la versión 3.0 en la mayoría de los casos. La versión recomendada es 4.0.

defaultSameOriginCredentials

Configure automáticamente RequestInit.credentials.

defaultSameOriginCredentials?: boolean;

Valor de propiedad

boolean

Comentarios

Cuando este modificador es true:

Si RequestInit.credentials no se especifica explícitamente para la solicitud, SPHttpClient la asignará como "mismo origen". Sin este modificador, los distintos exploradores web pueden aplicar valores predeterminados diferentes.

Para más información, vea las especificaciones: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials

requestDigest

Proporcione automáticamente un encabezado "X-RequestDigest" para la autenticación.

requestDigest?: boolean;

Valor de propiedad

boolean

Comentarios

Cuando este modificador es true:

Si el encabezado "X-RequestDigest" no se agregó explícitamente para la solicitud, SPHttpClient lo agregará si la solicitud es una operación de escritura (es decir, un método HTTP distinto de "GET", "HEAD" o "OPTIONS"). El resumen de la solicitud se administra mediante el servicio DigestCache. En el caso de un error de caché, podría realizarse una solicitud de red adicional.

usePopupForCookieRefresh

Controlar la actualización de cookies con un cuadro de diálogo emergente

usePopupForCookieRefresh?: boolean;

Valor de propiedad

boolean

Comentarios

Cuando este modificador es true, se usará la autenticación emergente para controlar una actualización de cookies. Esto significa que el autor de la llamada debe controlar los eventos emergentes. Si es undefined o false full page redirect will be defaulted to.