SPHttpClient class

Paket:

@microsoft/sp-http-base

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.

Hinweise

Diese Klasse ist als @sealedgekennzeichnet. Unterklassen sollten sie nicht erweitern.

Verwenden Sie für die Kommunikation mit anderen Internetdiensten die HttpClient-Klasse .

Konstruktoren

(constructor)(serviceScope)

Erstellt eine neue instance der SPHttpClient -Klasse

Eigenschaften

configurations	Die standardmäßigen vordefinierten SPHttpClientConfiguration-Objekte für die Verwendung mit der SPHttpClient-Klasse.
isNavigate
serviceKey	Der Diensschlüssel für SPHttpClient.

Methoden

_fetch(url, configuration, options)
beginBatch(batchCreationOptions)	Beginnt einen ODATA-Batch, der mehrere REST-Abfragen in einer einzigen Web-Anforderung gebündelt zulässt.
fetch(url, configuration, options)	Führen Sie einen REST-Dienstaufruf aus.
get(url, configuration, options)	Ruft fetch() auf, legt die Methode jedoch auf "GET" fest.
getWebUrlFromRequestUrl(requestUrl)	Verwenden Sie eine Heuristik, um die Basis-URL für die Authentifizierung abzuleiten.
post(url, configuration, options)	Ruft fetch() auf, legt aber die Methode auf "POST" fest.

Details zum Konstruktor

(constructor)(serviceScope)

Erstellt eine neue instance der SPHttpClient -Klasse

constructor(serviceScope: ServiceScope);

Parameter

serviceScope

ServiceScope

Details zur Eigenschaft

configurations

Die standardmäßigen vordefinierten SPHttpClientConfiguration-Objekte für die Verwendung mit der SPHttpClient-Klasse.

static readonly configurations: ISPHttpClientConfigurations;

Eigenschaftswert

ISPHttpClientConfigurations

isNavigate

get isNavigate(): boolean;

set isNavigate(isNavigate: boolean);

Eigenschaftswert

boolean

serviceKey

Der Diensschlüssel für SPHttpClient.

static readonly serviceKey: ServiceKey<SPHttpClient>;

Eigenschaftswert

ServiceKey<SPHttpClient>

Details zur Methode

_fetch(url, configuration, options)

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

Parameter

url

string

configuration

SPHttpClientConfiguration

options

ISPHttpClientOptions

Gibt zurück

Promise<SPHttpClientResponse>

beginBatch(batchCreationOptions)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Beginnt einen ODATA-Batch, der mehrere REST-Abfragen in einer einzigen Web-Anforderung gebündelt zulässt.

beginBatch(batchCreationOptions?: ISPHttpClientBatchCreationOptions): SPHttpClientBatch;

Parameter

batchCreationOptions

ISPHttpClientBatchCreationOptions

Gibt zurück

SPHttpClientBatch

Ein SPHttpClientBatch-Objekt , das zum Verwalten des Batchvorgangs verwendet wird.

fetch(url, configuration, options)

Führen Sie einen REST-Dienstaufruf aus.

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

Parameter

url

string

Die abzurufende URL

configuration

SPHttpClientConfiguration

Bestimmt das Standardverhalten von SPHttpClient; dies sollte normalerweise die neueste Versionsnummer von SPHttpClientConfigurations sein.

options

ISPHttpClientOptions

Zusätzliche Optionen, die Auswirkungen auf die Anforderung haben

Gibt zurück

Promise<SPHttpClientResponse>

Eine Zusage mit ähnlichem Verhalten wie WHATWG fetch(). Diese Zusage wird bei Fehlerstatuscodes wie HTTP 404 oder 500 normal aufgelöst (mit HttpClientResponse.ok als "false"). Die Zusage wird nur bei Netzwerkfehlern oder anderen Fehlern abgelehnt, die die Kommunikation mit dem Server verhindern.

Hinweise

Im Allgemeinen sind die Parameter und die Semantik für SPHttpClient.fetch() im Wesentlichen identisch mit dem WHATWG-API-Standard, der hier dokumentiert ist: https://fetch.spec.whatwg.org/

