@microsoft/sp-http-base package
Camada de comunicação base para a Estrutura do SharePoint
Classes
AadHttpClient |
O AadHttpClient é utilizado para efetuar chamadas REST numa Aplicação Azure AD. |
AadHttpClientConfiguration |
Configuração para HttpClient. |
AadHttpClientFactory |
Devolve uma versão pré-inicializada do AadHttpClient para um determinado URL de recurso. Para obter mais informações: https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient |
AadHttpClientResponse |
A subclasse Response devolvida por métodos como |
AadTokenProvider |
Esta classe permite que um programador obtenha tokens OAuth2 de Azure AD. Os tokens OAuth2 são utilizados para autenticar o utilizador a partir da página do SharePoint para outros serviços, como o PowerBI, Sway, Exchange, Yammer, etc. |
AadTokenProviderFactory |
Devolve uma versão pré-inicializada do AadTokenProviderFactory. |
BeforeRedirectEventArgs |
Argumentos para antes de redirecionar para uma autenticação de página inteira |
DigestCache |
O IDigestCache é um serviço interno utilizado pelo SPHttpClient para manter uma cache de resumos de pedidos para cada URL SPWeb. Um resumo do pedido é um token de segurança que o servidor do SharePoint necessita para qualquer operação de escrita REST, especificado através do cabeçalho HTTP "X-RequestDigest". É obtido ao chamar o ponto final REST "/_api/contextinfo" e expira após um período de tempo configurável do servidor. Para obter mais informações, veja o artigo do MSDN "Concluir operações básicas com pontos finais REST do SharePoint 2013" |
HttpClient |
O HttpClient implementa um conjunto básico de funcionalidades para realizar operações REST num serviço genérico. |
HttpClientConfiguration |
Configuração para HttpClient. |
HttpClientResponse |
A subclasse Response retornada por métodos como HttpClient.fetch(). |
ODataVersion |
Representa a versão suportada do cabeçalho "OData-Version", que faz parte da norma Open Data Protocol. |
PopupEventArgs |
Argumentos para um evento de pop-up se a interação for necessária durante o fluxo de início de sessão. |
SPHttpClient |
SPHttpClient é usado para realizar chamadas REST em relação ao SharePoint. Ela adiciona cabeçalhos padrão, gerencia o resumo necessário para gravações e coleta a telemetria que ajuda o serviço a monitorar o desempenho de um aplicativo. |
SPHttpClientBatch |
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. |
SPHttpClientBatchConfiguration |
Configuração para SPHttpClientBatch. |
SPHttpClientCommonConfiguration |
A classe base comum para SPHttpClientConfiguration e SPHttpClientBatchConfiguration. |
SPHttpClientConfiguration |
Configuração para SPHttpClient. |
SPHttpClientResponse |
A subclasse Response retornada por métodos como SPHttpClient.fetch(). |
TokenAcquisitionEventArgs |
Argumentos para um evento de falha de aquisição de tokens. |
Interfaces
IAadHttpClientConfiguration |
Interface de sinalizadores para HttpClientConfiguration. |
IAadHttpClientConfigurations |
Standard configurações para AadHttpClient. |
IAadHttpClientOptions |
Interface para substituir o comportamento predefinido de AadHttpClient. |
IAadTokenProvider |
Esta classe permite que um programador obtenha tokens OAuth2 de Azure AD. Os tokens OAuth2 são utilizados para autenticar o utilizador a partir da página do SharePoint para outros serviços, como o PowerBI, Sway, Exchange, Yammer, etc. |
IAadTokenProviderConfiguration |
Cadeias necessárias para construir um AadTokenProvider. |
IBeforeRedirectEventArgs |
Representa os argumentos utilizados antes de redirecionar o evento. |
IDigestCache |
O IDigestCache é um serviço interno utilizado pelo SPHttpClient para manter uma cache de resumos de pedidos para cada URL SPWeb. Um resumo do pedido é um token de segurança que o servidor do SharePoint necessita para qualquer operação de escrita REST, especificado através do cabeçalho HTTP "X-RequestDigest". É obtido ao chamar o ponto final REST "/_api/contextinfo" e expira após um período de tempo configurável do servidor. Para obter mais informações, veja o artigo do MSDN "Concluir operações básicas com pontos finais REST do SharePoint 2013" |
IGetTokenOptions | |
IHttpClientConfiguration |
Interface de sinalizadores para HttpClientConfiguration. |
IHttpClientConfigurations |
Standard configurações para HttpClient. |
IHttpClientOptions |
Opções para HttpClient |
IPopupEventArgs |
Representa os argumentos utilizados antes do evento de pop-up. |
ISPHttpClientBatchConfiguration |
Flags interface for SPHttpClientBatchConfiguration. |
ISPHttpClientBatchConfigurations |
Standard configurações para SPHttpClient. |
ISPHttpClientBatchCreationOptions |
Esta interface é transmitida para o construtor SPHttpClientBatch. Especifica opções que afetam todo o lote. |
ISPHttpClientBatchOptions |
Esta interface define as opções para um pedido REST individual que faz parte de um SPHttpClientBatch. Baseia-se nos parâmetros padrão da API WHATWG documentados aqui: https://fetch.spec.whatwg.org/ |
ISPHttpClientCommonConfiguration |
Sinaliza a interface para SPHttpClientCommonConfiguration |
ISPHttpClientConfiguration |
Interface de sinalizadores para SPHttpClientConfiguration. |
ISPHttpClientConfigurations |
Standard configurações para SPHttpClient. |
ISPHttpClientOptions |
Essa interface define as opções para as operações SPHttpClient como get(), post(), fetch() etc. É baseado nos parâmetros padrão da API WHATWG documentados aqui: https://fetch.spec.whatwg.org/ |
ITokenAcquisitionEventArgs |
Representa os argumentos utilizados para criar um evento de falha de acquisiton de token. |
Enumerações
IAuthenticationScheme |
Opções para o Esquema de Autenticação |
SPHttpHeader |
Standard cabeçalhos HTTP utilizados com SPHttpClient |