SPHttpClientCommonConfiguration class

Paquete:

@microsoft/sp-http-base

Clase base común para SPHttpClientConfiguration y SPHttpClientBatchConfiguration.

Extends

HttpClientConfiguration

Constructores

(constructor)(flags, overrideFlags)

Construye una nueva instancia de SPHttpClientCommonConfiguration con las marcas especificadas.

Propiedades

flags
jsonRequest	Configure automáticamente el encabezado "Content-Type" para una carga JSON.
jsonResponse	Configure automáticamente el encabezado "Accept" para una carga JSON.

Métodos

initializeFlags()
overrideWith(sourceFlags)

Detalles del constructor

(constructor)(flags, overrideFlags)

Construye una nueva instancia de SPHttpClientCommonConfiguration con las marcas especificadas.

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

Parámetros

flags

ISPHttpClientCommonConfiguration

overrideFlags

ISPHttpClientCommonConfiguration

Comentarios

Se usarán los valores predeterminados para las marcas que falten o que no estén definidas. Si se especifica overrideFlags, tiene prioridad sobre las marcas.

Detalles de las propiedades

flags

protected flags: ISPHttpClientCommonConfiguration;

Valor de propiedad

ISPHttpClientCommonConfiguration

jsonRequest

Configure automáticamente el encabezado "Content-Type" para una carga JSON.

get jsonRequest(): boolean;

Valor de propiedad

boolean

Comentarios

Cuando este modificador es true:

Si el encabezado "Content-Type" 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").

En el caso de OData 3.0, el valor es "application/json;odata=verbose;charset=utf-8".

En el caso de OData 4.0, el valor es "application/json;charset=utf-8".

jsonResponse

Configure automáticamente el encabezado "Accept" para una carga JSON.

get jsonResponse(): boolean;

Valor de propiedad

boolean

Comentarios

Cuando este modificador es true:

Si el encabezado "Accept" no se agregó explícitamente para la solicitud, SPHttpClient lo agregará.

En el caso de OData 3.0, el valor es "application/json".

En el caso de OData 4.0, el valor es "application/json;odata.metadata=minimal".

Detalles del método

initializeFlags()

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

Devoluciones

void

overrideWith(sourceFlags)

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

Parámetros

sourceFlags

ISPHttpClientCommonConfiguration

Devoluciones

SPHttpClientCommonConfiguration