HttpClient class
O HttpClient implementa um conjunto básico de funcionalidades para realizar operações REST num serviço genérico.
Comentários
Para comunicar com o SharePoint, utilize a classe SPHttpClient .
Construtores
| (constructor)(service |
Constrói uma nova instância da |
Propriedades
| configurations | Os objetos HttpClientConfiguration predefinidos padrão para utilização com a classe HttpClient. |
| service |
A chave de serviço para HttpClient. |
Métodos
| fetch(url, configuration, options) | Executa uma chamada de serviço de REST. |
| get(url, configuration, options) | Chama fetch(), mas define o método como "GET". |
| 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 HttpClient classe
constructor(serviceScope: ServiceScope);Parâmetros
- serviceScope
- ServiceScope
Detalhes da propriedade
configurations
Os objetos HttpClientConfiguration predefinidos padrão para utilização com a classe HttpClient.
static readonly configurations: IHttpClientConfigurations;Valor da propriedade
serviceKey
A chave de serviço para HttpClient.
static readonly serviceKey: ServiceKey<HttpClient>;Valor da propriedade
Detalhes do método
fetch(url, configuration, options)
Executa uma chamada de serviço de REST.
fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Parâmetros
- url
-
string
o URL a ser buscado
- configuration
- HttpClientConfiguration
determina o comportamento padrão de HttpClient; normalmente, deve ser o número da versão mais recente de HttpClientConfigurations
- options
- IHttpClientOptions
opções adicionais que afetam a solicitação
Retornos
Promise<HttpClientResponse>
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
Embora a subclasse SPHttpClient adicione aprimoramentos adicionais, os parâmetros e a semântica para HttpClient.fetch() são essencialmente os mesmos que o padrão da API WHATWG documentados aqui: https://fetch.spec.whatwg.org/
get(url, configuration, options)
Chama fetch(), mas define o método como "GET".
get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;Parâmetros
- url
-
string
o URL a ser buscado
- configuration
- HttpClientConfiguration
determina o comportamento padrão de HttpClient; normalmente, deve ser o número da versão mais recente de HttpClientConfigurations
- options
- IHttpClientOptions
opções adicionais que afetam a solicitação
Retornos
Promise<HttpClientResponse>
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.
post(url, configuration, options)
Chama fetch(), mas define o método como "POST".
post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;Parâmetros
- url
-
string
o URL a ser buscado
- configuration
- HttpClientConfiguration
determina o comportamento padrão de HttpClient; normalmente, deve ser o número da versão mais recente de HttpClientConfigurations
- options
- IHttpClientOptions
opções adicionais que afetam a solicitação
Retornos
Promise<HttpClientResponse>
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.