SPHttpClientConfiguration class

Pacote:

@microsoft/sp-http-base

Configuração para SPHttpClient.

Extends

SPHttpClientCommonConfiguration

Comentários

O objeto SPHttpClientConfiguration fornece um conjunto de opções para ativar/desativar vários recursos da classe SPHttpClient. Normalmente essas opções estão definidas (por exemplo, ao chamar SPHttpClient.fetch()) fornecendo um dos padrões predefinidos de SPHttpClientConfigurations; porém, as opções também podem ser alteradas por meio do método SPHttpClientConfiguration.overrideWith().

Construtores

(constructor)(flags, overrideFlags)

Cria uma nova instância do SPHttpClientConfiguration com os sinalizadores especificados. Os valores padrão serão usados para quaisquer sinalizadores ausentes ou indefinidos. Se overrideFlags for especificado, ele terá precedência sobre outros sinalizadores.

Propriedades

defaultODataVersion	Configure automaticamente o cabeçalho "OData-Version".
defaultSameOriginCredentials	Configure automaticamente o RequestInit.credentials.
flags
requestDigest	Forneça automaticamente um cabeçalho "X-RequestDigest" para autenticação.

Métodos

initializeFlags()
overrideWith(sourceFlags)

Detalhes do construtor

(constructor)(flags, overrideFlags)

Cria uma nova instância do SPHttpClientConfiguration com os sinalizadores especificados. Os valores padrão serão usados para quaisquer sinalizadores ausentes ou indefinidos. Se overrideFlags for especificado, ele terá precedência sobre outros sinalizadores.

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

Parâmetros

flags

ISPHttpClientConfiguration

overrideFlags

ISPHttpClientConfiguration

Detalhes da propriedade

defaultODataVersion

Configure automaticamente o cabeçalho "OData-Version".

get defaultODataVersion(): ODataVersion;

Valor da propriedade

ODataVersion

Comentários

Quando este comutador é especificado (ou seja, não está indefinido): se o cabeçalho "OData-Version" não tiver sido explicitamente adicionado para o pedido, o SPHttpClient adicionará o cabeçalho para especificar a versão indicada por defaultODataVersion.

OBSERVAÇÃO: Sem um cabeçalho 'OData-Version', o servidor do SharePoint atualmente considera padrão a versão 3.0 na maioria dos casos. A versão recomendada é 4.0.

defaultSameOriginCredentials

Configure automaticamente o RequestInit.credentials.

get defaultSameOriginCredentials(): boolean;

Valor da propriedade

boolean

Comentários

Quando este parâmetro é verdadeiro:

Se RequestInit.credentials não for explicitamente especificado para o pedido, o SPHttpClient irá atribuí-lo como "same-origin". Sem essa opção, navegadores da Web diferentes podem aplicar diferentes padrões.

Para saber mais, veja a especificação: https://fetch.spec.whatwg.org/\#cors-protocol-and-credentials

flags

protected flags: ISPHttpClientConfiguration;

Valor da propriedade

ISPHttpClientConfiguration

requestDigest

Forneça automaticamente um cabeçalho "X-RequestDigest" para autenticação.

get requestDigest(): boolean;

Valor da propriedade

boolean

Comentários

Quando este parâmetro é verdadeiro:

Se o cabeçalho "X-RequestDigest" 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 "OPTIONS"). O resumo da solicitação é gerenciado pelo serviço DigestCache. No caso de um erro de cache, uma solicitação de rede adicional pode ser executada.

Detalhes do método

initializeFlags()

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

Retornos

void

overrideWith(sourceFlags)

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

Parâmetros

sourceFlags

ISPHttpClientConfiguration

Retornos

SPHttpClientConfiguration