XMLHttpRequest: Difference between revisions

From MozillaZine Knowledge Base
Jump to navigationJump to search
m (added Sarissa resource)
(moved to MDC. kthxbye.)
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{extdev}}
See [http://developer.mozilla.org/en/docs/XMLHttpRequest XMLHttpRequest] at the Mozilla Developer Center.


XMLHttpRequest is a Javascript object that was created by Microsoft and adopted by Mozilla.  You can use it to easily retrieve data via HTTP.  Despite its name, it can be used for more than just XML documents.
[[Category:Redirects]]
 
==Basic Usage==
Using XMLHttpRequest is very simple.  You create an instance of the object, open a URL, and send the request.  The HTTP status code of the result, as well as the result document are available in the request object afterwards.
 
===Example===
<pre>
req = new XMLHttpRequest();
req.open('GET', 'http://www.mozilla.org/', false);
req.send(null);
if(req.status == 200)
  dump(req.responseText);
</pre>
 
Note that this example works synchronously, so it will block the user interface if you call this from your javascript.  You should not use this in practice.
 
==Asynchronous Usage==
If you intend to use XMLHttpRequest from an extension, you should let it load asynchronously.  In asynchronous usage, you get a callback when the data has been received, which lets the browser continue to work as normal while your request is happening.
 
===Example===
<pre>
req = new XMLHttpRequest();
req.open('GET', 'http://www.mozilla.org/', true);
req.onreadystatechange = function (aEvt) {
  if (req.readyState == 4) {
    if(req.status == 200)
      dump(req.responseText);
    else
      dump("Error loading page\n");
  }
};
req.send(null);
</pre>
 
==Other Properties and Methods==
In addition to the properties and methods shown above, there are other useful properties and methods on the request object.
 
===responseXML===
If you load an XML document, the responseXML property will contain the document as an XmlDocument object that you can manipulate using DOM methods.
 
===setRequestHeader()===
This method can be used to set a HTTP header on the request before you send it.
<pre>
req = new XMLHttpRequest();
req.open('GET', 'http://www.mozilla.org/', true);
req.setRequestHeader("X-Foo", "Bar");
req.send(null);
</pre>
 
===getResponseHeader()===
This method can be used to get a HTTP header from the server response.
<pre>
req = new XMLHttpRequest();
req.open('GET', 'http://www.mozilla.org/', true);
req.send(null);
dump("Content-Type: " + req.getResponseHeader("Content-Type") + "\n");
</pre>
 
==References==
<ol>
<li>[http://www.xulplanet.com/references/objref/XMLHttpRequest.html XULPlanet documentation]
<li>[http://msdn.microsoft.com/library/default.asp?url=/library/en-us/xmlsdk/html/xmobjxmlhttprequest.asp  Microsoft documentation]
<li>[http://jibbering.com/2002/4/httprequest.html "Using the XMLHttpRequest Object" (jibbering.com)]
<li>[https://sourceforge.net/projects/sarissa/ Sarissa] - Sarissa is a cross-browser ECMAScript library for client side XML manipulation, including loading XML from URLs or strings, performing XSLT transformations, XPath queries and more. Supported: Gecko (Mozilla, Firefox etc), IE, KHTML (Konqueror, Safari).</li>
</ol>
 
[[Category:Example code]] [[Category:XML in Javascript]]

Latest revision as of 21:12, 26 September 2006

See XMLHttpRequest at the Mozilla Developer Center.