Die SPHttpClient-Unterklasse fügt einige zusätzliche Verhaltensweisen hinzu, die bei der Arbeit mit SharePoint ODATA-APIs praktisch sind (was stattdessen durch Verwendung von HttpClient vermieden werden kann):

• Die Standardheader "Accept" und "Content-Type" werden hinzugefügt, wenn sie nicht explizit angegeben sind.

• Für Schreibvorgänge wird automatisch ein "X-RequestDigest"-Header hinzugefügt.

• Das Anforderungsdigesttoken wird automatisch abgerufen und in einem Cache gespeichert, wobei das Vorabladen unterstützt wird.

Für einen Schreibvorgang fügt SPHttpClient automatisch den Header "X-RequestDigest" hinzu, der möglicherweise durch Ausgeben einer separaten Anforderung wie "https://example.com/sites/sample/_api/contextinfo"" abgerufen werden muss. In der Regel kann die entsprechende SPWeb-URL erraten werden, indem sie nach einem reservierten URL-Segment wie "_api" in der ursprünglichen URL suchen, die an fetch() übergeben wird. Wenn nicht, verwenden Sie ISPHttpClientOptions.webUrl, um dies explizit anzugeben.

get(url, configuration, options)

Ruft fetch() auf, legt die Methode jedoch auf "GET" fest.

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

Parameter

url

string

Die abzurufende URL

configuration

SPHttpClientConfiguration

Bestimmt das Standardverhalten von SPHttpClient; dies sollte normalerweise die neueste Versionsnummer von SPHttpClientConfigurations sein.

options

ISPHttpClientOptions

Zusätzliche Optionen, die Auswirkungen auf die Anforderung haben

Gibt zurück

Promise<SPHttpClientResponse>

Eine Zusage mit ähnlichem Verhalten wie WHATWG fetch(). Diese Zusage wird bei Fehlerstatuscodes wie HTTP 404 oder 500 normal aufgelöst (mit HttpClientResponse.ok als "false"). Die Zusage wird nur bei Netzwerkfehlern oder anderen Fehlern abgelehnt, die die Kommunikation mit dem Server verhindern.

getWebUrlFromRequestUrl(requestUrl)

Verwenden Sie eine Heuristik, um die Basis-URL für die Authentifizierung abzuleiten.

static getWebUrlFromRequestUrl(requestUrl: string): string;

Parameter

requestUrl

string

Die URL für einen SharePoint REST-Dienst

Gibt zurück

string

die abgeleitete SPWeb-URL

Hinweise

Versucht, die SPWeb-URL abzuleiten, die der bereitgestellten REST-URL zugeordnet ist, indem nach allgemeinen SharePoint-Pfadkomponenten wie "_api", "_layouts" oder "_vit_bin" gesucht wird. Dies ist für Vorgänge wie die X-RequestDigest- und ODATA-Batchverarbeitung erforderlich, die posting an einen separaten REST-Endpunkt erfordern, um eine Anforderung abzuschließen.

Wenn die requestUrl beispielsweise "/sites/site/web/_api/service" lautet, lautet die zurückgegebene URL "/sites/site/web". Wenn die requestUrl "http://example.com/_layouts/service"" lautet, lautet die zurückgegebene URL "http://example.com"".

Wenn die URL nicht bestimmt werden kann, wird eine Ausnahme ausgelöst.

post(url, configuration, options)

Ruft fetch() auf, legt aber die Methode auf "POST" fest.

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

Parameter

url

string

Die abzurufende URL

configuration

SPHttpClientConfiguration

Bestimmt das Standardverhalten von SPHttpClient; dies sollte normalerweise die neueste Versionsnummer von SPHttpClientConfigurations sein.

options

ISPHttpClientOptions

Zusätzliche Optionen, die Auswirkungen auf die Anforderung haben

Gibt zurück

Promise<SPHttpClientResponse>

Eine Zusage mit ähnlichem Verhalten wie WHATWG fetch(). Diese Zusage wird bei Fehlerstatuscodes wie HTTP 404 oder 500 normal aufgelöst (mit HttpClientResponse.ok als "false"). Die Zusage wird nur bei Netzwerkfehlern oder anderen Fehlern abgelehnt, die die Kommunikation mit dem Server verhindern.