Compartilhar via

SPHttpClientCommonConfiguration class

  • Referência
Pacote:
@microsoft/sp-http-base

A classe base comum para SPHttpClientConfiguration e SPHttpClientBatchConfiguration.

Extends
HttpClientConfiguration

Construtores

(constructor)(flags, overrideFlags)

Cria uma nova instância do SPHttpClientCommonConfiguration com os sinalizadores especificados.

Propriedades

flags
jsonRequest

Configure automaticamente o cabeçalho "Content-Type" para um payload JSON.
jsonResponse

Configure automaticamente o cabeçalho "Aceitar" para um payload JSON.

Métodos

initializeFlags()
overrideWith(sourceFlags)

Detalhes do construtor

(constructor)(flags, overrideFlags)

Cria uma nova instância do SPHttpClientCommonConfiguration com os sinalizadores especificados.

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

Parâmetros

flags
ISPHttpClientCommonConfiguration
overrideFlags
ISPHttpClientCommonConfiguration

Comentários

Os valores padrão serão usados para quaisquer sinalizadores ausentes ou indefinidos. Se overrideFlags for especificado, ele terá precedência sobre outros sinalizadores.

Detalhes da propriedade

flags 

protected flags: ISPHttpClientCommonConfiguration;

Valor da propriedade

ISPHttpClientCommonConfiguration

jsonRequest

Configure automaticamente o cabeçalho "Content-Type" para um payload JSON.

get jsonRequest(): boolean;

Valor da propriedade

boolean

Comentários

Quando este parâmetro é verdadeiro:

Se o cabeçalho "Content-Type" não tiver sido explicitamente adicionado para o pedido, o SPHttpClient irá adicioná-lo se o pedido for uma operação de escrita (ou seja, um método HTTP diferente de "GET", "HEAD" ou "OPÇÕES").

Em OData 3.0, o valor é 'application/json;odata=verbose;charset=utf-8'.

Em OData 4.0, o valor é 'application/json;charset=utf-8'.

jsonResponse

Configure automaticamente o cabeçalho "Aceitar" para um payload JSON.

get jsonResponse(): boolean;

Valor da propriedade

boolean

Comentários

Quando este parâmetro é verdadeiro:

Se o cabeçalho "Aceitar" não tiver sido explicitamente adicionado para o pedido, o SPHttpClient irá adicioná-lo.

Em OData 3.0, o valor é 'application/json'.

Em OData 4.0, o valor é 'application/json;odata.metadata=minimal'.

Detalhes do método

initializeFlags() 

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

Retornos

void

overrideWith(sourceFlags) 

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

Parâmetros

sourceFlags
ISPHttpClientCommonConfiguration

Retornos

SPHttpClientCommonConfiguration