SPHttpClient class

Constrói uma nova instância da SPHttpClient classe

constructor(serviceScope: ServiceScope);

Parâmetros

Os objetos SPHttpClientConfiguration predefinidos padrão para uso com a classe SPHttpClient.

static readonly configurations: ISPHttpClientConfigurations;

Valor da propriedade

get isNavigate(): boolean;

set isNavigate(isNavigate: boolean);

Valor da propriedade

readonly onBeforeRedirectEvent: SPEvent<BeforeFullPageRedirectEventArgs>;

Valor da propriedade

readonly onPopupRequestedEvent: SPEvent<PopupRequestEventArgs>;

Valor da propriedade

A chave de serviço para SPHttpClient.

static readonly serviceKey: ServiceKey<SPHttpClient>;

Valor da propriedade

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

Parâmetros

Retornos

Inicia um lote ODATA, que permite que várias consultas REST sejam agrupadas em uma solicitação única da Web.

beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;

Parâmetros

Retornos

Um objeto SPHttpClientBatch usado para gerenciar a operação em lote.

Execute uma chamada de serviço REST.

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

Parâmetros

Retornos

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

Geralmente, os parâmetros e a semântica de SPHttpClient.fetch() são essencialmente os mesmos que o padrão de API WHATWG documentado aqui: https://fetch.spec.whatwg.org/

A subclasse SPHttpClient adiciona alguns comportamentos adicionais que são convenientes ao trabalhar com APIs ODATA do SharePoint (que podem ser evitados usando HttpClient em vez disso):

• Os cabeçalhos padrão "Accept" e "Content-Type" serão adicionados se não forem especificados explicitamente.

• Para operações de gravação, um cabeçalho "X-RequestDigest" é adicionado automaticamente

• O token de resumo de solicitação é buscado e armazenado automaticamente em um cache, com suporte para pré-carregamento

Para uma operação de gravação, o SPHttpClient adicionará automaticamente o cabeçalho "X-RequestDigest", que pode precisar ser obtido emitindo uma solicitação separada, como "https://example.com/sites/sample/_api/contextinfo". Normalmente, a URL SPWeb apropriada pode ser adivinhada procurando um segmento de URL reservado como "_api" na URL original passado para fetch(); caso contrário, use ISPHttpClientOptions.webUrl para especificá-la explicitamente.

Chama fetch(), mas define o método como "GET".

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

Parâmetros

Retornos

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.

Use uma heurística para inferir a URL base para autenticação.

static getWebUrlFromRequestUrl(requestUrl: string): string;

Parâmetros

Retornos

a URL SPWeb deduzida

Comentários

Tentativas de inferir a URL do SPWeb associada à URL REST fornecida, procurando componentes comuns de caminho do SharePoint, como "_api", "_layouts" ou "_vit_bin". Isso é necessário para operações como X-RequestDigest e processamento em lotes de ODATA, que exigem POSTing para um ponto de extremidade REST separado para concluir uma solicitação.

Por exemplo, se o requestUrl for "/sites/site/web/_api/service", a URL retornada será "/sites/site/web". Ou se o requestUrl for "http://example.com/_layouts/service", a URL retornada será "http://example.com".

Se a URL não puder ser determinada, uma exceção será lançada.

Chama fetch(), mas define o método como "POST".

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

Parâmetros

Retornos

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.