SPHttpClientBatch class
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.
A classe SPHttpClientBatch acumula uma série de chamadas de serviço REST e as transmite como um único lote ODATA. Este protocolo está documentado aqui: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html
O uso é chamar SPHttpClientBatch.fetch() para enfileirar cada solicitação individual e, em seguida, chamar SPHttpClientBatch.execute() para executar a operação em lote. O método execute() retorna uma promessa que é resolvida quando a chamada REST real tiver sido concluída. Cada chamada para fetch() também retorna uma promessa que será resolvida com um objeto SPHttpClientResponse para essa solicitação específica.
Comentários
O construtor desta classe é marcado como interno. O código de terceiros não deve chamar diretamente o construtor ou criar subclasses que ampliem a classe SPHttpClientBatch.
Propriedades
| configurations | Os objetos padrão predefinidos SPHttpClientBatchConfigurations são objetos para uso com a classe SPHttpClientBatch. |
Métodos
| execute() | Executa as consultas por lotes que foram enfileiradas usando SPHttpClientBatch.fetch(). |
| fetch(url, configuration, options) | Enfileira uma nova solicitação e retorna uma promessa que pode ser usada para acessar a resposta do servidor (após execute() ter sido concluído). |
| get(url, configuration, options) | Chamadas fetch(), mas define o método como 'GET'. |
| post(url, configuration, options) | Chamadas fetch(), mas define o método como 'POST'. |
Detalhes da propriedade
configurations
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.
Os objetos padrão predefinidos SPHttpClientBatchConfigurations são objetos para uso com a classe SPHttpClientBatch.
static readonly configurations: ISPHttpClientBatchConfigurations;Valor da propriedade
Detalhes do método
execute()
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.
Executa as consultas por lotes que foram enfileiradas usando SPHttpClientBatch.fetch().
execute(): Promise<SPHttpClientBatch>;Retornos
Promise<SPHttpClientBatch>
fetch(url, configuration, options)
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.
Enfileira uma nova solicitação e retorna uma promessa que pode ser usada para acessar a resposta do servidor (após execute() ter sido concluído).
fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Parâmetros
- url
-
string
o URL a ser buscado
- configuration
- SPHttpClientBatchConfiguration
determina o comportamento padrão desta solicitação; normalmente, este deve ser o número da versão mais recente da SPHttpClientBatchConfigurations
- options
- ISPHttpClientBatchOptions
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
Os parâmetros para esta função são basicamente os mesmos que o padrão API WHATWG aqui documentada:
https://fetch.spec.whatwg.org/
No entanto, esteja ciente de que determinados cabeçalhos REST são ignorados ou não são permitidos dentro de um lote. Consulte a documentação ODATA para obter detalhes.
Quando execute() for chamado, ele fará um POST em um URL como "http://example.com/sites/sample/_api/$batch". Normalmente, o SPHttpClientBatch consegue adivinhar com êxito o URL SPWeb adequado ao procurar um segmento de URL reservado, como "_api" no primeiro URL transmitido para obter(). Caso contrário, use ISPHttpClientBatchCreationOptions.webUrl para especificá-lo explicitamente.
get(url, configuration, options)
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.
Chamadas fetch(), mas define o método como 'GET'.
get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Parâmetros
- url
-
string
o URL a ser buscado
- configuration
- SPHttpClientBatchConfiguration
determina o comportamento padrão desta solicitação; normalmente, este deve ser o número da versão mais recente da SPHttpClientBatchConfigurations
- options
- ISPHttpClientBatchOptions
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.
post(url, configuration, options)
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.
Chamadas fetch(), mas define o método como 'POST'.
post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Parâmetros
- url
-
string
o URL a ser buscado
- configuration
- SPHttpClientBatchConfiguration
determina o comportamento padrão desta solicitação; normalmente, este deve ser o número da versão mais recente da SPHttpClientBatchConfigurations
- options
- ISPHttpClientBatchOptions
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.