SPHttpClient class
SPHttpClient é usado para realizar chamadas REST em relação ao SharePoint. Ela adiciona cabeçalhos padrão, gerencia o resumo necessário para gravações e coleta a telemetria que ajuda o serviço a monitorar o desempenho de um aplicativo.
Comentários
Esta classe está marcada como @sealed. As subclasses não devem expandi-la.
Para comunicar com outros serviços de Internet, utilize a classe HttpClient .
Construtores
| (constructor)(service |
Constrói uma nova instância da |
Propriedades
| configurations | Os objetos SPHttpClientConfiguration predefinidos padrão para utilização com a classe SPHttpClient. |
| is |
|
| service |
A chave de serviço para SPHttpClient. |
Métodos
| _fetch(url, configuration, options) | |
| begin |
Inicia um lote ODATA, que permite que várias consultas REST sejam agrupadas em uma solicitação única da Web. |
| fetch(url, configuration, options) | Efetue uma chamada de serviço REST. |
| get(url, configuration, options) | Chama fetch(), mas define o método como "GET". |
| get |
Utilize um heurístico para inferir o URL base para autenticação. |
| post(url, configuration, options) | Chama fetch(), mas define o método como "POST". |
Detalhes do construtor
(constructor)(serviceScope)
Constrói uma nova instância da SPHttpClient classe
constructor(serviceScope: ServiceScope);Parâmetros
- serviceScope
- ServiceScope
Detalhes da propriedade
configurations
Os objetos SPHttpClientConfiguration predefinidos padrão para utilização com a classe SPHttpClient.
static readonly configurations: ISPHttpClientConfigurations;Valor da propriedade
isNavigate
get isNavigate(): boolean;
set isNavigate(isNavigate: boolean);Valor da propriedade
boolean
serviceKey
A chave de serviço para SPHttpClient.
static readonly serviceKey: ServiceKey<SPHttpClient>;Valor da propriedade
Detalhes do método
_fetch(url, configuration, options)
protected _fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;Parâmetros
- url
-
string
- configuration
- SPHttpClientConfiguration
- options
- ISPHttpClientOptions
Retornos
Promise<SPHttpClientResponse>
beginBatch(batchCreationOptions)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Inicia um lote ODATA, que permite que várias consultas REST sejam agrupadas em uma solicitação única da Web.
beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;Parâmetros
- batchCreationOptions
- ISPHttpClientBatchCreationOptions
Retornos
Um objeto SPHttpClientBatch utilizado para gerir a operação de lote.
fetch(url, configuration, options)
Efetue uma chamada de serviço REST.
fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;Parâmetros
- url
-
string
o URL a ser buscado
- configuration
- SPHttpClientConfiguration
determina o comportamento padrão de SPHttpClient; normalmente, deve ser o número da versão mais recente de SPHttpClientConfigurations
- options
- ISPHttpClientOptions
opções adicionais que afetam a solicitação
Retornos
Promise<SPHttpClientResponse>
Uma promessa com comportamento semelhante a WHATWG fetch(). Essa promessa será resolvida normalmente (com HttpClientResponse.ok sendo falso) para códigos de status de erro, tais como HTTP 404 ou 500. A promessa só será rejeitada por falhas de rede ou outros erros que impeçam a comunicação com o servidor.
Comentários
Geralmente, os parâmetros e a semântica para SPHttpClient.fetch() são essencialmente os mesmos que a norma da API WHATWG que está documentada aqui: https://fetch.spec.whatwg.org/
A subclasse SPHttpClient adiciona alguns comportamentos adicionais que são convenientes ao trabalhar com API ODATA do SharePoint (o que pode ser evitado com HttpClient em alternativa):
Os cabeçalhos predefinidos "Aceitar" e "Tipo de Conteúdo" são adicionados se não forem especificados explicitamente.
Para operações de escrita, é adicionado automaticamente um cabeçalho "X-RequestDigest"
O token de resumo do pedido é obtido e armazenado automaticamente numa cache, com suporte para pré-carregamento
Para uma operação de escrita, o SPHttpClient adicionará automaticamente o cabeçalho "X-RequestDigest", que poderá ter de ser obtido ao emitir um pedido separado, como "https://example.com/sites/sample/_api/contextinfo". Normalmente, a URL SPWeb apropriada pode ser adivinhada procurando um segmento de URL reservado como "_api" na URL original passado para fetch(); caso contrário, use ISPHttpClientOptions.webUrl para especificá-la explicitamente.
get(url, configuration, options)
Chama fetch(), mas define o método como "GET".
get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): Promise<SPHttpClientResponse>;Parâmetros
- url
-
string
o URL a ser buscado
- configuration
- SPHttpClientConfiguration
determina o comportamento padrão de SPHttpClient; normalmente, deve ser o número da versão mais recente de SPHttpClientConfigurations
- options
- ISPHttpClientOptions
opções adicionais que afetam a solicitação
Retornos
Promise<SPHttpClientResponse>
Uma promessa com comportamento semelhante a WHATWG fetch(). Essa promessa será resolvida normalmente (com HttpClientResponse.ok sendo falso) para códigos de status de erro, tais como HTTP 404 ou 500. A promessa só será rejeitada por falhas de rede ou outros erros que impeçam a comunicação com o servidor.
getWebUrlFromRequestUrl(requestUrl)
Utilize um heurístico para inferir o URL base para autenticação.
static getWebUrlFromRequestUrl(requestUrl: string): string;Parâmetros
- requestUrl
-
string
A URL para um serviço REST do SharePoint
Retornos
string
a URL SPWeb deduzida
Comentários
Tenta inferir o URL SPWeb associado ao URL REST fornecido ao procurar componentes de caminho comuns do SharePoint, como "_api", "_layouts" ou "_vit_bin". Isso é necessário para operações como X-RequestDigest e processamento em lotes de ODATA, que exigem POSTing para um ponto de extremidade REST separado para concluir uma solicitação.
Por exemplo, se o requestUrl for "/sites/site/web/_api/service", o URL devolvido será "/sites/site/web". Em alternativa, se o requestUrl for "http://example.com/_layouts/service", o URL devolvido será "http://example.com".
Se não for possível determinar o URL, é emitida uma exceção.
post(url, configuration, options)
Chama fetch(), mas define o método como "POST".
post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;Parâmetros
- url
-
string
o URL a ser buscado
- configuration
- SPHttpClientConfiguration
determina o comportamento padrão de SPHttpClient; normalmente, deve ser o número da versão mais recente de SPHttpClientConfigurations
- options
- ISPHttpClientOptions
opções adicionais que afetam a solicitação
Retornos
Promise<SPHttpClientResponse>
Uma promessa com comportamento semelhante a WHATWG fetch(). Essa promessa será resolvida normalmente (com HttpClientResponse.ok sendo falso) para códigos de status de erro, tais como HTTP 404 ou 500. A promessa só será rejeitada por falhas de rede ou outros erros que impeçam a comunicação com o servidor.