Compartir a través de

SPHttpClient class

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

SPHttpClient se usa para realizar llamadas de REST en SharePoint. Agrega encabezados predeterminados, administra la síntesis necesaria para escrituras y recopila telemetría que ayuda al servicio a supervisar el rendimiento de una aplicación.

Comentarios

Esta clase se marca como @sealed. Las subclases no deben ampliarla.

Para comunicarse con otros servicios de Internet, use la clase HttpClient .

Constructores

(constructor)(serviceScope)

Construye una nueva instancia de la SPHttpClient clase

Propiedades

configurations

Objetos SPHttpClientConfiguration predefinidos estándar para su uso con la clase SPHttpClient.
isNavigate
serviceKey

Clave de servicio de SPHttpClient.

Métodos

_fetch(url, configuration, options)
beginBatch(batchCreationOptions)

Empieza un lote de ODATA, lo que permite incluir varias consultas de REST en una solicitud web única.
fetch(url, configuration, options)

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

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

Use una heurística para inferir la dirección URL base para la autenticación.
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 SPHttpClient clase

constructor(serviceScope: ServiceScope);

Parámetros

serviceScope
ServiceScope

Detalles de las propiedades

configurations

Objetos SPHttpClientConfiguration predefinidos estándar para su uso con la clase SPHttpClient.

static readonly configurations: ISPHttpClientConfigurations;

Valor de propiedad

ISPHttpClientConfigurations

isNavigate 

get isNavigate(): boolean;

set isNavigate(isNavigate: boolean);

Valor de propiedad

boolean

serviceKey

Clave de servicio de SPHttpClient.

static readonly serviceKey: ServiceKey<SPHttpClient>;

Valor de propiedad

ServiceKey<SPHttpClient>

Detalles del método

_fetch(url, configuration, options) 

protected _fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;

Parámetros

url

string

configuration
SPHttpClientConfiguration
options
ISPHttpClientOptions

Devoluciones

Promise<SPHttpClientResponse>

beginBatch(batchCreationOptions)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Empieza un lote de ODATA, lo que permite incluir varias consultas de REST en una solicitud web única.

beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;

Parámetros

batchCreationOptions
ISPHttpClientBatchCreationOptions

Devoluciones

SPHttpClientBatch

Objeto SPHttpClientBatch que se usa para administrar la operación por lotes.

fetch(url, configuration, options)

Realice una llamada de servicio REST.

fetch(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;

Parámetros

url

string

la dirección URL que se va a capturar

configuration
SPHttpClientConfiguration

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

options
ISPHttpClientOptions

opciones adicionales que afectan a la solicitud

Devoluciones

Promise<SPHttpClientResponse>

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

Por lo general, los parámetros y la semántica de SPHttpClient.fetch() son básicamente los mismos que el estándar de la API WHATWG que se documenta aquí: https://fetch.spec.whatwg.org/

La subclase SPHttpClient agrega algunos comportamientos adicionales que son cómodos al trabajar con las API de ODATA de SharePoint (que se pueden evitar mediante HttpClient en su lugar):

  • Los encabezados predeterminados "Accept" y "Content-Type" se agregan si no se especifican explícitamente.

  • Para las operaciones de escritura, se agrega automáticamente un encabezado "X-RequestDigest"

  • El token de resumen de solicitud se captura y almacena automáticamente en una memoria caché, con compatibilidad con la precarga

Para una operación de escritura, SPHttpClient agregará automáticamente el encabezado "X-RequestDigest", que puede ser necesario obtener mediante la emisión de una solicitud independiente como "https://example.com/sites/sample/_api/contextinfo". Normalmente, se puede adivinar la dirección URL SPWeb adecuada buscando un segmento de dirección URL reservada, como "_api" en la dirección URL original pasada a fetch(); Si no es así, use ISPHttpClientOptions.webUrl para especificarlo explícitamente.

get(url, configuration, options)

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

get(url: string, configuration: SPHttpClientConfiguration, options?: ISPHttpClientOptions): Promise<SPHttpClientResponse>;

Parámetros

url

string

la dirección URL que se va a capturar

configuration
SPHttpClientConfiguration

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

options
ISPHttpClientOptions

opciones adicionales que afectan a la solicitud

Devoluciones

Promise<SPHttpClientResponse>

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.

getWebUrlFromRequestUrl(requestUrl)

Use una heurística para inferir la dirección URL base para la autenticación.

static getWebUrlFromRequestUrl(requestUrl: string): string;

Parámetros

requestUrl

string

Dirección URL de un servicio REST de SharePoint.

Devoluciones

string

Dirección URL de SPWeb inferida.

Comentarios

Intenta deducir la dirección URL de SPWeb asociada a la dirección URL de REST proporcionada, buscando componentes comunes de la ruta de acceso de SharePoint, como "_api", "_layouts" o "_vit_bin". Esto es necesario para operaciones como el procesamiento por lotes de ODATA y X-RequestDigest, que requieren el uso de POST en un extremo de REST independiente para completar una solicitud.

Por ejemplo, si requestUrl es "/sites/site/web/_api/service", la dirección URL devuelta sería "/sites/site/web". O bien, si requestUrl es "http://example.com/_layouts/service", la dirección URL devuelta sería "http://example.com".

Si no se puede determinar la dirección URL, se produce una excepción.

post(url, configuration, options)

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

post(url: string, configuration: SPHttpClientConfiguration, options: ISPHttpClientOptions): Promise<SPHttpClientResponse>;

Parámetros

url

string

la dirección URL que se va a capturar

configuration
SPHttpClientConfiguration

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

options
ISPHttpClientOptions

opciones adicionales que afectan a la solicitud

Devoluciones

Promise<SPHttpClientResponse>

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.