XMLHttpRequest
Baseline
Widely available
*
Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis juillet 2015.
* Certaines parties de cette fonctionnalité peuvent bénéficier de prise en charge variables.
Les objets XMLHttpRequest (XHR) permettent d'interagir avec des serveurs. On peut récupérer des données à partir d'une URL sans avoir à rafraîchir complètement la page. Cela permet à une page web d'être mise à jour sans perturber les actions de l'utilisateur.
XMLHttpRequest est beaucoup utilisé par l'approche AJAX.
Malgré son nom, XMLHttpRequest peut être utilisé afin de récupérer tout type de données et pas uniquement du XML.
Si vos opérations de communication nécessitent l'échange d'évènements ou de messages avec un serveur, pensez à utiliser les évènements serveur via l'interface EventSource. Pour une communication bidirectionnelle complète, les WebSockets peuvent être une meilleure alternative.
Constructeur
XMLHttpRequest()-
Le constructeur initialise un objet
XMLHttpRequest. Il doit être appelé avant toute autre méthode.
Propriétés
Cette interface hérite également des propriétés de XMLHttpRequestEventTarget et de EventTarget.
XMLHttpRequest.onreadystatechange-
Un gestionnaire d'évènement invoqué à chaque fois que l'attribut
readyStatechange. XMLHttpRequest.readyStateLecture seule-
L'état de la requête sous la forme d'un
unsigned short. XMLHttpRequest.responseLecture seule-
Un objet
ArrayBuffer,Blob,Document, un objet JavaScript ou une chaîne de caractères (DOMString) selon la valeur deXMLHttpRequest.responseType. Cet objet contient le corps de la réponse. XMLHttpRequest.responseTextLecture seule-
Une chaîne de caractères
DOMStringqui contient la réponse à la requête sous forme de texte ou la valeurnullsi la requête a échoué ou n'a pas encore été envoyée. XMLHttpRequest.responseType-
Une valeur parmi une liste qui définit le type de réponse.
XMLHttpRequest.responseURLLecture seule-
L'URL sérialisée de la réponse ou la chaîne vide si l'URL est nulle.
XMLHttpRequest.responseXMLLecture seule-
Un objet
Documentqui contient la réponse de la requête ounullsi la requête a échoué, qu'elle n'a pas encore été envoyée ou qu'elle ne peut pas être analysée comme XML ou HTML. Cette propriété n'est pas disponible dans les workers. XMLHttpRequest.statusLecture seule-
Une valeur numérique
unsigned shortqui décrit le statut de la réponse à la requête. XMLHttpRequest.statusTextLecture seule-
Une chaîne
DOMStringqui contient la chaîne de caractères / réponse renvoyée par le serveur HTTP. À la différence deXMLHttpRequest.status, tout le texte du statut est inclus ("200 OK" plutôt que "200" par exemple).
Note : Selon la spécification HTTP/2 (voir 8.1.2.4 Response Pseudo-Header Fields), HTTP/2 ne définit pas de méthode pour porter la version ou la raison/phrase incluse dans la ligne de statut HTTP/1.1.
XMLHttpRequest.timeout-
Un entier
unsigned longqui représente le nombre de millisecondes qu'une requête peut prendre avant d'être terminée automatiquement. XMLHttpRequestEventTarget.ontimeout-
Un gestionnaire d'évènement appelé lorsque la requête a expiré.
XMLHttpRequest.uploadLecture seule-
Un objet
XMLHttpRequestUploadqui représente le processus d'upload. XMLHttpRequest.withCredentials-
Un booléen (
Boolean) qui indique si des requêtesAccess-Controld'origines différentes peuvent être effectuées avec des informations d'authentification telles que des cookies ou des en-têtes d'autorisation.
Propriétés non-standard
XMLHttpRequest.channelLecture seule-
Un objet
nsIChannel. Le canal à utiliser par l'objet lorsqu'il effectue la requête. XMLHttpRequest.mozAnonLecture seule-
Un booléen. S'il est vrai, la requête sera envoyée sans cookie ou en-tête d'autorisation.
XMLHttpRequest.mozSystemLecture seule-
Un booléen. S'il est vrai, la politique d'origine unique ne sera pas vérifiée pour la requête.
XMLHttpRequest.mozBackgroundRequest-
Un booléen qui indique si l'objet représente une requête de service en arrière-plan.
XMLHttpRequest.mozResponseArrayBufferObsolète Lecture seule-
Un objet
ArrayBufferqui est la réponse à la requête sous la forme d'un tableau typé JavaScript. XMLHttpRequest.multipartObsolète-
Cette fonctionnalité spécifique à Gecko a été retirée avec Firefox/Gecko 22. Veuillez utiliser les évènements serveurs ou les web sockets ou encore la propriété
responseTextdes évènements de progression.
Gestionnaires d'évènement
Le gestionnaire onreadystatechange, comme propriété des instances XMLHttpRequest, est pris en charge par l'ensemble des navigateurs.
D'autres gestionnaires d'évènements ont également été implémentés dans différents navigateurs (onload, onerror, onprogress, etc.). Voir le guide Manipuler XMLHttpRequest.
La plupart des navigateurs récents gère également les évènements via la méthode addEventListener() (en plus des méthodes on*).
Méthodes
XMLHttpRequest.abort()-
Interrompt la requête si elle a déjà été envoyée.
XMLHttpRequest.getAllResponseHeaders()-
Renvoie, via une chaîne de caractères, l'ensemble des en-têtes de la réponse, séparés par CRLF ou la valeur
nullsi aucune réponse n'a été reçue. XMLHttpRequest.getResponseHeader()-
Renvoie la chaîne de caractères contenant le texte de l'en-tête voulue ou
nullsi aucune des réponse n'a été reçue ou si l'en-tête n'existe pas dans la réponse. XMLHttpRequest.open()-
Initialise une requête. Cette méthode doit être utilisée par du code JavaScript.
XMLHttpRequest.overrideMimeType()-
Surcharge le type MIME renvoyé par le serveur.
XMLHttpRequest.send()-
Envoie la requête. Si la requête est asynchrone (le comportement par défaut), la méthode renvoie un résultat dès que la requête est envoyée.
XMLHttpRequest.setRequestHeader()-
Définit la valeur d'un en-tête de requête HTTP. Cette méthode doit être appelée après
open()mais avantsend().
Méthodes non-standard
XMLHttpRequest.init()-
Initialise l'objet depuis pour une utilisation depuis du code C++.
Attention : Cette méthode ne doit pas être appelée depuis du code JavaScript.
XMLHttpRequest.openRequest()-
Initialise une requête depuis du code natif. Voir la méthode
open()ci-avant pour initialiser une requête de façon standard en JavaSCript. XMLHttpRequest.sendAsBinary()Obsolète-
Une variante de
send()afin d'envoyer des données binaires.
Évènements
abort-
Se déclenche lorsqu'une requête a été interrompue (par exemple via
XMLHttpRequest.abort()). Le gestionnaireonabortest également disponible. error-
Se déclenche lorsqu'une requête a rencontré une erreur. Le gestionnaire
onerrorest également disponible. load-
Se déclenche lorsqu'une transaction
XMLHttpRequestse termine correctement. Le gestionnaireonloadest également disponible. loadend-
Se déclenche lorsqu'une requête est terminée (avec une erreur ou non). Quand elle a réussi, l'évènement a lieu après
load). Quand elle a échoué, l'évènement survient aprèserror). Le gestionnaireonloadendest également disponible. loadstart-
Se déclenche lorsqu'une requête commence à charger des données. Le gestionnaire
onloadstartest également disponible. progress-
Se déclenche périodiquement lorsqu'une requête reçoit des données supplémentaires. Le gestionnaire
onprogressest également disponible. timeout-
Se déclenche lorsque la progression est terminée du fait de l'expiration de la durée limite. Le gestionnaire
ontimeoutest également disponible.
Spécifications
| Specification |
|---|
| XMLHttpRequest> # interface-xmlhttprequest> |
Compatibilité des navigateurs
Chargement…
Voir aussi
-
XMLSerializer: sérialiser un arbre DOM en XML -
Les tutoriels MDN sur
XMLHttpRequest: -
HTML5 Rocks — Nouvelles astuces avec XMLHttpRequest2 (en anglais)