SPHttpClientConfiguration class
Configuração para SPHttpClient.
- Extends
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, override |
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
| default |
Configure automaticamente o cabeçalho "OData-Version". |
| default |
Configure automaticamente o RequestInit.credentials. |
| flags | |
| request |
Forneça automaticamente um cabeçalho "X-RequestDigest" para autenticação. |
| use |
Lidar com a atualização de cookies com uma caixa de diálogo pop-up |
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
- overrideFlags
- ISPHttpClientConfiguration
Detalhes da propriedade
defaultODataVersion
Configure automaticamente o cabeçalho "OData-Version".
get defaultODataVersion(): ODataVersion;
Valor da propriedade
Comentários
Quando essa opção for especificada (ou seja, não indefinida): se o cabeçalho "OData-Version" não tiver sido adicionado explicitamente para a solicitaçã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 essa opção for verdadeira:
Se RequestInit.credentials não for especificado explicitamente para a solicitação, SPHttpClient o atribuirá como "mesma origem". 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
requestDigest
Forneça automaticamente um cabeçalho "X-RequestDigest" para autenticação.
get requestDigest(): boolean;
Valor da propriedade
boolean
Comentários
Quando essa opção for verdadeira:
Se o cabeçalho "X-RequestDigest" não tiver sido adicionado explicitamente para a solicitação, SPHttpClient o adicionará se a solicitação for uma operação de gravação (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.
usePopupForCookieRefresh
Lidar com a atualização de cookies com uma caixa de diálogo pop-up
get usePopupForCookieRefresh(): boolean;
Valor da propriedade
boolean
Comentários
Quando essa opção for verdadeira, a autenticação pop-up será usada para lidar com uma atualização de cookie. Isso significa que o chamador deve lidar com os eventos pop-up. Se for indefinido ou falso, o redirecionamento de página inteira será padronizado.
Detalhes do método
initializeFlags()
/** @override */
protected initializeFlags(): void;
Retornos
void
overrideWith(sourceFlags)
/** @override */
overrideWith(sourceFlags: ISPHttpClientConfiguration): SPHttpClientConfiguration;
Parâmetros
- sourceFlags
- ISPHttpClientConfiguration