Freigeben über


@microsoft/sp-http-base package

Basiskommunikationsebene für das SharePoint-Framework

Klassen

AadHttpClient

AadHttpClient wird verwendet, um REST-Aufrufe für eine Azure AD-Anwendung auszuführen.

AadHttpClientConfiguration

Konfiguration für HttpClient.

AadHttpClientFactory

Gibt eine vorab initialisierte Version von AadHttpClient für eine angegebene Ressourcen-URL zurück. Weitere Informationen: https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aadhttpclient

AadHttpClientResponse

Die Response-Unterklasse, die von Methoden wie AadHttpClient.fetch()zurückgegeben wird. Klasse, die HttpClientResponse erweitert, um zusätzliche Funktionen speziell für den AadHttpClient hinzuzufügen.

AadTokenProvider

Diese Klasse ermöglicht es einem Entwickler, OAuth2-Token von Azure AD abzurufen.

OAuth2-Token werden verwendet, um den Benutzer von der SharePoint-Seite bei anderen Diensten wie PowerBI, Sway, Exchange, Yammer usw. zu authentifizieren.

AadTokenProviderFactory

Gibt eine vorab initialisierte Version von AadTokenProviderFactory zurück.

BeforeRedirectEventArgs

Argumente für vor der Umleitung für eine ganzseitige Authentifizierung

DigestCache

IDigestCache ist ein interner Dienst, der von SPHttpClient verwendet wird, um einen Cache mit Anforderungsdigests für jede SPWeb-URL zu verwalten. Ein Anforderungsdigest ist ein Sicherheitstoken, das der SharePoint-Server für jeden REST-Schreibvorgang benötigt, der über den HTTP-Header "X-RequestDigest" angegeben wird. Sie wird durch Aufrufen des REST-Endpunkts "/_api/contextinfo" abgerufen und läuft nach einer vom Server konfigurierbaren Zeitspanne ab.

Weitere Informationen finden Sie im MSDN-Artikel "Abschließen grundlegender Vorgänge mit SharePoint 2013-REST-Endpunkten".

HttpClient

HttpClient implementiert einen grundlegenden Satz von Features zum Ausführen von REST-Vorgängen für einen generischen Dienst.

HttpClientConfiguration

Konfiguration für HttpClient.

HttpClientResponse

Die Response-Unterklasse, die von Methoden wie HttpClient.fetch() zurückgegeben wird.

ODataVersion

Stellt die unterstützte Version des OData-Version-Headers dar, der Teil des Open Data Protocol-Standards ist.

PopupEventArgs

Argumente für ein Popupereignis, wenn während des Anmeldeflows eine Interaktion erforderlich ist.

SPHttpClient

SPHttpClient wird zum Durchführen von REST-Aufrufen für SharePoint verwendet. Es fügt Standardkopfzeilen hinzu, verwaltet den für Schreibvorgänge erforderlichen Digest und sammelt Telemetrie, die dem Dienst hilft, die Leistung einer Anwendung zu überwachen.

SPHttpClientBatch

Die SPHttpClientBatch-Klasse sammelt eine Reihe von REST-Dienstaufrufen und überträgt sie als einzelnen ODATA-Batch. Dieses Protokoll ist hier dokumentiert: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html.

Die Verwendung besteht darin, SPHttpClientBatch.fetch() aufzurufen, um jede einzelne Anforderung in die Warteschlange zu stellen, und dann SPHttpClientBatch.execute() aufzurufen, um den Batchvorgang auszuführen. Die execute()-Methode gibt eine Zusage zurück, die aufgelöst wird, wenn der eigentliche REST-Aufruf abgeschlossen wurde. Jeder Aufruf von fetch() gibt auch eine Zusage zurück, die mit einem SPHttpClientResponse-Objekt für diese bestimmte Anforderung aufgelöst wird.

SPHttpClientBatchConfiguration

Konfiguration für SPHttpClientBatch.

SPHttpClientCommonConfiguration

