@microsoft/sp-http-base package
Camada de comunicação base para a Estrutura do SharePoint
Classes
| AadHttpClient |
O AadHttpClient é usado para executar chamadas REST em um aplicativo do Azure AD. |
| AadHttpClientConfiguration |
Configuração para HttpClient. |
| AadHttpClientFactory |
Retorna uma versão pré-inicializada do AadHttpClient para uma determinada URL de recurso. Para obter mais informações: https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient |
| AadHttpClientResponse |
A subclasse Response retornada por métodos como |
| AadTokenProvider |
Essa classe permite que um desenvolvedor obtenha tokens OAuth2 do Azure AD. Os tokens OAuth2 são usados para autenticar o usuário da página do SharePoint para outros serviços, como PowerBI, Sway, Exchange, Yammer etc. |
| AadTokenProviderFactory |
Retorna uma versão pré-inicializada do AadTokenProviderFactory. |
| BeforeFullPageRedirectEventArgs |
Argumentos para um evento de redirecionamento de página inteira se a interação for necessária durante o fluxo de logon. |
| BeforeRedirectEventArgs |
Argumentos para antes de redirecionar para uma autenticação de página inteira |
| DigestCache |
IDigestCache é um serviço interno usado pelo SPHttpClient para manter um cache de resumos de solicitação para cada URL do SPWeb. Um resumo de solicitações é um token de segurança que o servidor do SharePoint requer para qualquer operação de gravação REST, especificado por meio do cabeçalho HTTP "X-RequestDigest". Ele é obtido chamando o ponto de extremidade REST "/_api/contextinfo" e expira após um período de tempo configurável do servidor. Para obter mais informações, consulte o artigo do MSDN "Concluir operações básicas usando pontos de extremidade REST do SharePoint 2013" |
| HttpClient |
HttpClient implementa um conjunto básico de recursos para executar operações REST em um 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 do padrão Open Data Protocol. |
| PopupEventArgs |
Argumentos para um evento pop-up se a interação for necessária durante o fluxo de logon. |
| PopupRequestEventArgs |
Argumentos para um evento pop-up se a interação for necessária durante o fluxo de logon. |
| 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 na aquisição de token. |
Interfaces
| IAadHttpClientConfiguration |
Interface de sinalizadores para HttpClientConfiguration. |
| IAadHttpClientConfigurations |
Configurações Standard para AadHttpClient. |
| IAadHttpClientOptions |
Interface para substituir o comportamento padrão do AadHttpClient. |
| IAadTokenProvider |
Essa classe permite que um desenvolvedor obtenha tokens OAuth2 do Azure AD. Os tokens OAuth2 são usados para autenticar o usuário da página do SharePoint para outros serviços, como PowerBI, Sway, Exchange, Yammer etc. |
| IAadTokenProviderConfiguration |
Cadeias de caracteres necessárias para construir um AadTokenProvider. |
| IBeforeRedirectEventArgs |
Representa os argumentos usados antes do evento de redirecionamento. |
| IDigestCache |
IDigestCache é um serviço interno usado pelo SPHttpClient para manter um cache de resumos de solicitação para cada URL do SPWeb. Um resumo de solicitações é um token de segurança que o servidor do SharePoint requer para qualquer operação de gravação REST, especificado por meio do cabeçalho HTTP "X-RequestDigest". Ele é obtido chamando o ponto de extremidade REST "/_api/contextinfo" e expira após um período de tempo configurável do servidor. Para obter mais informações, consulte o artigo do MSDN "Concluir operações básicas usando pontos de extremidade REST do SharePoint 2013" |
| IFetchProvider |
Essa é uma interface ServiceScope que representa o contrato básico da API ES6 Fetch, sem nenhuma lógica adicional do SharePoint. |
| IGetTokenDataOptions | |
| IGetTokenOptions | |
| IHttpClientConfiguration |
Interface de sinalizadores para HttpClientConfiguration. |
| IHttpClientConfigurations |
Configurações Standard para HttpClient. |
| IHttpClientOptions |
Opções para HttpClient |
| IPopupEventArgs |
Representa argumentos usados antes do evento pop-up. |
| ISPHttpClientBatchConfiguration |
Interface de sinalizadores para SPHttpClientBatchConfiguration. |
| ISPHttpClientBatchConfigurations |
Configurações Standard para SPHttpClient. |
| ISPHttpClientBatchCreationOptions |
Essa interface é passada para o construtor SPHttpClientBatch. Ele especifica as opções que afetam todo o lote. |
| ISPHttpClientBatchOptions |
Essa interface define as opções para uma solicitação REST individual que faz parte de um SPHttpClientBatch. Ele se baseia 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 |
Configurações Standard 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 argumentos usados para gerar um evento de falha de aquisição de token. |
Enumerações
| IAuthenticationScheme |
Opções para o esquema de autenticação |
| SPHttpHeader |
Cabeçalhos HTTP Standard usados com SPHttpClient |