Compartir a través de

HttpClient class

  • Referencia
Paquete:
@microsoft/sp-http-base

HttpClient implementa un conjunto básico de características para realizar operaciones REST en un servicio genérico.

Comentarios

Para comunicarse con SharePoint, use la clase SPHttpClient en su lugar.

Constructores

(constructor)(serviceScope)

Construye una nueva instancia de la HttpClient clase

Propiedades

configurations

Objetos HttpClientConfiguration predefinidos estándar para su uso con la clase HttpClient.
serviceKey

Clave de servicio de HttpClient.

Métodos

fetch(url, configuration, options)

Realiza una llamada de servicio REST.
get(url, configuration, options)

Llama a fetch(), pero establece el método en "GET".
post(url, configuration, options)

Llama a fetch(), pero establece el método en "POST".

Detalles del constructor

(constructor)(serviceScope)

Construye una nueva instancia de la HttpClient clase

constructor(serviceScope: ServiceScope);

Parámetros

serviceScope
ServiceScope

Detalles de las propiedades

configurations

Objetos HttpClientConfiguration predefinidos estándar para su uso con la clase HttpClient.

static readonly configurations: IHttpClientConfigurations;

Valor de propiedad

IHttpClientConfigurations

serviceKey

Clave de servicio de HttpClient.

static readonly serviceKey: ServiceKey<HttpClient>;

Valor de propiedad

ServiceKey<HttpClient>

Detalles del método

fetch(url, configuration, options)

Realiza una llamada de servicio REST.

fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;

Parámetros

url

string

la dirección URL que se va a capturar

configuration
HttpClientConfiguration

Determina el comportamiento predeterminado de HttpClient. Normalmente debería ser el número de versión más reciente de HttpClientConfigurations.

options
IHttpClientOptions

opciones adicionales que afectan a la solicitud

Devoluciones

Promise<HttpClientResponse>

Una promesa con un comportamiento similar al de WHATWG fetch(). Esta promesa se resolverá normalmente (con HttpClientResponse.ok siendo false) para códigos de estado de error como HTTP 404 o 500. La promesa solo rechazará los errores de red u otros errores que impidan la comunicación con el servidor.

Comentarios

Aunque la subclase SPHttpClient agrega mejoras adicionales, los parámetros y la semántica de HttpClient.fetch() es básicamente igual que el estándar de API de WHATWG que se menciona aquí: https://fetch.spec.whatwg.org/

get(url, configuration, options)

Llama a fetch(), pero establece el método en "GET".

get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;

Parámetros

url

string

la dirección URL que se va a capturar

configuration
HttpClientConfiguration

Determina el comportamiento predeterminado de HttpClient. Normalmente debería ser el número de versión más reciente de HttpClientConfigurations.

options
IHttpClientOptions

opciones adicionales que afectan a la solicitud

Devoluciones

Promise<HttpClientResponse>

Una promesa con un comportamiento similar al de WHATWG fetch(). Esta promesa se resolverá normalmente (con HttpClientResponse.ok siendo false) para códigos de estado de error como HTTP 404 o 500. La promesa solo rechazará los errores de red u otros errores que impidan la comunicación con el servidor.

post(url, configuration, options)

Llama a fetch(), pero establece el método en "POST".

post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;

Parámetros

url

string

la dirección URL que se va a capturar

configuration
HttpClientConfiguration

Determina el comportamiento predeterminado de HttpClient. Normalmente debería ser el número de versión más reciente de HttpClientConfigurations.

options
IHttpClientOptions

opciones adicionales que afectan a la solicitud

Devoluciones

Promise<HttpClientResponse>

Una promesa con un comportamiento similar al de WHATWG fetch(). Esta promesa se resolverá normalmente (con HttpClientResponse.ok siendo false) para códigos de estado de error como HTTP 404 o 500. La promesa solo rechazará los errores de red u otros errores que impidan la comunicación con el servidor.