HttpClient class
HttpClient implementiert einen grundlegenden Satz von Features zum Ausführen von REST-Vorgängen für einen generischen Dienst.
Hinweise
Verwenden Sie für die Kommunikation mit SharePoint stattdessen die SPHttpClient-Klasse .
Konstruktoren
(constructor)(service |
Erstellt eine neue instance der |
Eigenschaften
configurations | Die standardmäßigen vordefinierten HttpClientConfiguration-Objekte für die Verwendung mit der HttpClient-Klasse. |
service |
Der Diensschlüssel für HttpClient. |
Methoden
fetch(url, configuration, options) | Führt einen REST-Dienstanruf aus. |
get(url, configuration, options) | Ruft fetch() auf, legt die Methode jedoch auf "GET" fest. |
post(url, configuration, options) | Ruft fetch() auf, legt aber die Methode auf "POST" fest. |
Details zum Konstruktor
(constructor)(serviceScope)
Erstellt eine neue instance der HttpClient
-Klasse
constructor(serviceScope: ServiceScope);
Parameter
- serviceScope
- ServiceScope
Details zur Eigenschaft
configurations
Die standardmäßigen vordefinierten HttpClientConfiguration-Objekte für die Verwendung mit der HttpClient-Klasse.
static readonly configurations: IHttpClientConfigurations;
Eigenschaftswert
serviceKey
Der Diensschlüssel für HttpClient.
static readonly serviceKey: ServiceKey<HttpClient>;
Eigenschaftswert
Details zur Methode
fetch(url, configuration, options)
Führt einen REST-Dienstanruf aus.
fetch(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;
Parameter
- url
-
string
Die abzurufende URL
- configuration
- HttpClientConfiguration
Bestimmt das Standardverhalten von HttpClient; dies sollte normalerweise die neueste Versionsnummer von HttpClientConfigurations sein.
- options
- IHttpClientOptions
Zusätzliche Optionen, die Auswirkungen auf die Anforderung haben
Gibt zurück
Promise<HttpClientResponse>
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
Obwohl die SPHttpClient-Unterklasse Verbesserungen hinzufügt, sind die Parameter und die Semantik für HttpClient.fetch() im Wesentlichen identisch mit dem WHATWG-API-Standard, der hier dokumentiert wird: https://fetch.spec.whatwg.org/
get(url, configuration, options)
Ruft fetch() auf, legt die Methode jedoch auf "GET" fest.
get(url: string, configuration: HttpClientConfiguration, options?: IHttpClientOptions): Promise<HttpClientResponse>;
Parameter
- url
-
string
Die abzurufende URL
- configuration
- HttpClientConfiguration
Bestimmt das Standardverhalten von HttpClient; dies sollte normalerweise die neueste Versionsnummer von HttpClientConfigurations sein.
- options
- IHttpClientOptions
Zusätzliche Optionen, die Auswirkungen auf die Anforderung haben
Gibt zurück
Promise<HttpClientResponse>
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.
post(url, configuration, options)
Ruft fetch() auf, legt aber die Methode auf "POST" fest.
post(url: string, configuration: HttpClientConfiguration, options: IHttpClientOptions): Promise<HttpClientResponse>;
Parameter
- url
-
string
Die abzurufende URL
- configuration
- HttpClientConfiguration
Bestimmt das Standardverhalten von HttpClient; dies sollte normalerweise die neueste Versionsnummer von HttpClientConfigurations sein.
- options
- IHttpClientOptions
Zusätzliche Optionen, die Auswirkungen auf die Anforderung haben
Gibt zurück
Promise<HttpClientResponse>
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.