Annotation of 2006/webapi/XMLHttpRequest/Overview.src.html, revision 1.95
1.60 avankest 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
1.1 avankest 2: <html lang="en-US">
3: <head>
4: <title>The XMLHttpRequest Object</title>
1.16 avankest 5: <style type="text/css">
6: pre.idl { border:solid thin; background:#eee; color:#000; padding:0.5em }
7: pre.idl :link, pre.idl :visited { color:inherit; background:transparent }
1.58 avankest 8: pre code { color:inherit; background:transparent }
1.16 avankest 9: div.example { margin-left:1em; padding-left:1em; border-left:double; color:#222; background:#fcfcfc }
1.89 avankest 10: .note { margin-left:2em; font-weight:bold; font-style:italic; color:#008000 }
1.16 avankest 11: p.note::before { content:"Note: " }
1.89 avankest 12: .issue { padding:.5em; border:solid #f00 }
1.16 avankest 13: p.issue::before { content:"Issue: " }
14: em.ct { text-transform:lowercase; font-variant:small-caps; font-style:normal }
15: dfn { font-weight:bold; font-style:normal }
16: code { color:orangered }
17: code :link, code :visited { color:inherit }
18: </style>
1.7 avankest 19: <link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/base">
1.58 avankest 20: <!--<link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-WD">-->
1.1 avankest 21: </head>
22: <body>
23: <div class="head">
24: <p><a href="http://www.w3.org/"><img height="48" width="72" alt="W3C" src="http://www.w3.org/Icons/w3c_home"></a></p>
1.12 avankest 25:
1.10 avankest 26: <h1 class="head">The <code title="">XMLHttpRequest</code> Object</h1>
1.12 avankest 27:
1.53 avankest 28: <h2 class="no-num no-toc" id="pagesubtitle">Editor's draft<!--W3C Working Draft--> [DATE: 3 August 2002]</h2>
1.12 avankest 29:
1.1 avankest 30: <dl>
1.10 avankest 31: <dt>This Version:</dt>
1.24 avankest 32:
1.47 avankest 33: <dd><a href="[VERSION]/">http://www.w3.org/TR/[YEAR]/WD-XMLHttpRequest-[CDATE]/</a></dd>
1.14 avankest 34:
1.10 avankest 35: <dt>Latest Version:</dt>
1.24 avankest 36:
1.1 avankest 37: <dd><a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a></dd>
1.14 avankest 38:
1.10 avankest 39: <dt>Previous Versions:</dt>
1.24 avankest 40:
1.58 avankest 41: <dd><a href="http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070227/">http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070227/</a></dd>
42:
1.22 avankest 43: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060927/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060927/</a></dd>
1.24 avankest 44:
1.1 avankest 45: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/</a></dd>
1.24 avankest 46:
1.1 avankest 47: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/</a></dd>
1.14 avankest 48:
1.1 avankest 49: <dt>Editor:</dt>
1.24 avankest 50:
1.1 avankest 51: <dd><a href="http://annevankesteren.nl/">Anne van Kesteren</a>
52: (<a href="http://www.opera.com/">Opera Software ASA</a>)
53: <<a href="mailto:annevk@opera.com">annevk@opera.com</a>></dd>
54: </dl>
1.14 avankest 55:
1.1 avankest 56: <p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a>
1.51 avankest 57: © 2007
58: <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a><sup>®</sup>
59: (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>,
60: <a href="http://www.ercim.org/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>,
61: <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C
62: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
63: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>
64: and
65: <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document
66: use</a> rules apply.</p>
1.1 avankest 67: </div>
1.12 avankest 68:
1.1 avankest 69: <hr>
1.12 avankest 70:
1.1 avankest 71: <h2 class="no-num no-toc" id="specabstract">Abstract</h2>
1.10 avankest 72:
1.22 avankest 73: <p>The <code title="">XMLHttpRequest</code> Object specification defines an
74: <abbr title="Application Programming Interface">API</abbr> that provides
75: scripted client functionality for transferring data between a client and a
76: server.</p>
1.12 avankest 77:
1.1 avankest 78: <h2 class="no-num no-toc" id="sotd">Status of this Document</h2>
1.12 avankest 79:
1.1 avankest 80: <p><em>This section describes the status of this document at the time of its
1.36 avankest 81: publication. Other documents may supersede this document. A list of current
82: W3C publications and the latest revision of this technical report can be
83: found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a>
84: at http://www.w3.org/TR/.</em></p>
85:
1.63 avankest 86: <!-- change back to Last Call -->
87: <p>This is the [DATE: 3 August 2002] <strong>Editor's</strong> Working
1.54 avankest 88: Draft of The <code title="">XMLHttpRequest</code> Object specification.
1.47 avankest 89: Please send comments to
90: <a href="mailto:public-webapi@w3.org">public-webapi@w3.org</a>
91: (<a href="http://lists.w3.org/Archives/Public/public-webapi/">archived</a>)
92: with either <samp>[XHR]</samp> or <samp title="">[XMLHttpRequest]</samp> at
1.63 avankest 93: the start of the subject line<!-- by 2 April 2007-->.</p>
1.51 avankest 94:
1.47 avankest 95: <p>This document is produced by the
96: <a href="http://www.w3.org/2006/webapi/">Web API Working Group</a>, part of
97: the <a href="http://www.w3.org/2006/rwc/Activity">Rich Web Clients
98: Activity</a> in the W3C <a href="http://www.w3.org/Interaction/">Interaction
1.51 avankest 99: Domain</a>. Changes made to this document can be found in the
1.47 avankest 100: <a href="http://dev.w3.org/cvsweb/2006/webapi/XMLHttpRequest/Overview.html">W3C
101: public CVS server</a>.</p>
1.12 avankest 102:
1.1 avankest 103: <p>Publication as a Working Draft does not imply endorsement by the W3C
1.36 avankest 104: Membership. This is a draft document and may be updated, replaced or
105: obsoleted by other documents at any time. It is inappropriate to cite this
106: document as other than work in progress.</p>
1.12 avankest 107:
1.1 avankest 108: <p>This document was produced by a group operating under the
1.36 avankest 109: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February
1.52 avankest 110: 2004 W3C Patent Policy</a>. W3C maintains a
1.36 avankest 111: <a rel="disclosure" href="http://www.w3.org/2004/01/pp-impl/38482/status">public
112: list of any patent disclosures</a> made in connection with the deliverables
113: of the group; that page also includes instructions for disclosing a patent.
114: An individual who has actual knowledge of a patent which the individual
115: believes contains
116: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential
117: Claim(s)</a> must disclose the information in accordance with
118: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section
119: 6 of the W3C Patent Policy</a>.</p>
1.12 avankest 120:
1.1 avankest 121: <h2 class="no-num no-toc" id="toc">Table of Contents</h2>
1.21 avankest 122:
1.1 avankest 123: <!--toc-->
1.12 avankest 124:
1.1 avankest 125: <h2 id="introduction">Introduction</h2>
1.12 avankest 126:
1.1 avankest 127: <p><em>This section is non-normative.</em></p>
1.12 avankest 128:
1.33 avankest 129: <p>The <code>XMLHttpRequest</code> object implements an interface exposed by
130: a scripting engine that allows scripts to perform HTTP client functionality,
1.22 avankest 131: such as submitting form data or loading data from a server.</p>
1.24 avankest 132:
1.1 avankest 133: <p>The name of the object is <code>XMLHttpRequest</code> for compatibility
1.22 avankest 134: with the web, though each component of this name is potentially misleading.
1.39 avankest 135: First, the object supports any text based format, including XML. Second, it
136: can be used to make requests over both HTTP and HTTPS (some implementations
137: support protocols in addition to HTTP and HTTPS, but that functionality is
138: not covered by this specification). Finally, it supports "requests" in a
139: broad sense of the term as it pertains to HTTP; namely all activity involved
140: with HTTP requests or responses for the defined HTTP methods.</p>
1.12 avankest 141:
1.1 avankest 142: <h3 id="examples">Examples of Usage</h3>
1.12 avankest 143:
1.1 avankest 144: <p><em>This section is non-normative.</em></p>
1.12 avankest 145:
1.37 avankest 146: <p>Some [<cite><span>ECMAScript</span></cite>] examples
1.32 avankest 147: are listed in the specification. In addition, you can find some below.</p>
1.14 avankest 148:
149: <div class="example">
150: <p>Some simple code to do something with data from an XML document fetched
1.22 avankest 151: over the network:</p>
1.16 avankest 152:
1.58 avankest 153: <pre><code>function test(data) {
1.14 avankest 154: // taking care of data
155: }
156:
157: function handler() {
158: if(this.readyState == 4 && this.status == 200) {
159: // so far so good
160: if(this.responseXML != null && this.responseXML.getElementById('test').firstChild.data)
161: // success!
162: test(this.responseXML.getElementById('test').firstChild.data);
163: else
164: test(null);
165: } else if (this.readyState == 4 && this.status != 200) {
166: // fetched the wrong page or network error...
167: test(null);
168: }
169: }
1.12 avankest 170:
1.14 avankest 171: var client = new XMLHttpRequest();
172: client.onreadystatechange = handler;
173: client.open("GET", "test.xml");
1.58 avankest 174: client.send();</code></pre>
1.16 avankest 175:
1.56 avankest 176: <p>If you just want to log a message to the server:</p>
1.16 avankest 177:
1.58 avankest 178: <pre><code>function log(message) {
1.14 avankest 179: var client = new XMLHttpRequest();
1.56 avankest 180: client.open("POST", "/log");
1.57 avankest 181: client.setRequestHeader("Content-Type", "text/plain;charset=UTF-8");
1.14 avankest 182: client.send(message);
1.58 avankest 183: }</code></pre>
1.16 avankest 184:
1.14 avankest 185: <p>Or if you want to check the status of a document on the server:</p>
1.16 avankest 186:
1.58 avankest 187: <pre><code>function fetchStatus(address) {
1.14 avankest 188: var client = new XMLHttpRequest();
189: client.onreadystatechange = function() {
190: // in case of network errors this might not give reliable results
191: if(this.readyState == 4)
192: returnStatus(this.status);
193: }
194: client.open("HEAD", address);
195: client.send();
1.58 avankest 196: }</code></pre>
1.14 avankest 197: </div>
1.12 avankest 198:
1.1 avankest 199: <h3 id="conformance">Conformance</h3>
1.12 avankest 200:
1.27 avankest 201: <p>Everything in this specification is normative except for diagrams,
202: examples, notes and sections marked non-normative.</p>
1.12 avankest 203:
1.1 avankest 204: <p>The key words <em class="ct">must</em>, <em class="ct">must not</em>,
1.74 avankest 205: <em class="ct">should</em> and <em class="ct">may</em> in this document are
206: to be interpreted as described in RFC 2119.
207: [<cite><span>RFC2119</span></cite>]</p>
1.12 avankest 208:
1.1 avankest 209: <p>This specification defines the following classes of products:</p>
1.12 avankest 210:
1.1 avankest 211: <dl>
1.74 avankest 212: <dt><dfn id="conforming-user-agent">Conforming user agent</dfn></dt>
1.24 avankest 213:
1.74 avankest 214: <dd>
215: <p>A user agent <em class="ct">must</em> behave as described in this
216: specification in order to be considered conformant even when faced with
217: non-conforming scripts.</p>
1.95 ! avankest 218:
1.94 avankest 219: <p>If the user agent does not support XML (including support for
220: namespaces) the <span>XML response entity body</span>
221: <em class="ct">must</em> (always) be <code>null</code>.</p>
1.74 avankest 222:
1.75 avankest 223: <p>User agents <em class="ct">may</em> optimize any algorithm given in
224: this specification, so long as the end result is indistinguishable from
225: the result that would be obtained by the specification's algorithms. (The
226: algorithms in this specification are generally written with more concern
227: for clarity than efficiency.)</p>
1.95 ! avankest 228:
! 229: <p class="note">This specification uses both the terms "conforming user
! 230: agent(s)" and "user agent(s)" to refer to this product class.</p>
1.74 avankest 231: </dd>
1.94 avankest 232:
233: <dt><dfn id="conforming-xml-user-agent">Conforming XML user agent</dfn></dt>
234:
235: <dd><p>A user agent that is a <span>conforming user agent</span> and also
236: supports XML (including support for namespaces).</p></dd>
1.24 avankest 237:
1.74 avankest 238: <dt><dfn id="conforming-script">Conforming script</dfn></dt>
1.24 avankest 239:
1.74 avankest 240: <dd><p>A script <em class="ct">must</em> satisfy the constraints and
241: conditions described by this specification in order to be
242: conformant.</p></dd>
1.1 avankest 243: </dl>
1.32 avankest 244:
1.30 avankest 245: <h4 id="dependencies">Dependencies</h4>
1.33 avankest 246:
1.29 avankest 247: <p>This specification relies on several underlying specifications.</p>
248: <dl>
249: <dt>DOM</dt>
1.33 avankest 250:
1.29 avankest 251: <dd>
1.95 ! avankest 252: <p><span title="Conforming user agent">Conforming user agents</span>
! 253: <em class="ct">must</em> support some version of DOM Events and DOM Core,
! 254: because this specification uses some of the features defined in those
! 255: specifications. [<cite><span>DOM3Events</span></cite>]
! 256: [<cite><span>DOM3Core</span></cite>]</p>
! 257:
! 258: <p>It <em class="ct">must</em> also support some version of the Window
! 259: Object because some of the functionality in this specification relies on
! 260: it. [<cite><span>Window</span></cite>]</p>
1.29 avankest 261: </dd>
262:
263: <dt>HTTP</dt>
1.33 avankest 264:
1.29 avankest 265: <dd>
1.95 ! avankest 266: <p><span title="Conforming user agent">Conforming user agents</span>
! 267: <em class="ct">must</em> support some version of the HTTP protocol. The
! 268: user agent <em class="ct">should</em> support any HTTP method that matches
! 269: the <span><code>Method</code> production</span> and
! 270: <em class="ct">must</em> at least support the following methods:</p>
1.58 avankest 271:
272: <ul>
273: <li><code>GET</code></li>
274: <li><code>POST</code></li>
275: <li><code>HEAD</code></li>
276: <li><code>PUT</code></li>
277: <li><code>DELETE</code></li>
278: <li><code>OPTIONS</code></li>
279: </ul>
280:
281: <p>Other requirements regarding HTTP are made throughout the
1.39 avankest 282: specification. [<cite><span>RFC2616</span></cite>]</p>
1.29 avankest 283: </dd>
1.41 avankest 284:
285: <dt>XML</dt>
286:
1.95 ! avankest 287: <dd><p><span title="Conforming XML user agent">Conforming XML user
! 288: agents</span> <em class="ct">must</em> support XML (including support for
! 289: namespaces). [<cite><span>XML</span></cite>]
! 290: [<cite><span>XMLNS</span></cite>]</p></dd>
1.29 avankest 291: </dl>
1.12 avankest 292:
1.80 avankest 293: <h4 id="terminology">Terminology</h4>
1.12 avankest 294:
1.80 avankest 295: <p>There is a <dfn id="case-insensitive-match">case-insensitive match</dfn>
1.92 avankest 296: of strings <var>s1</var> and <var>s2</var> if after lowercasing both strings
1.93 avankest 297: (by mapping a-Z to A-Z) they are identical.</p>
1.80 avankest 298:
299: <h4 id="extensibility">Extensibility</h4>
1.12 avankest 300:
1.81 avankest 301: <p>Extensions of the API defined by this specification are <em>strongly
1.22 avankest 302: discouraged</em>. User agents, Working Groups and other interested parties
1.33 avankest 303: should discuss extensions on a relevant public forum, preferably
1.22 avankest 304: <a href="mailto:public-webapi@w3.org">public-webapi@w3.org</a>.</p>
1.12 avankest 305:
306: <h2 id="xmlhttprequest">The <code title="">XMLHttpRequest</code> Object</h2>
307:
1.58 avankest 308: <p>The <code>XMLHttpRequest</code> object can be used by scripts to
1.22 avankest 309: programmatically connect to their originating server via HTTP.</p>
1.12 avankest 310:
1.1 avankest 311: <p>Objects implementing the <code>XMLHttpRequest</code> interface
1.22 avankest 312: <em class="ct">must</em> also implement the <code>EventTarget</code>
1.58 avankest 313: interface. [<cite><span>DOM3Events</span></cite>]</p>
1.12 avankest 314:
1.58 avankest 315: <p>Objects implementing the <code title="">Window</code> interface
316: <em class="ct">must</em> provide an <code title="">XMLHttpRequest()</code>
317: constructor. [<cite><span>Window</span></cite>]</p>
1.12 avankest 318:
1.1 avankest 319: <div class="example">
1.58 avankest 320: <p>In ECMAScript this can be used as follows:</p>
321: <!-- [<cite><span>ECMAScript</span></cite>] -->
322:
323: <pre><code>var client = new XMLHttpRequest();</code></pre>
1.1 avankest 324: </div>
1.12 avankest 325:
1.58 avankest 326: <p>When the <code title="">XMLHttpRequest()</code> constructor is invoked a
327: persistent pointer to the associated <code title="">Window</code> object
328: <em class="ct">must</em> be stored on the newly created object. This is the
1.25 avankest 329: <dfn title="Window pointer" id="window-pointer"><code>Window</code>
1.58 avankest 330: pointer</dfn>. The associated <code title="">Window</code> object is the one
331: of which the <code title="">XMLHttpRequest</code> constructor was
332: invoked. This <span title="Window pointer">pointer</span>
1.25 avankest 333: <em class="ct">must</em> persist even if the browsing context in which the
1.37 avankest 334: <code title="">Window</code> is located is destroyed (by removing it from a
335: parent browsing context, for instance).</p>
1.25 avankest 336:
1.37 avankest 337: <p>The term browsing context is defined by the <cite>Window Object
338: 1.0</cite> specification. [<cite><span>Window</span></cite>]</p>
1.27 avankest 339:
340: <!-- XXX if the document object changes in the browsing context you get an
1.33 avankest 341: exception in some implementations. -->
1.27 avankest 342:
1.58 avankest 343: <div class="example">
1.65 avankest 344: <p>If <var><code>win</code></var> is a <code title="">Window</code> object
345: <var><code>client</code></var> will have a pointer to
346: <var><code>win</code></var> in the following example:</p>
1.58 avankest 347:
1.65 avankest 348: <pre><code>var client = new win.XMLHttpRequest()</code></pre>
1.58 avankest 349: </div>
1.12 avankest 350:
1.58 avankest 351: <pre class="idl">interface <dfn id="xmlhttprequest-object">XMLHttpRequest</dfn> {
352: // event handler
1.70 avankest 353: attribute EventListener <span>onreadystatechange</span>;
1.58 avankest 354:
355: // state
1.71 avankest 356: const unsigned short <span title="UNSENT state">UNSENT</span> = 0;
1.58 avankest 357: const unsigned short <span title="OPEN state">OPEN</span> = 1;
358: const unsigned short <span title="SENT state">SENT</span> = 2;
1.86 avankest 359: const unsigned short <span title="LOADING state">LOADING</span> = 3;
1.79 avankest 360: const unsigned short <span title="DONE state">DONE</span> = 4;
1.70 avankest 361: readonly attribute unsigned short <span>readyState</span>;
1.58 avankest 362:
363: // request
1.70 avankest 364: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>);
365: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>);
366: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>, in DOMString <var>user</var>);
367: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>, in DOMString <var>user</var>, in DOMString <var>password</var>);
368: void <span>setRequestHeader</span>(in DOMString <var>header</var>, in DOMString <var>value</var>);
369: void <span>send</span>();
370: void <span>send</span>(in DOMString <var>data</var>);
371: void <span>send</span>(in Document <var>data</var>);
372: void <span>abort</span>();
1.58 avankest 373:
374: // response
1.70 avankest 375: DOMString <span>getAllResponseHeaders</span>();
376: DOMString <span>getResponseHeader</span>(in DOMString <var>header</var>);
377: readonly attribute DOMString <span>responseText</span>;
378: readonly attribute Document <span>responseXML</span>;
379: readonly attribute unsigned short <span>status</span>;
380: readonly attribute DOMString <span>statusText</span>;
1.1 avankest 381: };</pre>
1.8 avankest 382:
1.58 avankest 383: <p>The <code>XMLHttpRequest</code> object can be in five states:
1.71 avankest 384: <span title="UNSENT state">UNSENT</span>,
1.58 avankest 385: <span title="OPEN state">OPEN</span>, <span title="SENT state">SENT</span>,
1.86 avankest 386: <span title="LOADING state">LOADING</span> and
1.79 avankest 387: <span title="DONE state">DONE</span>. The current state is exposed through
388: the <code>readyState</code> attribute. The method definitions below define
389: when a state transition takes place.</p>
1.58 avankest 390:
391: <p>When constructed, the <code>XMLHttpRequest</code> object
1.71 avankest 392: <em class="ct">must</em> be in the UNSENT state. This state is represented
393: by the <dfn id="unsent" title="UNSENT state"><code>UNSENT</code></dfn>
1.58 avankest 394: constant, whose value is <code>0</code>.</p>
395:
396: <p>The OPEN state is the state of the object when the <code>open()</code>
1.92 avankest 397: method has been successfully invoked. During this state request headers can
1.58 avankest 398: be set using <code>setRequestHeader()</code> and the request can be made
399: using <code>send()</code>. This state is represented by the
400: <dfn id="open" title="OPEN state"><code>OPEN</code></dfn> constant, whose
401: value is <code>1</code>.</p>
402:
1.87 avankest 403: <p>During the OPEN state there is a <dfn id="send-flag"><code>send()</code>
404: flag</dfn> which influences several algorithms described below. Outside the
405: OPEN state its value <em class="ct">must</em> (always) be "false". During
406: the OPEN state it can be set to "true" as described in the
407: <code>send()</code> method algorithm.</p>
408:
1.58 avankest 409: <p>The SENT state is the state of the object when the user agent
410: successfully acknowledged the request. This state is represented by the
411: <dfn id="sent" title="SENT state"><code>SENT</code></dfn> constant, whose
412: value is <code>2</code>.</p>
413:
1.86 avankest 414: <p>The LOADING state is the state of the object when all HTTP headers have
1.58 avankest 415: been received. The object typically remains in this state until the complete
416: message body (if any) has been received. This state is represented by the
1.86 avankest 417: <dfn id="loading" title="LOADING state"><code>LOADING</code></dfn> constant,
418: whose value is <code>3</code>.</p>
1.58 avankest 419:
1.79 avankest 420: <p>The DONE state is the state of the object when either the data transfer
1.58 avankest 421: has been completed or something went wrong during the transfer (infinite
422: redirects for instance). This state is represented by the
1.79 avankest 423: <dfn id="done" title="DONE state"><code>DONE</code></dfn> constant, whose
424: value is <code>4</code>.</p>
1.90 avankest 425:
1.88 avankest 426: <p>The <dfn id="response-entity-body">response entity body</dfn> is the
427: fragment of the <span>entity body</span> received so far (LOADING state) or
428: the complete entity body (DONE state). If there is no entity body the
429: response entity body is "null".</p>
430:
431: <p>The <dfn id="text-response-entity-body">text response entity body</dfn>
1.90 avankest 432: is either a <code>DOMString</code> or <code>null</code>. The value of the
433: text response entity body is determined by running the following
434: algorithm:</p>
435:
1.88 avankest 436: <ol>
1.90 avankest 437: <li><p>If the <span>response entity body</span> is "null" the value is
438: <code>null</code> and abort these steps.</p>
439:
440: <li><p>Let <var>charset</var> be UTF-8.</p></li>
441:
442: <li><p>If there is no <code>Content-Type</code> header or there is a
443: <code>Content-Type</code> header which contains a MIME type that is
1.91 avankest 444: <code>text/xml</code>, <code>application/xml</code>, <code>text/xsl</code>
445: or ends in <code title="">+xml</code> (ignoring any parameters) use the
446: rules set forth in the XML specification to determine the character
447: encoding. Let <var>charset</var> be the determined character
448: encoding.</p></li>
1.90 avankest 449:
450: <li><p>If the <code>Content-Type</code> MIME type contains a
451: <code>charset</code> parameter let <var>charset</var> be the value of that
452: parameter.</p></li>
453:
1.92 avankest 454: <li><p>The value is the result of decoding the <span>response entity
1.90 avankest 455: body</span> using <var>charset</var>. If that fails the value is
456: <code>null</code>.</p></li>
1.88 avankest 457: </ol>
1.90 avankest 458:
1.88 avankest 459: <p>If the <span>response entity body</span> is "null" the text response
460: entity body is <code>null</code>. If the user agent fails to decode the
461: response entity body the text response entity body is also
462: <code>null</code>.</p>
1.90 avankest 463:
1.88 avankest 464: <p>The <dfn id="xml-response-entity-body">XML response entity body</dfn> is
465: a <code>Document</code> representing the response entity body or
1.90 avankest 466: <code>null</code> and is determined by running the following algorithm:</p>
467:
1.88 avankest 468: <ol>
1.90 avankest 469: <li><p>If the <span>response entity body</span> is "null" the value is
1.88 avankest 470: <code>null</code>.</p></li>
471:
472: <li><p>If there is no <code>Content-Type</code> header the value is
473: <code>null</code>.</p></li>
1.90 avankest 474: <!-- can it have no value? -->
1.88 avankest 475:
1.90 avankest 476: <li><p>If the <code>Content-Type</code> header does not contain a MIME type
477: (ignoring any parameters) that is <code>text/xml</code>,
1.91 avankest 478: <code>application/xml</code>, <code>text/xsl</code> or ends in
479: <code title="">+xml</code> the value is <code>null</code>.</p></li>
1.88 avankest 480:
481: <li><p>Parse the <span>response entity body</span> following the rules from
482: the XML specifications. Let the result be <var>parsed document</var>. If
483: this fails (unsupported character encoding, namespace well-formedness error
484: et cetera) the value is <code>null</code>. [<cite><span>XML</span></cite>]
485: [<cite><span>XMLNS</span></cite>]</p></li>
486:
487: <li><p>The value is an object implementing the <code>Document</code>
488: interface representing the <var>parsed document</var>.</p></li>
489: </ol>
1.58 avankest 490:
1.5 avankest 491: <dl>
1.12 avankest 492:
1.39 avankest 493: <dt><dfn id="dfn-onreadystatechange"><code>onreadystatechange</code></dfn>
494: of type <code>EventListener</code></dt>
1.12 avankest 495:
1.1 avankest 496: <dd>
497: <p>An attribute that takes an <code>EventListener</code> as value that
1.58 avankest 498: <em class="ct">must</em> be invoked along with any other appropriate event
499: listeners that are registered on this object when a
1.87 avankest 500: <code>readystatechange</code> event is dispatched on it during the
501: bubbling phase. Its initial value <em class="ct">must</em> be
502: <code>null</code>.</p>
1.1 avankest 503: </dd>
1.12 avankest 504:
1.1 avankest 505: <dt><dfn id="dfn-readystate"><code>readyState</code></dfn> of type
1.22 avankest 506: <code>unsigned short</code>, readonly</dt>
1.12 avankest 507:
1.1 avankest 508: <dd>
1.58 avankest 509: <p>The attribute <em class="ct">must</em> be the value of the constant
510: corresponding to the object's current state.</p>
1.1 avankest 511: </dd>
1.12 avankest 512:
1.14 avankest 513: <dt><dfn id="dfn-open" title="open"><code>open(<var>method</var>,
1.22 avankest 514: <var>url</var>, <var>async</var>, <var>user</var>,
515: <var>password</var>)</code></dfn>, method</dt>
1.12 avankest 516:
1.1 avankest 517: <dd>
1.58 avankest 518: <p>When invoked, the user agent <em class="ct">must</em> follow the
519: following steps:</p>
520:
521: <ol>
522: <li><p>If the <var>method</var> argument doesn't match the
523: <dfn><code>Method</code> production</dfn> defined in section 5.1.1 of RFC
524: 2616 the user agent <em class="ct">must</em> raise a
525: <code>SYNTAX_ERR</code> exception and abort these steps.
526: [<cite><span>RFC2616</span></cite>]</p></li>
527:
528: <li><p>If the given <var>method</var> is not supported for security
529: reasons the user agent <em class="ct">should</em> raise a
530: <code>SECURITY_ERR</code> exception and abort these steps.</p></li>
531:
532: <li><p>Let <var>stored method</var> be <var>method</var>.</p></li>
533:
1.80 avankest 534: <li><p>If <var>method</var>
535: <span title="case-insensitive match">case-insensitively matches</span>
536: <code>GET</code>, <code>POST</code>, <code>HEAD</code>, <code>PUT</code>,
1.58 avankest 537: <code>DELETE</code> or <code>OPTIONS</code> the user agent
1.80 avankest 538: <em class="ct">must</em> convert it to its uppercase equivalent (by
539: mapping a-z to A-Z) and let <var>stored method</var> be the
540: result.</p></li>
1.68 avankest 541: <!-- WebKit (and supposedly Firefox) also uppercase: CONNECT, COPY,
542: INDEX, LOCK, M-POST, MKCOL, MOVE, PROPFIND, PROPPATCH, TRACE and UNLOCK.
543: Not sure if TRACE and CONNECT are worth it though. They raise a
544: SECURITY_ERR exception anyway... -->
1.58 avankest 545:
546: <li><p>Drop the fragment identifier (if any) from <var>url</var> and let
547: <var>stored url</var> be the result of that operation.</p></li>
548:
549: <li><p>If <var>stored url</var> is a relative reference it
550: <em class="ct">must</em> be resolved using the current value of the
551: <code>baseURI</code> attribute of the <code>Document</code> object
552: currently associated with the <span><code>Window</code> pointer</span>.
553: If this fails the user agent <em class="ct">must</em> raise a
554: <code>SYNTAX_ERR</code> exception and abort these steps.</p></li>
555:
556: <li><p>If the <code>"user:password"</code> format in the
557: <code>userinfo</code> production defined in section 3.2.1 of RFC 3986 is
558: not supported for the relevant scheme and <var>stored url</var> contains
559: this format the user agent <em class="ct">must</em> throw a
1.69 avankest 560: <code>SYNTAX_ERR</code> and abort these steps.
561: [<cite><span>RFC3986</span></cite>]</p></li>
1.58 avankest 562:
563: <li><p>If <var>stored url</var> contains the <code>"user:password"</code>
564: format let <var>stored user</var> be the user part and <var>stored
565: password</var> be the password part.</p></li>
566:
567: <li><p>If <var>stored url</var> just contains the <code>"user"</code>
568: format let <var>stored user</var> be the user part.</p></li>
569:
1.69 avankest 570: <li>
571: <p>If <var>stored url</var> is non same-origin the user agent
572: <em class="ct">should</em> raise a <code>SECURITY_ERR</code> exception
573: and abort these steps.</p>
574: <p class="note">This specification does not define what constitutes as
1.71 avankest 575: non same-origin.<!-- XXX reference HTML5? --></p>
1.69 avankest 576: </li>
1.58 avankest 577:
578: <li><p>Let <var>async</var> be the value of the <var>async</var> argument
579: or <code>false</code> if it was omitted.</p></li>
580:
581: <li><p>If the <var>user</var> argument was not omitted and its syntax
582: does not match that specified by the relevant authentication scheme the
583: user agent <em class="ct">must</em> raise a <code>SYNTAX_ERR</code>
584: exception and abort these steps.</p></li>
1.14 avankest 585:
1.58 avankest 586: <li>
587: <p>If the <var>user</var> argument was not omitted and is not
588: <code>null</code> let <var>stored user</var> be <var>user</var> encoded
589: using the encoding specified in the relevant authentication scheme or
590: UTF-8 if the scheme fails to specify an encoding.</p>
1.14 avankest 591:
1.58 avankest 592: <p class="note">This step overrides any user that may have been set by
593: the <var>url</var> argument.</p>
594: </li>
1.16 avankest 595:
1.58 avankest 596: <li><p>If the <var>user</var> argument was not omitted and is
597: <code>null</code> remove <var>stored user</var>.</p></li>
1.14 avankest 598:
1.58 avankest 599: <li><p>If the <var>password</var> argument was not omitted and its syntax
600: does not match that specified by the relevant authentication scheme the
601: user agent <em class="ct">must</em> raise a <code>SYNTAX_ERR</code>
602: exception and abort these steps.</p></li>
603:
604: <li><p>If the <var>password</var> argument was not omitted and is not
605: <code>null</code> let <var>stored password</var> be <var>password</var>
606: encoded using the encoding specified in the relevant authentication
607: scheme or UTF-8 if the scheme fails to specify an encoding.</p></li>
608:
609: <li><p>If the <var>password</var> argument was not omitted and is
610: <code>null</code> remove <var>stored password</var>.</p></li>
611:
1.89 avankest 612: <li><p>Set <span>response entity body</span> to "null" and reset the list
613: of request headers.<p></li>
1.58 avankest 614:
1.60 avankest 615: <li><p>Any network activity for which the object responsible
616: <em class="ct">should</em> be cancelled.</p></li>
1.58 avankest 617: <!-- we can hardly require it... -->
618:
619: <li><p>Switch the object to the <span title="OPEN state">OPEN</span>
620: state; the user agent <em class="ct">must</em> then synchronously
621: dispatch a <code>readystatechange</code> event on the object and abort
622: these steps (returning the method call).</p></li>
623: </ol>
1.14 avankest 624:
1.19 avankest 625: <p class="note">A future version or extension of this specification will
1.33 avankest 626: most likely define a way of doing cross-site requests.</p>
1.1 avankest 627: </dd>
1.12 avankest 628:
1.14 avankest 629: <dt><dfn id="dfn-setrequestheader" title="setrequestheader"><code>setRequestHeader(<var>header</var>,
1.22 avankest 630: <var>value</var>)</code></dfn>, method</dt>
1.12 avankest 631:
1.5 avankest 632: <dd>
1.45 avankest 633: <p>Each request has a list of request headers with associated values. This
634: method can be used to manipulate those values and set new request
635: headers.</p>
636:
1.58 avankest 637: <p>When invoked, the user agent <em class="ct">must</em> follow the
638: following steps:</p>
1.14 avankest 639:
1.58 avankest 640: <ol>
641: <li><p>If the state of the object is not
642: <span title="OPEN state">OPEN</span> the user agent
643: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
644: exception and abort these steps.</p></li>
645:
1.87 avankest 646: <li><p>If the <span><code>send()</code> flag</span> is "true" the user
647: agent <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1.58 avankest 648: exception and abort these steps.</p></li>
1.14 avankest 649:
1.58 avankest 650: <li><p>If the <var>header</var> argument doesn't match the
1.22 avankest 651: <dfn><code>field-name</code> production</dfn> as defined by section 4.2
1.70 avankest 652: of RFC 2616 or is <code>null</code> the user agent
1.72 avankest 653: <em class="ct">must</em> raise a <code>SYNTAX_ERR</code> exception and
654: abort these steps. [<cite><span>RFC2616</span></cite>]</p></li>
1.70 avankest 655:
656: <li><p>If the <var>value</var> argument is <code>null</code> the user
657: agent <em class="ct">must</em> abort these steps. (Don't raise an
658: exception.)</li>
659: <!-- undefined is to be treated as null here... -->
1.79 avankest 660:
1.58 avankest 661: <li><p>If the <var>value</var> argument doesn't match the
1.22 avankest 662: <dfn><code>field-value</code> production</dfn> as defined by section 4.2
1.58 avankest 663: of RFC 2616 the user agent <em class="ct">must</em> raise a
664: <code>SYNTAX_ERR</code> and abort these steps.
665: [<cite><span>RFC2616</span></cite>]</p></li>
1.14 avankest 666:
1.32 avankest 667: <li>
1.58 avankest 668: <p>For security reasons these steps <em class="ct">should</em> be
1.80 avankest 669: aborted if the <var>header</var> argument
670: <span title="case-insensitive match">case-insensitively matches</span>
671: one of the following headers:</p>
1.58 avankest 672:
1.32 avankest 673: <ul>
674: <li><code>Accept-Charset</code></li>
675: <li><code>Accept-Encoding</code></li>
1.68 avankest 676: <li><code>Connection</code></li>
1.32 avankest 677: <li><code>Content-Length</code></li>
1.68 avankest 678: <li><code>Content-Transfer-Encoding</code></li>
679: <li><code>Date</code></li>
1.32 avankest 680: <li><code>Expect</code></li>
681: <li><code>Host</code></li>
682: <li><code>Keep-Alive</code></li>
683: <li><code>Referer</code></li>
684: <li><code>TE</code></li>
685: <li><code>Trailer</code></li>
686: <li><code>Transfer-Encoding</code></li>
687: <li><code>Upgrade</code></li>
1.68 avankest 688: <li><code>Via</code></li>
1.32 avankest 689: </ul>
690: </li>
1.5 avankest 691:
1.58 avankest 692: <li><p>If the <var>header</var> argument is not in the list of request
693: headers the user agent <em class="ct">must</em> append the
694: <var>header</var> with its associated <var>value</var> to the list and
695: abort these steps.</p></li>
696:
697: <li><p>If the <var>header</var> argument is in the list of request
698: headers the user agent <em class="ct">must</em> either use multiple
699: headers, combine the values or use a combination of those (section 4.2,
1.66 avankest 700: RFC 2616). [<cite><span>RFC2616</span></cite>]</p></li>
1.58 avankest 701: </ol>
1.45 avankest 702:
703: <p class="note">See also the <code>send()</code> method regarding user
1.71 avankest 704: agent header handling for caching, authentication, proxies, and
705: cookies.</p>
1.14 avankest 706:
707: <div class="example">
1.58 avankest 708: <pre><code>// The following script:
1.14 avankest 709: var client = new XMLHttpRequest();
710: client.open('GET', 'demo.cgi');
711: client.setRequestHeader('X-Test', 'one');
712: client.setRequestHeader('X-Test', 'two');
713: client.send();
714:
715: // ...would result in the following header being sent:
716: ...
717: X-Test: one, two
1.58 avankest 718: ...</code></pre>
1.14 avankest 719: </div>
1.5 avankest 720: </dd>
1.12 avankest 721:
1.14 avankest 722: <dt><dfn id="dfn-send" title="send"><code>send(<var>data</var>)</code></dfn>,
1.22 avankest 723: method</dt>
1.12 avankest 724:
1.17 avankest 725: <dd>
1.58 avankest 726: <p>The <code>send()</code> method initiates the request and its optional
727: argument <em class="ct">may</em> be used by scripts to provide the entity
728: body. When the argument is provided scripts <em class="ct">should</em>
729: ensure that they have specified (before invoking <code>send()</code>) the
1.60 avankest 730: <code>Content-Type</code> header via <code>setRequestHeader()</code>.</p>
1.58 avankest 731:
732: <p>When invoked, the user agent <em class="ct">must</em> follow the
733: following steps:</p>
734:
735: <ol>
736: <li><p>If the state of the object is not
737: <span title="OPEN state">OPEN</span> the user agent
738: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
739: exception and abort these steps.</p></li>
740:
1.87 avankest 741: <li><p>If the <span><code>send()</code> flag</span> is "true" the user
742: agent <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1.58 avankest 743: exception and abort these steps.</p></li>
744:
745: <li>
746: <p>If the <var>data</var> argument has not been omitted and is not
747: <code>null</code> it <em class="ct">must</em> be used for the
748: <dfn id="dfn-entity-body">entity body</dfn> as defined by section 7.2 of
1.71 avankest 749: RFC 2616. [<cite><span>RFC2616</span></cite>]</p>
750:
751: <p>The following rules <em class="ct">must</em> be followed by the user
752: agent:</p>
1.58 avankest 753:
754: <dl>
755: <dt><var>data</var> is a <code>DOMString</code></dt>
756:
1.78 avankest 757: <dd><p><var>data</var> <em class="ct">must</em> be encoded as UTF-8 for
758: transmission.</p></dd>
1.58 avankest 759:
760: <dt><var>data</var> is a <code>Document</code>
761:
762: <dd>
763: <p><var>data</var> <em class="ct">must</em> be serialized into a
764: namespace well-formed XML document and encoded using the encoding
765: given by <code><var>data</var>.xmlEncoding</code>, if specified, or
766: UTF-8 otherwise. If this fails because the <code>Document</code>
767: cannot be serialized the user agent <em class="ct">must</em> act as if
768: <var>data</var> was <code>null</code>.</p>
769:
770: <p>If no <code>Content-Type</code> header has been set by the script
1.71 avankest 771: the user agent <em class="ct">must</em> append it to the list of
1.58 avankest 772: request headers with a value of <code>application/xml</code>.</p>
773:
774: <p class="note">Subsequent changes to the <code>Document</code> have
775: no effect on what is submitted.</p>
776: </dd>
777:
778: <dt><var>data</var> is not a <code>DOMString</code> or
779: <code>Document</code></dt>
780:
1.78 avankest 781: <dd><p>The stringification mechanisms of the host language
1.58 avankest 782: <em class="ct">must</em> be used on <var>data</var> and the result
783: <em class="ct">must</em> be treated as if <var>data</var> is a
1.78 avankest 784: <code>DOMString</code>.</p></dd>
785: <!-- XXX What if the host language doesn't have stringification for
786: each type? Do we care? -->
1.58 avankest 787: </dl>
788:
789: <p>If the data argument has been omitted or is <code>null</code> no
790: entity body <em class="ct">must</em> be used in the request.</p>
791: </li>
792:
1.71 avankest 793: <li><p>Make a request to <var>stored url</var>, using HTTP method
794: <var>stored method</var>, user <var>stored user</var> (if provided) and
795: password <var>stored password</var> (if provided), taking into account
796: the entity body, list of request headers and the rules listed directly
797: after this set of steps.</p></li>
1.60 avankest 798:
1.67 avankest 799: <li>
800: <p>The user agent <em class="ct">must</em> then synchronously
801: dispatch a <code>readystatechange</code> event on the object.</p>
802:
1.71 avankest 803: <p class="note">The state of the object doesn't actually change as the
1.67 avankest 804: event is dispatched for historical reasons.</p>
805: </li>
806:
1.58 avankest 807: <li><p>If <var>async</var> is <code>true</code> the user agent
1.87 avankest 808: <em class="ct">must</em> set the <dfn><code>send()</code> flag</dfn> to
809: "true" and return the <code>send()</code> method call. (Don't abort the
810: steps in the algorithm though.)</p></li>
1.58 avankest 811:
1.82 avankest 812: <li><p>If the request has been successfully acknowledged synchronously
813: switch the state to <span title="SENT state">SENT</span>; the user agent
1.58 avankest 814: <em class="ct">must</em> then synchronously dispatch a
815: <code>readystatechange</code> event on the object.</p></li>
816:
817: <li><p>If all HTTP headers have been receieved, immediately before
1.82 avankest 818: receiving the message body (if any), synchronously switch the state to
1.86 avankest 819: <span title="LOADING state">LOADING</span>; the user agent
1.58 avankest 820: <em class="ct">must</em> then synchronously dispatch a
821: <code>readystatechange</code> event on the object.</p></li>
822:
823: <li>
824: <p>If the response is an HTTP redirect (status code <code>301</code>,
825: <code>302</code>, <code>303</code> or <code>307</code>), then it
826: <em class="ct">must</em> be transparently followed (unless it violates
827: security, infinite loop precautions or the scheme isn't supported).</p>
1.60 avankest 828:
1.58 avankest 829: <p class="note">HTTP places requirements on the user agent regarding the
830: preservation of the request method and entity body during redirects, and
831: also requires users to be notified of certain kinds of automatic
832: redirections.</p>
833: <!-- Arguably HTTP should be fixed for the latter case. No browser
834: follows that as far as I know. -->
835: </li>
1.60 avankest 836:
1.58 avankest 837: <li>
838: <p>If something goes wrong (infinite loop, network errors) the user
839: agent <em class="ct">must</em> follow the following set of steps:</p>
1.60 avankest 840:
1.58 avankest 841: <ol>
1.89 avankest 842: <li><p>Set <span>reponse entity body</span> to "null" and reset the
843: list of request headers.</p></li>
1.60 avankest 844:
1.82 avankest 845: <li><p>Synchronously switch the state to
1.79 avankest 846: <span title="DONE state">DONE</span>.</p></li>
1.60 avankest 847:
1.58 avankest 848: <li><p>If <var>async</var> is set to <code>false</code> the user agent
849: <em class="ct">must</em> raise a <code>NETWORK_ERR</code> exception.
850: (Don't abort these steps.)</p></li>
1.60 avankest 851:
1.58 avankest 852: <li><p>Synchronously dispatch a <code>readystatechange</code> event on
853: the object.</p></li>
1.60 avankest 854:
1.58 avankest 855: <li><p>Abort the overall algorithm.</p></li>
856: </ol>
1.60 avankest 857:
1.82 avankest 858: <p class="note">It is likely that a future version of the
859: <code>XMLHttpRequest</code> object will dispatch an <code>error</code>
860: event here as well.</p>
1.58 avankest 861: </li>
862:
1.82 avankest 863: <li><p>When the request has successfully completed loading, synchronously
864: switch the state to <span title="DONE state">DONE</span>; the user agent
1.58 avankest 865: <em class="ct">must</em> then synchronously dispatch a
866: <code>readystatechange</code> event on the object and abort these
867: steps (and return the method call in case of <var>async</var> being
868: <code>false</code>).</p></li>
869: </ol>
1.14 avankest 870:
1.91 avankest 871: <p>If the user agent allows the user to configure a proxy it
1.22 avankest 872: <em class="ct">should</em> modify the request appropriately;
1.42 avankest 873: <abbr title="in other words">i.e.</abbr>, connect to the proxy host
874: instead of the origin server, modify the <code>Request-Line</code> and
875: send <code>Proxy-Authorization</code> headers as specified.</p>
1.12 avankest 876:
1.42 avankest 877: <p>If the user agent supports HTTP Authentication it
1.22 avankest 878: <em class="ct">should</em> consider requests originating from this object
1.42 avankest 879: to be part of the protection space that includes the accessed URIs and
880: send <code>Authorization</code> headers and handle <code>401
1.72 avankest 881: Unauthorised</code> requests appropriately. If authentication fails, user
1.42 avankest 882: agents <em class="ct">should</em> prompt the users for credentials.
883: [<cite><span>RFC2617</span></cite>]</p>
884:
1.57 avankest 885: <p>If the user agent supports HTTP State Management it
1.42 avankest 886: <em class="ct">should</em> persist, discard and send cookies (as received
887: in the <code>Set-Cookie</code> and <code>Set-Cookie2</code> response
888: headers, and sent in the <code>Cookie</code> header) as applicable.
889: [<cite><span>RFC2965</span></cite>]</p>
890:
891: <p>If the user agent implements a HTTP cache it <em class="ct">should</em>
892: respect <code>Cache-Control</code> request headers set by the script
893: (<abbr title="for example">e.g.</abbr>, <code>Cache-Control:
894: no-cache</code> bypasses the cache). It <em class="ct">must not</em> send
895: <code>Cache-Control</code> or <code>Pragma</code> request headers
896: automatically unless the user explicitly requests such behaviour
897: (<abbr>e.g.</abbr>, by (force-)reloading the page). <code>304 Not
1.22 avankest 898: Modified</code> responses that are a result of a user agent generated
899: conditional request <em class="ct">must</em> be presented as <code>200
1.57 avankest 900: OK</code> responses with the appropriate content. The user agent
1.39 avankest 901: <em class="ct">must</em> allow scripts to override automatic cache
1.22 avankest 902: validation by setting request headers (e.g., <code>If-None-Match</code>,
1.42 avankest 903: <code>If-Modified-Since</code>), in which case <code>304 Not
904: Modified</code> responses <em class="ct">must</em> be passed through.
905: [<cite><span>RFC2616</span></cite>]</p>
1.12 avankest 906:
1.8 avankest 907: <p>If the user agent implements server-driven content-negotiation
1.42 avankest 908: it <em class="ct">should</em> set <code>Accept-Language</code>,
1.22 avankest 909: <code>Accept-Encoding</code> and <code>Accept-Charset</code> headers as
910: appropriate; it <em class="ct">must not</em> automatically set the
911: <code>Accept</code> header. Responses to such requests
1.40 avankest 912: <em class="ct">must</em> have the content-codings automatically
1.42 avankest 913: decoded. [<cite><span>RFC2616</span></cite>]</p>
1.8 avankest 914: </dd>
1.12 avankest 915:
1.14 avankest 916: <dt><dfn id="dfn-abort"><code>abort()</code></dfn>, method</dt>
1.12 avankest 917:
1.5 avankest 918: <dd>
1.60 avankest 919: <p>When invoked, the user agent <em class="ct">must</em> run the following
920: steps:</p>
921:
922: <ol>
923: <li><p>Set the <code>responseText</code>, <code>responseXML</code>,
924: <code>status</code> and <code>responseText</code> attributes to their
925: initial value as well as removing any registered request
926: headers.</p></li>
927:
928: <li><p>Any network activity for which the object responsible
929: <em class="ct">should</em> be cancelled.</p></li>
930:
1.83 avankest 931: <li>
1.85 avankest 932: <p>If the state is <span title="UNSENT state">UNSENT</span>,
1.83 avankest 933: <span title="OPEN state">OPEN</span> and the <span><code>send()</code>
1.87 avankest 934: flag</span> is "false", or <span title="DONE state">DONE</span> go to
935: the next step.</p>
1.85 avankest 936:
1.83 avankest 937: <p>Otherwise, switch the state to <span title="DONE state">DONE</span>;
938: the user agent <em class="ct">must</em> then synchronously dispatch a
939: <code>readystatechange</code> event on the object.</p>
940: </li>
1.67 avankest 941:
1.60 avankest 942: <li>
1.71 avankest 943: <p>Switch the state to <span title="UNSENT state">UNSENT</span>. (Don't
944: dispatch the <code>readystatechange</code> event.)</p>
1.60 avankest 945:
1.82 avankest 946: <p class="note">It is likely that a future version of the
947: <code>XMLHttpRequest</code> object will dispatch an
948: <code title="">abort</code> event here as well.</p>
1.60 avankest 949: </li>
950: </ol>
1.5 avankest 951: </dd>
1.12 avankest 952:
1.14 avankest 953: <dt><dfn id="dfn-getallresponseheaders"><code>getAllResponseHeaders()</code></dfn>,
1.22 avankest 954: method</dt>
1.12 avankest 955:
1.5 avankest 956: <dd>
1.60 avankest 957: <p>When invoked, the user agent <em class="ct">must</em> run
1.58 avankest 958: the following steps:</p>
959:
960: <ol>
1.86 avankest 961: <li><p>If the state is not <span title="LOADING state">LOADING</span> or
962: <span title="DONE state">DONE</span> the user agent
1.58 avankest 963: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1.76 avankest 964: exception and abort these steps.</p></li>
1.58 avankest 965:
1.76 avankest 966: <li><p>The user agent <em class="ct">must</em> return all the HTTP
967: headers, as a single string, with each header line separated by a U+000D
968: CR U+000A LF pair excluding the status line.</p></li>
1.58 avankest 969: </ol>
1.24 avankest 970:
1.5 avankest 971: <div class="example">
1.58 avankest 972: <pre><code>// The following script:
1.5 avankest 973: var client = new XMLHttpRequest();
1.14 avankest 974: client.open("GET", "test.txt", true);
1.5 avankest 975: client.send();
1.12 avankest 976: client.onreadystatechange = function() {
1.13 avankest 977: if(this.readyState == 3) {
1.12 avankest 978: print(this.getAllResponseHeaders());
979: }
980: }
1.5 avankest 981:
982: // ...should output something similar to the following text:
983: Date: 2004年10月24日 04:58:38 GMT
984: Server: Apache/1.3.31 (Unix)
985: Keep-Alive: timeout=15, max=99
986: Connection: Keep-Alive
987: Transfer-Encoding: chunked
1.58 avankest 988: Content-Type: text/plain; charset=utf-8</code></pre>
1.5 avankest 989: </div>
990: </dd>
1.12 avankest 991:
1.18 avankest 992: <dt><dfn id="dfn-getresponseheader" title="getresponseheader"><code>getResponseHeader(<var>header</var>)</code></dfn>,
1.22 avankest 993: method</dt>
1.12 avankest 994:
1.1 avankest 995: <dd>
1.58 avankest 996: <p>When the method is invoked, the user agent <em class="ct">must</em> run
997: the following steps:</p>
1.14 avankest 998:
1.58 avankest 999: <ol>
1.86 avankest 1000: <li><p>If the state is not <span title="LOADING state">LOADING</span> or
1001: <span title="DONE state">DONE</span> the user agent
1.58 avankest 1002: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1.76 avankest 1003: exception and abort these steps.</p></li>
1.58 avankest 1004:
1.76 avankest 1005: <li><p>If the <var>header</var> argument doesn't match the
1.58 avankest 1006: <span><code>field-name</code> production</span> the user agent
1007: <em class="ct">must</em> raise a <code>SYNTAX_ERR</code> exception and
1.76 avankest 1008: abort these steps.</p></li>
1.58 avankest 1009:
1.80 avankest 1010: <li><p>If the <var>header</var> argument
1011: <span title="case-insensitive match">case-insensitively matches</span>
1.76 avankest 1012: multiple HTTP headers for the last request sent the user agent
1.58 avankest 1013: <em class="ct">must</em> return the values of these headers as a single
1.77 avankest 1014: concatenated string separated from each other by an U+002C COMMA followed
1.76 avankest 1015: by an U+0020 SPACE and abort these steps.</p></li>
1.58 avankest 1016:
1.80 avankest 1017: <li><p>If the <var>header</var> argument
1018: <span title="case-insensitive match">case-insensitively matches</span> a
1.76 avankest 1019: single HTTP header for the last request sent the user agent
1.58 avankest 1020: <em class="ct">must</em> return the value of that header and abort these
1.76 avankest 1021: steps.</p></li>
1.58 avankest 1022:
1.76 avankest 1023: <li><p>The method <em class="ct">must</em> return
1024: <code>null</code>.</p></li>
1.58 avankest 1025: </ol>
1.12 avankest 1026:
1.1 avankest 1027: <div class="example">
1.58 avankest 1028: <pre><code>// The following script:
1.1 avankest 1029: var client = new XMLHttpRequest();
1.14 avankest 1030: client.open("GET", "test.txt", true);
1.5 avankest 1031: client.send();
1.12 avankest 1032: client.onreadystatechange = function() {
1.13 avankest 1033: if(this.readyState == 3) {
1.14 avankest 1034: print(client.getResponseHeader("Content-Type"));
1.12 avankest 1035: }
1036: }
1.1 avankest 1037:
1.5 avankest 1038: // ...should output something similar to the following text:
1.58 avankest 1039: Content-Type: text/plain; charset=utf-8</code></pre>
1.1 avankest 1040: </div>
1.5 avankest 1041: </dd>
1.12 avankest 1042:
1.5 avankest 1043: <dt><dfn id="dfn-responsetext"><code>responseText</code></dfn> of type
1.22 avankest 1044: <code>DOMString</code>, readonly</dt>
1.12 avankest 1045:
1.5 avankest 1046: <dd>
1.88 avankest 1047: <p>On getting, the user agent <em class="ct">must</em> run the following
1048: steps:</p>
1049:
1050: <ol>
1051: <li><p>If the state is not <span title="LOADING state">LOADING</span> or
1052: <span title="DONE state">DONE</span>, the user agent
1053: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1054: exception and abort these steps.</p></li>
1.12 avankest 1055:
1.88 avankest 1056: <li><p>Return the <span>text response entity body</span>.</p></li>
1057: </ol>
1.5 avankest 1058: </dd>
1.12 avankest 1059:
1.5 avankest 1060: <dt><dfn id="dfn-responsexml"><code>responseXML</code></dfn> of type
1.22 avankest 1061: <code>Document</code>, readonly</dt>
1.12 avankest 1062:
1.8 avankest 1063: <dd>
1.75 avankest 1064: <p>On getting, the user agent <em class="ct">must</em> run the following
1065: steps:</p>
1.79 avankest 1066:
1.75 avankest 1067: <ol>
1.79 avankest 1068: <li><p>If the state is not <span title="DONE state">DONE</span> the user
1069: agent <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1070: exception and abort these steps.</p></li>
1.75 avankest 1071:
1.88 avankest 1072: <li><p>Return the <span>XML response entity body</span>.</p></li>
1.75 avankest 1073: </ol>
1.5 avankest 1074: </dd>
1.12 avankest 1075:
1.22 avankest 1076: <dt><dfn id="dfn-status"><code>status</code></dfn> of type <code>unsigned
1077: short</code>, readonly</dt>
1.12 avankest 1078:
1.5 avankest 1079: <dd>
1.72 avankest 1080: <p>On getting, if available, it <em class="ct">must</em> return the HTTP
1081: status code sent by the server (typically <code>200</code> for a
1082: successful request). Otherwise, if not available, the user agent
1083: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1084: exception.</p>
1.12 avankest 1085: </dd>
1086:
1.5 avankest 1087: <dt><dfn id="dfn-statustext"><code>statusText</code></dfn> of type
1.22 avankest 1088: <code>DOMString</code>, readonly</dt>
1.12 avankest 1089:
1.5 avankest 1090: <dd>
1.72 avankest 1091: <p>On getting, if available, it <em class="ct">must</em> return the HTTP
1092: status text sent by the server (appears after the status code). Otherwise,
1093: if not available, the user agent <em class="ct">must</em> raise an
1094: <code>INVALID_STATE_ERR</code> exception.</p>
1.1 avankest 1095: </dd>
1096: </dl>
1.12 avankest 1097:
1.31 avankest 1098: <h3 id="events">Events for the <code title="">XMLHttpRequest</code>
1099: Object</h3>
1.12 avankest 1100:
1.1 avankest 1101: <p>These sections describe the various events that can be dispatched on the
1.22 avankest 1102: object implementing the <code>XMLHttpRequest</code> interface. For this
1103: version of the specification only one event is defined.</p>
1.12 avankest 1104:
1.1 avankest 1105: <dl>
1106: <dt><dfn id="dfn-readystatechange"><code>readystatechange</code></dfn></dt>
1.24 avankest 1107:
1.72 avankest 1108: <dd>When the user agent dispatches a <code title="">readystatechange</code>
1109: event (as indicated above) it <em class="ct">must not</em> bubble,
1110: <em class="ct">must not</em> be cancelable and <em class="ct">must</em>
1111: implement the <code>Event</code> interface. Its <code>namespaceURI</code>
1112: attribute <em class="ct">must</em> be <code>null</code>.
1113: [<cite><span>DOM3Events</span></cite>]</dd>
1.1 avankest 1114: </dl>
1.32 avankest 1115:
1.31 avankest 1116: <h3 id="exceptions">Exceptions for the <code title="">XMLHttpRequest</code>
1117: Object</h3>
1118:
1.32 avankest 1119: <pre class="idl">exception <dfn>XMLHttpRequestException</dfn> {
1.31 avankest 1120: unsigned short code;
1121: };
1122: const unsigned short <span>NETWORK_ERR</span> = 101;</pre>
1123:
1.33 avankest 1124: <p>The <dfn id="network-err"><code>NETWORK_ERR</code></dfn> exception is
1125: thrown when a network error occurs in synchronous requests. See the section
1126: on <code>send()</code> for more details.</p>
1.11 avankest 1127:
1.29 avankest 1128: <h2 class="no-num" id="notcovered">Not in this Specification</h2>
1129:
1130: <p><em>This section is non normative.</em></p>
1131:
1.72 avankest 1132: <p>This specification does not include the following features which are
1133: being considered for a future version of this specification:</p>
1.29 avankest 1134:
1135: <ul>
1136: <li><code>load</code> event and <code>onload</code> attribute;</li>
1137: <li><code>error</code> event and <code>onerror</code> attribute;</li>
1138: <li><code>progress</code> event and <code>onprogress</code> attribute;</li>
1139: <li><code title="">abort</code> event and <code>onabort</code> attribute;</li>
1140: <li>Timers have been suggested, perhaps an <code>ontimeout</code>
1141: attribute;</li>
1142: <li>Property to disable following redirects;</li>
1.30 avankest 1143: <li><code title="">responseXML</code> for <code>text/html</code>
1144: documents;</li>
1.40 avankest 1145: <li>Cross-site <code title="">XMLHttpRequest</code>;</li>
1.87 avankest 1146: <li><code>responseBody</code> to deal with byte streams;</li>
1147: <li><code>getRequestHeader()</code> and
1148: <code>removeRequestHeader()</code>.</li>
1.29 avankest 1149: </ul>
1150:
1.1 avankest 1151: <h2 class="no-num" id="bibref">References</h2>
1.11 avankest 1152:
1.6 avankest 1153: <dl>
1.37 avankest 1154: <dt>[<dfn id="DOM3">DOM3Core</dfn>]</dt>
1.24 avankest 1155:
1.11 avankest 1156: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-3-Core">Document Object
1.92 avankest 1157: Model (DOM) Level 3 Core Specification</a></cite>, A. Le Hors, P. Le
1158: Hégaret, L. Wood, G. Nicol, J. Robie, M. Champion, S. Byrne, editors. World
1159: Wide Web Consortium, April 2004.</dd>
1.11 avankest 1160:
1.37 avankest 1161: <dt>[<dfn id="DOM3EV">DOM3Events</dfn>]</dt>
1.24 avankest 1162:
1.92 avankest 1163: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-3-Events/">Document
1164: Object Model (DOM) Level 3 Events Specification</a></cite>, Björn Höhrmann,
1165: editor. World Wide Web Consortium, April 2006.</dd>
1.11 avankest 1166:
1.37 avankest 1167: <dt>[<dfn id="ref-ecmascript">ECMAScript</dfn>]</dt>
1.24 avankest 1168:
1.92 avankest 1169: <dd><cite><a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript
1170: Language Specification</a></cite>, Third Edition. ECMA, December 1999.</dd>
1.14 avankest 1171:
1.37 avankest 1172: <dt>[<dfn id="ref-rfc2046">RFC2046</dfn>]</dt>
1.24 avankest 1173:
1.19 avankest 1174: <dd><cite><a href="http://ietf.org/rfc/rfc2046">Multipurpose Internet Mail
1.92 avankest 1175: Extensions (MIME) Part Two: Media Types</a></cite>, N. Freed, N.
1176: Borenstein, editors. IETF, November 1996.</dd>
1.14 avankest 1177:
1.37 avankest 1178: <dt>[<dfn id="RFC2119">RFC2119</dfn>]</dt>
1.24 avankest 1179:
1.92 avankest 1180: <dd><cite><a href="http://ietf.org/rfc/rfc2119">RFC 2119: Key words for use
1181: in RFCs to Indicate Requirement Levels</a></cite>, S. Bradner. IETF, March
1182: 1997.</dd>
1.12 avankest 1183:
1.37 avankest 1184: <dt>[<dfn id="RFC2616">RFC2616</dfn>]</dt>
1.24 avankest 1185:
1.11 avankest 1186: <dd><cite><a href="http://ietf.org/rfc/rfc2616">Hypertext Transfer Protocol
1.92 avankest 1187: -- HTTP/1.1</a></cite>, R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L.
1188: Masinter, P. Leach, T. Berners-Lee, editors. IETF, June 1999.</dd>
1.12 avankest 1189:
1.37 avankest 1190: <dt>[<dfn id="ref-rfc2617">RFC2617</dfn>]</dt>
1.24 avankest 1191:
1.11 avankest 1192: <dd><cite><a href="http://ietf.org/rfc/rfc2617">HTTP Authentication: Basic
1.92 avankest 1193: and Digest Access Authentication</a></cite>, P. Hallam-Baker, J.
1194: Hostetler, S. Lawrence, P. Leach, A. Luotonen, L. Stewart, editors. IETF,
1195: June 1999.</dd>
1.12 avankest 1196:
1.37 avankest 1197: <dt>[<dfn id="ref-rfc2965">RFC2965</dfn>]</dt>
1.24 avankest 1198:
1.19 avankest 1199: <dd><cite><a href="http://ietf.org/rfc/rfc2965">HTTP State Management
1.92 avankest 1200: Mechanism</a></cite>, D. Kristol, L. Montulli, editors. IETF, October
1201: 2000.</dd>
1.19 avankest 1202:
1.37 avankest 1203: <dt>[<dfn id="ref-rfc3986">RFC3986</dfn>]</dt>
1.24 avankest 1204:
1.11 avankest 1205: <dd><cite><a href="http://ietf.org/rfc/rfc3986">Uniform Resource Identifier
1.92 avankest 1206: (URI): Generic Syntax</a></cite>, T. Berners-Lee, R. Fielding, L. Masinter,
1207: editors. IETF, January 2005.</dd>
1.28 avankest 1208:
1.92 avankest 1209: <dt>[<dfn id="ref-window">Window</dfn>]</dt>
1.28 avankest 1210:
1.92 avankest 1211: <dd><cite><a href="http://www.w3.org/TR/Window/">Window Object
1212: 1.0</a></cite>, I. Davis, M. Stachowiak, editors. W3C, April 2006.</dd>
1.41 avankest 1213:
1.92 avankest 1214: <dt>[<dfn id="ref-xml">XML</dfn>]</dt>
1.41 avankest 1215:
1.92 avankest 1216: <dd><cite><a href="http://www.w3.org/TR/xml/">Extensible Markup Language
1217: (XML) 1.0 (Fourth Edition)</a></cite>, T. Bray, J. Paoli, C.
1218: Sperberg-McQueen, E. Maler, F. Yergeau. W3C, September 2006.</dd>
1.41 avankest 1219:
1.92 avankest 1220: <dt>[<dfn id="ref-xmlns">XMLNS</dfn>]</dt>
1.41 avankest 1221:
1.92 avankest 1222: <dd><cite><a href="http://www.w3.org/TR/xml-names/">Namespaces in XML
1223: (Second Edition)</a></cite>, T. Bray, D. Hollander, A. Layman, R. Tobin.
1224: W3C, August 2006.</dd>
1.1 avankest 1225: </dl>
1.11 avankest 1226:
1.1 avankest 1227: <h2 class="no-num" id="acknowledgements">Acknowledgements</h2>
1.11 avankest 1228:
1.1 avankest 1229: <p><em>This section is non-normative</em></p>
1.12 avankest 1230:
1.7 avankest 1231: <p>The editor would like to thank to the following people who have contributed
1.33 avankest 1232: to this specification (ordered by first name):</p>
1.12 avankest 1233:
1.1 avankest 1234: <ul>
1.22 avankest 1235: <li>Alex Hopmann</li>
1.7 avankest 1236: <li>Alex Vincent</li>
1.15 avankest 1237: <li>Alexey Proskuryakov</li>
1.1 avankest 1238: <li>Asbjørn Ulsberg</li>
1239: <li>Boris Zbarsky</li>
1240: <li>Björn Höhrmann</li>
1241: <li>Cameron McCormack</li>
1242: <li>Christophe Jolif</li>
1243: <li>Charles McCathieNevile</li>
1.54 avankest 1244: <li>Dan Winship</li>
1.72 avankest 1245: <li>David Håsäther</li>
1.1 avankest 1246: <li>Dean Jackson</li>
1247: <li>Doug Schepers</li>
1248: <li>Douglas Livingstone</li>
1249: <li>Gorm Haug Eriksen</li>
1250: <li>Hallvord R. M. Steen</li>
1251: <li>Håkon Wium Lie</li>
1252: <li>Ian Davis</li>
1253: <li>Ian Hickson</li>
1254: <li>Ivan Herman</li>
1255: <li>Jens Lindström</li>
1256: <li>Jim Deegan</li>
1257: <li>Jim Ley</li>
1258: <li>Jonas Sicking</li>
1259: <li>Julian Reschke</li>
1260: <li>Karl Dubost</li>
1261: <li>Maciej Stachowiak</li>
1.7 avankest 1262: <li>Magnus Kristiansen</li>
1.1 avankest 1263: <li>Marc Hadley</li>
1.53 avankest 1264: <li>Marcos Caceres</li>
1.87 avankest 1265: <li>Mark Baker</li>
1.1 avankest 1266: <li>Mark Nottingham</li>
1.92 avankest 1267: <li>Mohamed Zergaoui</li>
1.1 avankest 1268: <li>Pawel Glowacki</li>
1269: <li>Robin Berjon</li>
1270: <li>Ruud Steltenpool</li>
1.33 avankest 1271: <li>Simon Pieters</li>
1.1 avankest 1272: </ul>
1.12 avankest 1273:
1.1 avankest 1274: <p>Special thanks to the Microsoft employees who first implemented the
1.22 avankest 1275: <code>XMLHttpRequest</code> interface, which was first widely deployed by the
1276: Windows Internet Explorer browser.</p>
1.12 avankest 1277:
1.54 avankest 1278: <p>Special thanks also to the WHATWG for drafting an initial version of this
1.22 avankest 1279: specification in their Web Applications 1.0 document.</p>
1.12 avankest 1280:
1.1 avankest 1281: <p>Thanks also to all those who have helped to improve this specification by
1.22 avankest 1282: sending suggestions and corrections. (Please, keep bugging us with your
1283: issues!)</p>
1.1 avankest 1284: </body>
1285: </html>
1.92 avankest 1286:
Webmaster