SPHttpClientBatch class
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.
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.
Hinweise
Der Konstruktor für diese Klasse ist als intern gekennzeichnet. Drittanbietercode sollte den Konstruktor nicht direkt aufrufen oder Unterklassen erstellen, die die Klasse SPHttpClientBatch erweitern.
Eigenschaften
| configurations | Die standardmäßigen vordefinierten SPHttpClientBatchConfigurations-Objekte für die Verwendung mit der SPHttpClientBatch-Klasse. |
Methoden
| execute() | Führt die Batchabfragen aus, die mit SPHttpClientBatch.fetch() in die Warteschlange gesetzt wurden. |
| fetch(url, configuration, options) | Stellt eine neue Anforderung in die Warteschlange und gibt eine Zusage zurück, die verwendet werden kann, um auf die Serverantwort zuzugreifen (nachdem execute() abgeschlossen wurde). |
| get(url, configuration, options) | Ruft fetch() auf, legt die Methode aber auf 'GET' fest. |
| post(url, configuration, options) | Ruft fetch() auf, legt die Methode aber auf 'POST' fest. |
Details zur Eigenschaft
configurations
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.
Die standardmäßigen vordefinierten SPHttpClientBatchConfigurations-Objekte für die Verwendung mit der SPHttpClientBatch-Klasse.
static readonly configurations: ISPHttpClientBatchConfigurations;Eigenschaftswert
Details zur Methode
execute()
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.
Führt die Batchabfragen aus, die mit SPHttpClientBatch.fetch() in die Warteschlange gesetzt wurden.
execute(): Promise<SPHttpClientBatch>;Gibt zurück
Promise<SPHttpClientBatch>
fetch(url, configuration, options)
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.
Stellt eine neue Anforderung in die Warteschlange und gibt eine Zusage zurück, die verwendet werden kann, um auf die Serverantwort zuzugreifen (nachdem execute() abgeschlossen wurde).
fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Parameter
- url
-
string
Die abzurufende URL
- configuration
- SPHttpClientBatchConfiguration
bestimmt das Standardverhalten dieser Anforderung; dies sollte normalerweise die neueste Versionsnummer von SPHttpClientBatchConfigurations sein.
- options
- ISPHttpClientBatchOptions
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
Die Parameter für diese Funktion sind im Grunde die gleichen wie der hier dokumentierte WHATWG-API-Standard:
https://fetch.spec.whatwg.org/
Beachten Sie jedoch, dass bestimmte REST-Header in einem Batch ignoriert oder nicht zulässig sind. Ausführliche Informationen finden Sie in der ODATA-Dokumentation.
Wenn execute() aufgerufen wird, wird eine POST-Aktion an eine URL wie "http://example.com/sites/sample/_api/$batch" ausgeführt. In der Regel kann SPHttpClientBatch erfolgreich die entsprechende SPWeb-URL erraten, indem nach einem reservierten URL-Segment wie "_api" in der ersten URL gesucht wird, die an fetch() übergeben wird. Ist dies nicht der Fall, verwenden Sie ISPHttpClientBatchCreationOptions.webUrl, um es explizit anzugeben.
get(url, configuration, options)
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.
Ruft fetch() auf, legt die Methode aber auf 'GET' fest.
get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Parameter
- url
-
string
Die abzurufende URL
- configuration
- SPHttpClientBatchConfiguration
bestimmt das Standardverhalten dieser Anforderung; dies sollte normalerweise die neueste Versionsnummer von SPHttpClientBatchConfigurations sein.
- options
- ISPHttpClientBatchOptions
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.
post(url, configuration, options)
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.
Ruft fetch() auf, legt die Methode aber auf 'POST' fest.
post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Parameter
- url
-
string
Die abzurufende URL
- configuration
- SPHttpClientBatchConfiguration
bestimmt das Standardverhalten dieser Anforderung; dies sollte normalerweise die neueste Versionsnummer von SPHttpClientBatchConfigurations sein.
- options
- ISPHttpClientBatchOptions
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.