SPHttpClientBatch class
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
La classe SPHttpClientBatch accumule un certain nombre d’appels de service REST et les transmet sous la forme d’un seul lot ODATA. Ce protocole est documenté ici : http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html
L’utilisation consiste à appeler SPHttpClientBatch.fetch() pour mettre en file d’attente chaque requête individuelle, puis à appeler SPHttpClientBatch.execute() pour exécuter l’opération de traitement par lots. La méthode execute() retourne une promesse qui se résout lorsque l’appel REST réel est terminé. Chaque appel à fetch() retourne également une promesse qui sera résolue avec un objet SPHttpClientResponse pour cette requête particulière.
Remarques
Le constructeur de cette classe est marqué comme interne. Le code tiers ne doit pas appeler directement le constructeur ou créer des sous-classes qui étendent la SPHttpClientBatch classe.
Propriétés
| configurations | Objets SPHttpClientBatchConfigurations prédéfinis standard à utiliser avec la classe SPHttpClientBatch. |
Méthodes
| execute() | Exécute les requêtes par lot qui étaient mises en file d’attente à l’aide de SPHttpClientBatch.fetch(). |
| fetch(url, configuration, options) | Files d’attente une nouvelle requête et retourne une promesse qui peut être utilisée pour accéder à la réponse du serveur (une fois execute() terminé). |
| get(url, configuration, options) | Appelle fetch(), mais définit la méthode sur « GET ». |
| post(url, configuration, options) | Appelle fetch(), mais définit la méthode sur « POST ». |
Détails de la propriété
configurations
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Objets SPHttpClientBatchConfigurations prédéfinis standard à utiliser avec la classe SPHttpClientBatch.
static readonly configurations: ISPHttpClientBatchConfigurations;Valeur de propriété
Détails de la méthode
execute()
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Exécute les requêtes par lot qui étaient mises en file d’attente à l’aide de SPHttpClientBatch.fetch().
execute(): Promise<SPHttpClientBatch>;Retours
Promise<SPHttpClientBatch>
fetch(url, configuration, options)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Files d’attente une nouvelle requête et retourne une promesse qui peut être utilisée pour accéder à la réponse du serveur (une fois execute() terminé).
fetch(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Paramètres
- url
-
string
URL à récupérer
- configuration
- SPHttpClientBatchConfiguration
détermine le comportement par défaut de cette requête ; normalement, il doit s’agir du numéro de version le plus récent de SPHttpClientBatchConfigurations
- options
- ISPHttpClientBatchOptions
_ Options supplémentaires qui affectent la demande
Retours
Promise<SPHttpClientResponse>
Promesse avec un comportement similaire à WHATWG fetch(). Cette promesse se résout normalement (httpClientResponse.ok étant false) pour les codes d’erreur status tels que HTTP 404 ou 500. La promesse est rejetée uniquement pour les défaillances réseau ou d’autres erreurs qui empêchent la communication avec le serveur.
Remarques
Les paramètres de cette fonction sont essentiellement les mêmes que la norme d’API WHATWG documentée ici :
https://fetch.spec.whatwg.org/
Toutefois, n’oubliez pas que certains en-têtes REST sont ignorés ou non autorisés à l’intérieur d’un lot. Pour plus d’informations, consultez la documentation ODATA.
Quand execute() est appelé, il est post vers une URL telle que «http://example.com/sites/sample/_api/ $batch ». En règle générale, SPHttpClientBatch peut deviner l’URL SPWeb appropriée en recherchant un segment d’URL réservé tel que « _api » dans la première URL passée à fetch(). Si ce n’est pas le cas, utilisez ISPHttpClientBatchCreationOptions.webUrl pour le spécifier explicitement.
get(url, configuration, options)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Appelle fetch(), mais définit la méthode sur « GET ».
get(url: string, configuration: SPHttpClientBatchConfiguration, options?: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Paramètres
- url
-
string
URL à récupérer
- configuration
- SPHttpClientBatchConfiguration
détermine le comportement par défaut de cette requête ; normalement, il doit s’agir du numéro de version le plus récent de SPHttpClientBatchConfigurations
- options
- ISPHttpClientBatchOptions
_ Options supplémentaires qui affectent la demande
Retours
Promise<SPHttpClientResponse>
Promesse avec un comportement similaire à WHATWG fetch(). Cette promesse se résout normalement (httpClientResponse.ok étant false) pour les codes d’erreur status tels que HTTP 404 ou 500. La promesse est rejetée uniquement pour les défaillances réseau ou d’autres erreurs qui empêchent la communication avec le serveur.
post(url, configuration, options)
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Appelle fetch(), mais définit la méthode sur « POST ».
post(url: string, configuration: SPHttpClientBatchConfiguration, options: ISPHttpClientBatchOptions): Promise<SPHttpClientResponse>;Paramètres
- url
-
string
URL à récupérer
- configuration
- SPHttpClientBatchConfiguration
détermine le comportement par défaut de cette requête ; normalement, il doit s’agir du numéro de version le plus récent de SPHttpClientBatchConfigurations
- options
- ISPHttpClientBatchOptions
_ Options supplémentaires qui affectent la demande
Retours
Promise<SPHttpClientResponse>
Promesse avec un comportement similaire à WHATWG fetch(). Cette promesse se résout normalement (httpClientResponse.ok étant false) pour les codes d’erreur status tels que HTTP 404 ou 500. La promesse est rejetée uniquement pour les défaillances réseau ou d’autres erreurs qui empêchent la communication avec le serveur.