SPHttpClientBatch class
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.
La clase SPHttpClientBatch acumula varias llamadas al servicio REST y las transmite como un único lote ODATA. Este protocolo se documenta aquí: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html
El uso consiste en llamar a SPHttpClientBatch.fetch() para poner en cola cada solicitud individual y, a continuación, llamar a SPHttpClientBatch.execute() para ejecutar la operación por lotes. El método execute() devuelve una promesa que se resuelve cuando se ha completado la llamada REST real. Cada llamada a fetch() también devuelve una promesa que se resolverá con un objeto SPHttpClientResponse para esa solicitud en particular.
Comentarios
El constructor de esta clase está marcado como interno. El código de terceros no debe llamar directamente al constructor ni crear subclases que extiendan la clase SPHttpClientBatch.
Propiedades
| configurations | Los objetos SPHttpClientBatchConfigurations predefinidos estándar para su uso con la clase SPHttpClientBatch. |
Métodos
| execute() | Ejecuta las consultas por lotes que estaban en cola mediante SPHttpClientBatch.fetch(). |
| fetch(url, configuration, options) | Pone en cola una nueva solicitud y devuelve una promesa que se puede usar para acceder a la respuesta del servidor (después de que se haya completado execute()). |
| 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 de las propiedades
configurations
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.
Los objetos SPHttpClientBatchConfigurations predefinidos estándar para su uso con la clase SPHttpClientBatch.
static readonly configurations: ISPHttpClientBatchConfigurations;Valor de propiedad
Detalles del método
execute()
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.
Ejecuta las consultas por lotes que estaban en cola mediante SPHttpClientBatch.fetch().
execute(): Promise<SPHttpClientBatch>;Devoluciones
Promise<SPHttpClientBatch>
fetch(url, configuration, options)
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.
Pone en cola una nueva solicitud y devuelve una promesa que se puede usar para acceder a la respuesta del servidor (después de que se haya completado execute()).
fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Parámetros
- url
-
string
la dirección URL que se va a capturar
- configuration
- SPHttpClientBatchConfiguration
determina el comportamiento predeterminado de esta solicitud. Normalmente debería ser el número de versión más reciente de SPHttpClientConfigurations
- options
- ISPHttpClientBatchOptions
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
Los parámetros de esta función son básicamente los mismos que el estándar de la API WHATWG, que se documenta aquí:
https://fetch.spec.whatwg.org/
Sin embargo, tenga en cuenta que determinados encabezados REST se omiten o no se permiten dentro de un lote. Consulte la documentación de ODATA para obtener más información.
Cuando se llama a execute(), se enviará POST a una dirección URL como "http://example.com/sites/sample/_api/$batch". Normalmente, SPHttpClientBatch puede adivinar correctamente la dirección URL de SPWeb adecuada buscando un segmento de dirección URL reservada como "_api" en la primera dirección URL pasada a fetch(). Si no es así, use ISPHttpClientBatchCreationOptions.webUrl para especificarlo de forma explícita.
get(url, configuration, options)
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.
Llama a fetch(), pero establece el método en "GET".
get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Parámetros
- url
-
string
la dirección URL que se va a capturar
- configuration
- SPHttpClientBatchConfiguration
determina el comportamiento predeterminado de esta solicitud. Normalmente debería ser el número de versión más reciente de SPHttpClientConfigurations
- options
- ISPHttpClientBatchOptions
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.
post(url, configuration, options)
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.
Llama a fetch(), pero establece el método en "POST".
post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Parámetros
- url
-
string
la dirección URL que se va a capturar
- configuration
- SPHttpClientBatchConfiguration
determina el comportamiento predeterminado de esta solicitud. Normalmente debería ser el número de versión más reciente de SPHttpClientConfigurations
- options
- ISPHttpClientBatchOptions
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.