Allgemeine Basisklasse für SPHttpClientConfiguration und SPHttpClientBatchConfiguration.

SPHttpClientConfiguration

Konfiguration für SPHttpClient.

SPHttpClientResponse

Die Response-Unterklasse, die von Methoden, wie z. B. SPHttpClient.fetch(), zurückgegeben wird.

TokenAcquisitionEventArgs

Argumente für ein Tokenabruffehlerereignis.

Schnittstellen

IAadHttpClientConfiguration

Flags-Schnittstelle für HttpClientConfiguration.

IAadHttpClientConfigurations

Standard Konfigurationen für AadHttpClient.

IAadHttpClientOptions

Schnittstelle zum Überschreiben des Standardverhaltens von AadHttpClient.

IAadTokenProvider

Diese Klasse ermöglicht es einem Entwickler, OAuth2-Token von Azure AD abzurufen.

OAuth2-Token werden verwendet, um den Benutzer von der SharePoint-Seite bei anderen Diensten wie PowerBI, Sway, Exchange, Yammer usw. zu authentifizieren.

IAadTokenProviderConfiguration

Erforderliche Zeichenfolgen zum Erstellen eines AadTokenProviders.

IBeforeRedirectEventArgs

Stellt Argumente dar, die vor dem Umleiten des Ereignisses verwendet werden.

IDigestCache

IDigestCache ist ein interner Dienst, der von SPHttpClient verwendet wird, um einen Cache mit Anforderungsdigests für jede SPWeb-URL zu verwalten. Ein Anforderungsdigest ist ein Sicherheitstoken, das der SharePoint-Server für jeden REST-Schreibvorgang benötigt, der über den HTTP-Header "X-RequestDigest" angegeben wird. Sie wird durch Aufrufen des REST-Endpunkts "/_api/contextinfo" abgerufen und läuft nach einer vom Server konfigurierbaren Zeitspanne ab.

Weitere Informationen finden Sie im MSDN-Artikel "Abschließen grundlegender Vorgänge mit SharePoint 2013-REST-Endpunkten".

IGetTokenOptions
IHttpClientConfiguration

Flags-Schnittstelle für HttpClientConfiguration.

IHttpClientConfigurations

Standard Konfigurationen für HttpClient.

IHttpClientOptions

Optionen für HttpClient

IPopupEventArgs

Stellt Argumente dar, die vor dem Popupereignis verwendet werden.

ISPHttpClientBatchConfiguration

Flags-Schnittstelle für SPHttpClientBatchConfiguration.

ISPHttpClientBatchConfigurations

Standard Konfigurationen für SPHttpClient.

ISPHttpClientBatchCreationOptions

Diese Schnittstelle wird an den SPHttpClientBatch-Konstruktor übergeben. Sie gibt Optionen an, die sich auf den gesamten Batch auswirken.

ISPHttpClientBatchOptions

Diese Schnittstelle definiert die Optionen für eine einzelne REST-Anforderung, die Teil eines SPHttpClientBatch ist. Sie basiert auf den WHATWG-API-Standardparametern, die hier dokumentiert sind: https://fetch.spec.whatwg.org/

ISPHttpClientCommonConfiguration

Flags-Schnittstelle für SPHttpClientCommonConfiguration.

ISPHttpClientConfiguration

Flags-Schnittstelle für SPHttpClientConfiguration.

ISPHttpClientConfigurations

Standard Konfigurationen für SPHttpClient.

ISPHttpClientOptions

Diese Schnittstelle definiert die Optionen für die SPHttpClient-Vorgänge, z. B. get(), post(), fetch() usw. Sie basiert auf den WHATWG-API-Standardparametern, die hier beschriebenen werden: https://fetch.spec.whatwg.org/

ITokenAcquisitionEventArgs

Stellt Argumente dar, die zum Auslösen eines Token-Acquisiton-Fehlerereignisses verwendet werden.

Enumerationen

IAuthenticationScheme

Optionen für das Authentifizierungsschema

SPHttpHeader

Standard http-Header, die mit SPHttpClient verwendet werden