Annotation of 2006/webapi/XMLHttpRequest/Overview.src.html, revision 1.334
1.248 avankest 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
1.1 avankest 2: <html lang="en-US">
3: <head>
1.207 avankest 4: <title>XMLHttpRequest</title>
1.16 avankest 5: <style type="text/css">
1.117 avankest 6: pre.idl { border:solid thin; background:#eee; color:#000; padding:0.5em }
1.16 avankest 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.203 avankest 12: .XXX { padding:.5em; border:solid #f00 }
13: p.XXX::before { content:"Issue: " }
1.119 avankest 14: dl.switch { padding-left:2em }
1.248 avankest 15: dl.switch > dt { text-indent:-1.5em }
16: dl.switch > dt:before { content:'21円AA'; padding:0 0.5em 0 0; display:inline-block; width:1em; text-align:right; line-height:0.5em }
1.269 avankest 17: dl.domintro { color: green; margin: 2em 0 2em 2em; padding: 0.5em 1em; border: none; background: #DDFFDD; }
18: dl.domintro dt, dl.domintro dt * { color: black; text-decoration: none; }
19: dl.domintro dd { margin: 0.5em 0 1em 2em; padding: 0; }
20: dl.domintro dd p { margin: 0.5em 0; }
21: dl.domintro:before { display: table; margin: -1em -0.5em -0.5em auto; width: auto; content: 'This box is non-normative. Implementation requirements are given below this box.'; color: red; border: solid 2px; background: white; padding: 0 0.25em; }
1.16 avankest 22: em.ct { text-transform:lowercase; font-variant:small-caps; font-style:normal }
23: dfn { font-weight:bold; font-style:normal }
24: code { color:orangered }
25: code :link, code :visited { color:inherit }
1.203 avankest 26: hr:not(.top) { display:block; background:none; border:none; padding:0; margin:2em 0; height:auto }
27: table { border-collapse:collapse; border-style:hidden hidden none hidden }
28: table thead { border-bottom:solid }
29: table tbody th:first-child { border-left:solid }
30: table td, table th { border-left:solid; border-right:solid; border-bottom:solid thin; vertical-align:top; padding:0.2em }
1.16 avankest 31: </style>
1.147 avankest 32: <link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-[STATUS]">
1.1 avankest 33: </head>
34: <body>
35: <div class="head">
1.330 avankest 36: <!--logo-->
1.12 avankest 37:
1.229 avankest 38: <h1 class="head" id="the-xmlhttprequest-object">XMLHttpRequest</h1>
1.248 avankest 39:
1.12 avankest 40:
1.149 avankest 41: <h2 class="no-num no-toc" id="w3c-doctype">[LONGSTATUS] [DATE: 3 August 2002]</h2>
1.12 avankest 42:
1.1 avankest 43: <dl>
1.10 avankest 44: <dt>This Version:</dt>
1.330 avankest 45: <dd class=dontpublish><a href="http://dev.w3.org/2006/webapi/XMLHttpRequest/">http://dev.w3.org/2006/webapi/XMLHttpRequest/</a></dd>
46: <dd class=publish><a href="[VERSION]">[VERSION]</a></dd>
1.14 avankest 47:
1.330 avankest 48: <dt class=publish>Latest Version:</dt>
49: <dd class=publish><a href="[LATEST]">[LATEST]</a></dd>
1.203 avankest 50:
1.333 avankest 51: <dt class=publish>Latest Editor Draft:</dt>
1.330 avankest 52: <dd class=publish><a href="http://dev.w3.org/2006/webapi/XMLHttpRequest/">http://dev.w3.org/2006/webapi/XMLHttpRequest/</a></dd>
1.14 avankest 53:
1.10 avankest 54: <dt>Previous Versions:</dt>
1.248 avankest 55:
1.291 avankest 56: <dd><a href="http://www.w3.org/TR/2010/CR-XMLHttpRequest-20100803/">http://www.w3.org/TR/2010/CR-XMLHttpRequest-20100803/</a></dd>
1.288 avankest 57: <dd><a href="http://www.w3.org/TR/2009/WD-XMLHttpRequest-20091119/">http://www.w3.org/TR/2009/WD-XMLHttpRequest-20091119/</a></dd>
1.231 avankest 58: <dd><a href="http://www.w3.org/TR/2009/WD-XMLHttpRequest-20090820/">http://www.w3.org/TR/2009/WD-XMLHttpRequest-20090820/</a></dd>
1.173 avankest 59: <dd><a href="http://www.w3.org/TR/2008/WD-XMLHttpRequest-20080415/">http://www.w3.org/TR/2008/WD-XMLHttpRequest-20080415/</a></dd>
1.154 avankest 60: <dd><a href="http://www.w3.org/TR/2007/WD-XMLHttpRequest-20071026/">http://www.w3.org/TR/2007/WD-XMLHttpRequest-20071026/</a></dd>
1.133 avankest 61: <dd><a href="http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070618/">http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070618/</a></dd>
1.58 avankest 62: <dd><a href="http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070227/">http://www.w3.org/TR/2007/WD-XMLHttpRequest-20070227/</a></dd>
1.22 avankest 63: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060927/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060927/</a></dd>
1.1 avankest 64: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/</a></dd>
65: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/</a></dd>
1.248 avankest 66:
67:
1.14 avankest 68:
1.1 avankest 69: <dt>Editor:</dt>
70: <dd><a href="http://annevankesteren.nl/">Anne van Kesteren</a>
71: (<a href="http://www.opera.com/">Opera Software ASA</a>)
72: <<a href="mailto:annevk@opera.com">annevk@opera.com</a>></dd>
73: </dl>
1.14 avankest 74:
1.330 avankest 75: <!--copyright-->
1.1 avankest 76: </div>
1.12 avankest 77:
1.1 avankest 78: <hr>
1.12 avankest 79:
1.1 avankest 80: <h2 class="no-num no-toc" id="specabstract">Abstract</h2>
1.10 avankest 81:
1.248 avankest 82:
83:
1.229 avankest 84: <p>The XMLHttpRequest specification defines an API
1.207 avankest 85: that provides scripted client functionality for transferring data between
86: a client and a server.</p>
1.248 avankest 87:
1.12 avankest 88:
1.1 avankest 89: <h2 class="no-num no-toc" id="sotd">Status of this Document</h2>
1.12 avankest 90:
1.1 avankest 91: <p><em>This section describes the status of this document at the time of its
1.36 avankest 92: publication. Other documents may supersede this document. A list of current
93: W3C publications and the latest revision of this technical report can be
94: found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a>
1.117 avankest 95: at http://www.w3.org/TR/.</em></p>
1.36 avankest 96:
1.330 avankest 97: <p>This is the [DATE: 3 August 2002] [LONGSTATUS] of
1.248 avankest 98: XMLHttpRequest. Please send comments to
99: <a href="mailto:public-webapps@w3.org?subject=[XHR]%20">public-webapps@w3.org</a>
1.207 avankest 100: (<a href="http://lists.w3.org/Archives/Public/public-webapps/">archived</a>)
1.248 avankest 101: with <samp>[XHR]</samp> at the start of the subject line.</p>
1.295 avankest 102:
1.287 avankest 103:
104: <p>For the last Last Call Working Draft the Working Group has kept a
105: <a href="http://dev.w3.org/2006/webapi/XMLHttpRequest/disposition-of-comments-3">disposition of comments</a>
1.290 avankest 106: document. A
107: <a href="http://dev.w3.org/cvsweb/2006/webapi/XMLHttpRequest/Overview.src.html">list of changes</a>
108: is available via a Web view of CVS. (Due to the way the document is edited
109: certain commit messages have introduced negligible changes to this
110: document and are in fact only relevant for XMLHttpRequest Level 2.)</p>
1.291 avankest 111:
1.51 avankest 112:
1.47 avankest 113: <p>This document is produced by the
1.248 avankest 114: <a href="http://www.w3.org/2008/webapps/">Web Applications</a> (WebApps) Working Group.
115: The WebApps Working Group is part of the
1.207 avankest 116: <a href="http://www.w3.org/2006/rwc/Activity">Rich Web Clients Activity</a>
1.248 avankest 117: in the W3C <a href="http://www.w3.org/Interaction/">Interaction Domain</a>.</p>
1.12 avankest 118:
1.1 avankest 119: <p>This document was produced by a group operating under the
1.248 avankest 120: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February 2004
121: W3C Patent Policy</a>. W3C maintains a
1.207 avankest 122: <a rel="disclosure" href="http://www.w3.org/2004/01/pp-impl/42538/status">public
1.248 avankest 123: list of any patent disclosures</a> made in connection with the deliverables of
124: the group; that page also includes instructions for disclosing a patent. An
125: individual who has actual knowledge of a patent which the individual believes
126: contains
1.36 avankest 127: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential
128: Claim(s)</a> must disclose the information in accordance with
129: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section
130: 6 of the W3C Patent Policy</a>.</p>
1.12 avankest 131:
1.291 avankest 132: <p>Publication as a Working Draft does not imply endorsement by the W3C
1.248 avankest 133: Membership. This is a draft document and may be updated, replaced or
134: obsoleted by other documents at any time. It is inappropriate to cite this
135: document as other than work in progress.</p>
1.295 avankest 136:
1.307 avankest 137:
1.268 avankest 138: <h3 class="no-num no-toc" id="crec">Candidate Recommendation Exit Criteria</h3>
139:
140: <p>To exit the Candidate Recommendation (CR) stage the following criteria
1.330 avankest 141: must have been met:</p>
1.268 avankest 142:
143: <ol>
144: <li>There will be at least two interoperable implementations passing all
1.286 avankest 145: test cases in the
146: <a href="http://test.w3.org/webapps/tests/XMLHttpRequest/info.htm">test suite</a>
147: for this specification. An implementation is to be available (i.e. for
148: download), shipping (i.e. not private), and not experimental (i.e.
149: intended for a wide audience). The working group will decide when the
1.290 avankest 150: test suite is of sufficient quality to test interoperability and will
151: produce implementation reports (hosted together with the test suite).</li>
1.268 avankest 152:
1.291 avankest 153: <li>A minimum of six months of the CR stage will have elapsed. This is to
1.268 avankest 154: ensure that enough time is given for any remaining major errors to be
155: caught. The CR period will be extended if implementations are slow to
1.291 avankest 156: appear.</li> <!-- XXX need to add date -->
1.282 avankest 157:
1.283 avankest 158: <li>Text, which can be in a separate document, exists that explains the
159: security considerations for this specification. This may be done in a
160: generic manner as they are most likely applicable to various APIs. The
161: working group will decide whether the text is of sufficient quality.</li>
1.268 avankest 162: </ol>
1.307 avankest 163:
1.207 avankest 164:
165:
1.1 avankest 166: <h2 class="no-num no-toc" id="toc">Table of Contents</h2>
1.21 avankest 167:
1.1 avankest 168: <!--toc-->
1.12 avankest 169:
1.207 avankest 170:
171:
1.1 avankest 172: <h2 id="introduction">Introduction</h2>
1.12 avankest 173:
1.1 avankest 174: <p><em>This section is non-normative.</em></p>
1.12 avankest 175:
1.183 avankest 176: <p>The <code>XMLHttpRequest</code> object implements an interface exposed
177: by a scripting engine that allows scripts to perform HTTP client
178: functionality, such as submitting form data or loading data from a
1.330 avankest 179: server. It is the ECMAScript HTTP API.
180: <span data-anolis-ref class=informative>ECMASCRIPT</span>
1.24 avankest 181:
1.1 avankest 182: <p>The name of the object is <code>XMLHttpRequest</code> for compatibility
1.183 avankest 183: with the Web, though each component of this name is potentially
184: misleading. First, the object supports any text based format, including
185: XML. Second, it can be used to make requests over both HTTP and HTTPS
186: (some implementations support protocols in addition to HTTP and HTTPS, but
187: that functionality is not covered by this specification). Finally, it
188: supports "requests" in a broad sense of the term as it pertains to HTTP;
189: namely all activity involved with HTTP requests or responses for the
190: defined HTTP methods.</p>
1.12 avankest 191:
1.14 avankest 192: <div class="example">
1.250 avankest 193: <p>Some simple code to do something with data from an XML document
194: fetched over the network:</p>
1.16 avankest 195:
1.308 avankest 196: <pre><code>function processData(data) {
1.312 avankest 197: // taking care of data
1.14 avankest 198: }
199:
200: function handler() {
1.312 avankest 201: if(this.readyState == this.DONE) {
202: if(this.status == 200 &&
203: this.responseXML != null &&
204: this.responseXML.getElementById('test').textContent) {
1.308 avankest 205: // success!
206: processData(this.responseXML.getElementById('test').textContent);
207: return;
208: }
1.312 avankest 209: // something went wrong
210: processData(null);
1.308 avankest 211: }
1.14 avankest 212: }
1.12 avankest 213:
1.14 avankest 214: var client = new XMLHttpRequest();
215: client.onreadystatechange = handler;
1.250 avankest 216: client.open("GET", "unicorn.xml");
1.58 avankest 217: client.send();</code></pre>
1.16 avankest 218:
1.56 avankest 219: <p>If you just want to log a message to the server:</p>
1.16 avankest 220:
1.58 avankest 221: <pre><code>function log(message) {
1.308 avankest 222: var client = new XMLHttpRequest();
223: client.open("POST", "/log");
224: client.setRequestHeader("Content-Type", "text/plain;charset=UTF-8");
225: client.send(message);
1.58 avankest 226: }</code></pre>
1.16 avankest 227:
1.14 avankest 228: <p>Or if you want to check the status of a document on the server:</p>
1.16 avankest 229:
1.58 avankest 230: <pre><code>function fetchStatus(address) {
1.308 avankest 231: var client = new XMLHttpRequest();
232: client.onreadystatechange = function() {
233: // in case of network errors this might not give reliable results
1.310 avankest 234: if(this.readyState == this.DONE)
1.308 avankest 235: returnStatus(this.status);
236: }
237: client.open("HEAD", address);
238: client.send();
1.58 avankest 239: }</code></pre>
1.14 avankest 240: </div>
1.12 avankest 241:
1.203 avankest 242:
243:
1.248 avankest 244:
1.324 avankest 245: <h2 id="conformance">Conformance</h2>
1.12 avankest 246:
1.27 avankest 247: <p>Everything in this specification is normative except for diagrams,
248: examples, notes and sections marked non-normative.</p>
1.12 avankest 249:
1.330 avankest 250: <p>The key words must, must not, should, should not and may in this
251: document are to be interpreted as described in RFC 2119.
252: <span data-anolis-ref>RFC2119</span></p>
1.12 avankest 253:
1.299 avankest 254: <p>This specification defines a single conformance class:</p>
1.12 avankest 255:
1.1 avankest 256: <dl>
1.74 avankest 257: <dt><dfn id="conforming-user-agent">Conforming user agent</dfn></dt>
1.24 avankest 258:
1.74 avankest 259: <dd>
1.330 avankest 260: <p>A user agent must behave as described in this
1.106 avankest 261: specification in order to be considered conformant.</p>
1.95 avankest 262:
1.330 avankest 263: <p>User agents may implement algorithms given in
1.140 avankest 264: this specification in any way desired, so long as the end result is
265: indistinguishable from the result that would be obtained by the
266: specification's algorithms.</p>
1.110 avankest 267:
1.95 avankest 268: <p class="note">This specification uses both the terms "conforming user
269: agent(s)" and "user agent(s)" to refer to this product class.</p>
1.74 avankest 270: </dd>
1.1 avankest 271: </dl>
1.32 avankest 272:
1.153 avankest 273: <h3 id="dependencies">Dependencies</h3>
1.33 avankest 274:
1.29 avankest 275: <p>This specification relies on several underlying specifications.</p>
1.248 avankest 276:
1.29 avankest 277: <dl>
1.248 avankest 278:
279:
1.323 avankest 280: <dt>DOM Core</dt>
1.330 avankest 281: <dd><p>A <span>conforming user agent</span> must
1.323 avankest 282: support at least the subset of the functionality defined in DOM Core that
283: this specification relies upon, such as various exceptions and
1.330 avankest 284: <code data-anolis-spec=domcore>EventTarget</code>. <span data-anolis-ref>DOMCORE</span></p></dd>
1.29 avankest 285:
1.330 avankest 286: <dt>File API</dt>
287: <dd><p>A <span>conforming user agent</span> must
288: support at least the subset of the functionality defined in File API that
289: this specification relies upon, such as the <code data-anolis-spec=fileapi>Blob</code> and
290: <code data-anolis-spec=fileapi>File</code> interfaces. <span data-anolis-ref>FILEAPI</span></p>
1.310 avankest 291:
292:
1.322 avankest 293: <dt>HTML</dt>
1.330 avankest 294: <dd><p>A <span>conforming user agent</span> must
295: support at least the subset of the functionality defined in HTML that
296: this specification relies upon, such as the basics of the
297: <code data-anolis-spec=html>Window</code> object and serializing a <code data-anolis-spec=domcore>Document</code>
298: object. <span data-anolis-ref>HTML</span>
1.161 avankest 299:
1.29 avankest 300: <dt>HTTP</dt>
1.330 avankest 301: <dd><p>A <span>conforming user agent</span> must
1.299 avankest 302: support some version of the HTTP protocol. Requirements regarding HTTP
1.330 avankest 303: are made throughout the specification. <span data-anolis-ref>HTTP</span>
304:
305:
1.189 avankest 306:
1.181 avankest 307: <dt>Web IDL</dt>
1.330 avankest 308: <dd><p>A <span>conforming user agent</span> must also
1.248 avankest 309: be a conforming implementation of the IDL fragments in this
310: specification, as described in the Web IDL specification.
1.330 avankest 311: <span data-anolis-ref>WEBIDL</span>
1.248 avankest 312:
1.299 avankest 313: <dt>XML</dt>
1.330 avankest 314: <dd><p>A <span>conforming user agent</span> must be a
1.299 avankest 315: conforming XML processor that reports violations of namespace
1.330 avankest 316: well-formedness. <span data-anolis-ref>XML</span>
317: <span data-anolis-ref>XMLNS</span>
1.29 avankest 318: </dl>
1.12 avankest 319:
1.157 avankest 320:
1.324 avankest 321: <h3 id="extensibility">Extensibility</h3>
322:
323: <p>User agents, Working Groups, and other interested parties are
324: <em>strongly encouraged</em> to discuss extensions on a relevant public
325: forum, preferably
326: <a href="mailto:public-webapps@w3.org">public-webapps@w3.org</a>. If this
327: is for some reason not possible prefix the extension in some way and start
328: the prefix with an uppercase letter. E.g. if company Foo wants to add a
329: private method <code>bar()</code> it could be named <code>FooBar()</code>
330: to prevent clashes with a potential future standardized
331: <code>bar()</code>.</p>
332:
333:
334:
335: <h2 id="terminology">Terminology</h2>
1.209 avankest 336:
1.248 avankest 337:
1.292 avankest 338:
1.258 avankest 339: <p>To <dfn>deflate a DOMString into a byte sequence</dfn> means to create
1.330 avankest 340: a sequence of bytes such that the <var title>n</var>th byte of the
341: sequence is equal to the low-order byte of the <var title>n</var>th
1.258 avankest 342: code point in the original DOMString.</p>
343:
344: <p>To <dfn>inflate a byte sequence into a DOMString</dfn> means to create
1.330 avankest 345: a DOMString such that the <var title>n</var>th code point has 0x00 as
346: the high-order byte and the <var title>n</var>th byte of the byte
1.258 avankest 347: sequence as the low-order byte.</p>
1.256 avankest 348:
1.203 avankest 349:
1.248 avankest 350:
1.334 ! avankest 351: <h2>Interface <code title>XMLHttpRequest</code></h2>
1.12 avankest 352:
1.320 avankest 353: <p>The <code>XMLHttpRequest</code> object can be used by scripts to issue
354: HTTP requests.</p>
1.12 avankest 355:
1.228 avankest 356: <pre class="idl">[NoInterfaceObject]
1.330 avankest 357: interface <dfn id="xmlhttprequesteventtarget">XMLHttpRequestEventTarget</dfn> : <span data-anolis-spec=domcore>EventTarget</span> {
1.228 avankest 358: // for future use
359: };
360:
1.240 avankest 361: [<span title="dom-XMLHttpRequest">Constructor</span>]
1.228 avankest 362: interface <dfn id="xmlhttprequest">XMLHttpRequest</dfn> : <span>XMLHttpRequestEventTarget</span> {
1.330 avankest 363: // <a href="#event-handlers">event handler</a>
364: attribute <span data-anolis-spec=html>Function</span> <span title="handler-xhr-onreadystatechange">onreadystatechange</span>;
1.58 avankest 365:
1.205 avankest 366: // <a href="#states">states</a>
1.272 avankest 367: const unsigned short <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span> = 0;
368: const unsigned short <span title="dom-XMLHttpRequest-OPENED">OPENED</span> = 1;
369: const unsigned short <span title="dom-XMLHttpRequest-HEADERS_RECEIVED">HEADERS_RECEIVED</span> = 2;
370: const unsigned short <span title="dom-XMLHttpRequest-LOADING">LOADING</span> = 3;
371: const unsigned short <span title="dom-XMLHttpRequest-DONE">DONE</span> = 4;
1.277 avankest 372: readonly attribute unsigned short <span title="dom-XMLHttpRequest-readyState">readyState</span>;
1.58 avankest 373:
1.205 avankest 374: // <a href="#request">request</a>
1.330 avankest 375: void <span title="dom-XMLHttpRequest-open">open</span>(DOMString <var>method</var>, DOMString <var title>url</var>);
376: void <span title="dom-XMLHttpRequest-open">open</span>(DOMString <var>method</var>, DOMString <var title>url</var>, boolean <var>async</var>);
377: void <span title="dom-XMLHttpRequest-open">open</span>(DOMString <var>method</var>, DOMString <var title>url</var>, boolean <var>async</var>, DOMString? <var>user</var>);
378: void <span title="dom-XMLHttpRequest-open">open</span>(DOMString <var>method</var>, DOMString <var title>url</var>, boolean <var>async</var>, DOMString? <var>user</var>, DOMString? <var>password</var>);
1.279 avankest 379: void <span title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader</span>(DOMString <var>header</var>, DOMString <var>value</var>);
1.271 avankest 380: void <span title="dom-XMLHttpRequest-send">send</span>();
1.330 avankest 381: void <span title="dom-XMLHttpRequest-send">send</span>(<span data-anolis-spec=domcore>Document</span> <var>data</var>);
1.271 avankest 382: void <span title="dom-XMLHttpRequest-send">send</span>([AllowAny] DOMString? <var>data</var>);
1.275 avankest 383: void <span title="dom-XMLHttpRequest-abort">abort</span>();
1.58 avankest 384:
1.205 avankest 385: // <a href="#response">response</a>
1.276 avankest 386: readonly attribute unsigned short <span title="dom-XMLHttpRequest-status">status</span>;
387: readonly attribute DOMString <span title="dom-XMLHttpRequest-statusText">statusText</span>;
1.278 avankest 388: DOMString <span title="dom-XMLHttpRequest-getResponseHeader">getResponseHeader</span>(DOMString <var>header</var>);
389: DOMString <span title="dom-XMLHttpRequest-getAllResponseHeaders">getAllResponseHeaders</span>();
1.276 avankest 390: readonly attribute DOMString <span title="dom-XMLHttpRequest-responseText">responseText</span>;
1.305 avankest 391: readonly attribute <span>Document</span> <span title="dom-XMLHttpRequest-responseXML">responseXML</span>;
1.228 avankest 392: };</pre>
1.8 avankest 393:
1.235 avankest 394:
1.124 avankest 395:
1.334 ! avankest 396: <h3>Origin and base URL</h3>
1.203 avankest 397:
398: <p>Each <code>XMLHttpRequest</code> object has an associated
1.332 avankest 399: <dfn><code>XMLHttpRequest</code> origin</dfn> and an
400: <dfn><code>XMLHttpRequest</code> base URL</dfn>.
1.203 avankest 401:
402: <p>This specification defines their values when the global object is
1.332 avankest 403: represented by the <code data-anolis-spec=html>Window</code> object. When
404: the <code>XMLHttpRequest</code> object is used in other contexts their
405: values will have to be defined as appropriate for that context. That is
1.203 avankest 406: considered to be out of scope for this specification.</p>
407:
408: <p>In environments where the global object is represented by the
1.332 avankest 409: <code data-anolis-spec=html>Window</code> object the
410: <code>XMLHttpRequest</code> object has an associated
411: <dfn><code>XMLHttpRequest</code> <code>Document</code></dfn> which is the
412: <code data-anolis-spec=domcore>Document</code> object associated with the
413: <code data-anolis-spec=html>Window</code> object for which the
414: <code>XMLHttpRequest</code> interface object was created.</p>
1.203 avankest 415:
416: <p class="note">The
417: <span><code>XMLHttpRequest</code> <code>Document</code></span> is used to
418: determine the <span><code>XMLHttpRequest</code> origin</span> and
419: <span><code>XMLHttpRequest</code> base URL</span> at a later stage.</p>
420:
421:
1.263 avankest 422:
1.334 ! avankest 423: <h3>Task sources</h3>
1.218 avankest 424:
1.330 avankest 425: <p>The <span data-anolis-spec=html>task source</span> used by this
426: specification is the <dfn><code>XMLHttpRequest</code> task source</dfn>.
1.203 avankest 427:
428:
1.211 avankest 429: <h3 id="constructors">Constructors</h3>
1.203 avankest 430:
1.263 avankest 431:
432:
1.270 avankest 433: <dl class="domintro">
1.330 avankest 434: <dt><var title>client</var> = new <code title="dom-XMLHttpRequest">XMLHttpRequest</code>()</dt>
1.270 avankest 435: <dd>Returns a new <code>XMLHttpRequest</code> object.</dd>
436:
437: </dl>
1.295 avankest 438:
1.203 avankest 439: <p>When the
1.332 avankest 440: <dfn title="dom-XMLHttpRequest"><code>XMLHttpRequest()</code></dfn>
441: constructor is invoked, the user agent must return a new
442: <code>XMLHttpRequest</code> object.</p>
1.203 avankest 443:
1.263 avankest 444:
1.203 avankest 445:
1.334 ! avankest 446: <h3 id="event-handlers">Event handlers</h3>
1.205 avankest 447:
1.248 avankest 448:
449:
1.205 avankest 450: <p>The following is the
1.332 avankest 451: <span data-anolis-spec=html title="event handlers">event handler</span>
452: (and its corresponding
453: <span data-anolis-spec=html>event handler event type</span>) that must be
454: supported as attribute by the
1.205 avankest 455: <code>XMLHttpRequest</code> object:</p>
456:
457: <table>
458: <thead>
459: <tr>
1.330 avankest 460: <th><span data-anolis-spec=html title="event handlers">event handler</span>
461: <th><span data-anolis-spec=html>event handler event type</span>
1.205 avankest 462: <tbody>
463: <tr>
1.332 avankest 464: <td><dfn title="handler-xhr-onreadystatechange"><code>onreadystatechange</code></dfn>
1.273 avankest 465: <td><code title="event-xhr-readystatechange">readystatechange</code></td>
1.205 avankest 466: </table>
467:
468:
469: <h3 id="states">States</h3>
1.295 avankest 470:
1.277 avankest 471: <dl class="domintro">
1.330 avankest 472: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-readyState">readyState</code></dt>
1.277 avankest 473: <dd><p>Returns the current state.</p></dd>
474: </dl>
1.203 avankest 475:
476: <p>The <code>XMLHttpRequest</code> object can be in several states. The
1.332 avankest 477: <dfn title="dom-XMLHttpRequest-readyState"><code>readyState</code></dfn>
478: attribute must return the current state, which must be one of the
479: following values:</p>
1.203 avankest 480:
481: <dl>
1.332 avankest 482: <dt><dfn title="dom-XMLHttpRequest-UNSENT"><code>UNSENT</code></dfn>
1.203 avankest 483: (numeric value 0)</dt>
484: <dd><p>The object has been constructed.</p></dd>
485:
1.332 avankest 486: <dt><dfn title="dom-XMLHttpRequest-OPENED"><code>OPENED</code></dfn>
1.203 avankest 487: (numeric value 1)</dt>
1.274 avankest 488: <dd><p>The <code title="dom-XMLHttpRequest-open">open()</code> method has been successfully invoked.
1.203 avankest 489: During this state request headers can be set using
1.279 avankest 490: <code title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader()</code>
491: and the request can be made using the
1.271 avankest 492: <code title="dom-XMLHttpRequest-send">send()</code> method.</p></dd>
1.203 avankest 493:
1.332 avankest 494: <dt><dfn title="dom-XMLHttpRequest-HEADERS_RECEIVED"><code>HEADERS_RECEIVED</code></dfn>
1.203 avankest 495: (numeric value 2)</dt>
1.257 avankest 496: <dd><p>All redirects (if any) have been followed and all HTTP headers of
497: the final response have been received. Several response members of the
498: object are now available.</p></dd>
1.203 avankest 499:
1.332 avankest 500: <dt><dfn title="dom-XMLHttpRequest-LOADING"><code>LOADING</code></dfn>
1.203 avankest 501: (numeric value 3)</dt>
502: <dd><p>The <span>response entity body</span> is being received.</p></dd>
503:
1.332 avankest 504: <dt><dfn title="dom-XMLHttpRequest-DONE"><code>DONE</code></dfn>
1.203 avankest 505: (numeric value 4)</dt>
506: <dd><p>The data transfer has been completed or something went wrong
507: during the transfer (e.g. infinite redirects).</p></dd>
508: </dl>
509:
1.272 avankest 510: <p>The <span title="dom-XMLHttpRequest-OPENED">OPENED</span> state has an associated
1.203 avankest 511: <dfn id="send-flag"><code>send()</code> flag</dfn> that indicates whether
1.271 avankest 512: the <code title="dom-XMLHttpRequest-send">send()</code> method has been
513: invoked. It can be either true or false and has an initial value of
514: false.</p>
1.203 avankest 515:
1.310 avankest 516: <p>The <dfn id="error-flag">error flag</dfn> indicates some type of
517: network error or abortion. It is used during the
518: <span title="dom-XMLHttpRequest-DONE">DONE</span> state. It can be either
519: true or false and has an initial value of false.</p>
1.203 avankest 520:
521:
1.205 avankest 522: <h3 id="request">Request</h3>
1.203 avankest 523:
524: <p>The <code>XMLHttpRequest</code> object holds the following request
525: metadata variables:</p>
526:
1.204 avankest 527: <dl>
528: <dt>The <dfn>asynchronous flag</dfn></dt>
1.332 avankest 529: <dd>True when <span data-anolis-spec=html title=fetch>fetching</span> is
530: done asychronously. False when fetching is done synchronously.</dd>
1.204 avankest 531:
532: <dt>The <dfn>request method</dfn></dt>
1.310 avankest 533: <dd>The HTTP method used in the request.</dd>
1.204 avankest 534:
535: <dt>The <dfn>request URL</dfn></dt>
1.330 avankest 536: <dd>The resolved <span data-anolis-spec=html>URL</span> used in the
537: request.</dd>
1.218 avankest 538:
1.204 avankest 539: <dt>The <dfn>request username</dfn></dt>
540: <dd>The username used in the request or null if there is no
541: username.</dd>
1.218 avankest 542:
1.204 avankest 543: <dt>The <dfn>request password</dfn></dt>
544: <dd>The password used in the request or null if there is no
545: password.</dd>
1.218 avankest 546:
1.204 avankest 547: <dt>The <dfn id="author-request-headers">author request headers</dfn></dt>
548: <dd>A list consisting of HTTP header name/value pairs to be used in the
549: request.</p>
1.203 avankest 550:
1.204 avankest 551: <dt>The <dfn>request entity body</dfn></dt>
1.330 avankest 552: <dd>The <span data-anolis-spec=http>entity body</span> used in the
553: request or null if there is no
554: <span data-anolis-spec=http>entity body</span>.</dd>
1.295 avankest 555:
1.248 avankest 556:
1.204 avankest 557: </dl>
1.203 avankest 558:
1.248 avankest 559:
560:
1.203 avankest 561:
1.330 avankest 562: <h4>The <code title>open()</code> method</h4>
1.295 avankest 563:
1.269 avankest 564: <dl class="domintro">
1.330 avankest 565: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-open">open(<var title>method</var>,
566: <var title>url</var>, <var title>async</var>, <var title>user</var>,
567: <var title>password</var>)</code></dt>
1.269 avankest 568:
1.280 avankest 569: <dd>
570: <p>Sets the <span>request method</span>, <span>request URL</span>,
571: <span>asynchronous flag</span>, <span>request username</span>, and
572: <span>request password</span>.</p>
1.295 avankest 573:
1.330 avankest 574: <p>Throws a <code data-anolis-spec=domcore title=dom-DOMException-SYNTAX_ERR>SYNTAX_ERR</code> exception if one of the following is
1.280 avankest 575: true:</p>
1.295 avankest 576:
1.280 avankest 577: <ul>
1.330 avankest 578: <li><var title>method</var> is not a valid HTTP method.</li>
579: <li><var title>url</var> cannot be resolved.</li>
580: <li><var title>url</var> contains the <code>"user:password"</code>
581: format in the <code data-anolis-spec=uri>userinfo</code> production.
1.280 avankest 582: </ul>
1.295 avankest 583:
1.330 avankest 584: <p>Throws a <code data-anolis-spec=domcore title=dom-DOMException-SECURITY_ERR>SECURITY_ERR</code> exception if
585: <var title>method</var> is a case-insensitive match for
1.280 avankest 586: <code>CONNECT</code>, <code>TRACE</code> or <code>TRACK</code>.</p>
1.295 avankest 587:
1.330 avankest 588: <p>Throws an <code data-anolis-spec=domcore title=dom-DOMException-INVALID_ACCESS_ERR>INVALID_ACCESS_ERR</code> exception if either
589: <var title>user</var> or <var title>password</var> is passed as
590: argument and the <span data-anolis-spec=html>origin</span> of <var title>url</var> does not
1.300 avankest 591: match the <span><code>XMLHttpRequest</code> origin</span>.</p>
1.280 avankest 592: </dd>
1.269 avankest 593: </dl>
1.88 avankest 594:
1.274 avankest 595: <p>When the
1.330 avankest 596: <dfn id="dom-xmlhttprequest-open" title="dom-XMLHttpRequest-open"><code>open(<var title>method</var>, <var title>url</var>, <var title>async</var>, <var title>user</var>, <var title>password</var>)</code></dfn>
597: method is invoked, the user agent must run these steps
1.274 avankest 598: (unless otherwise indicated):</p>
1.90 avankest 599:
1.88 avankest 600: <ol>
1.203 avankest 601: <li>
602: <p>If the <code>XMLHttpRequest</code> object has an associated
603: <span><code>XMLHttpRequest</code> <code>Document</code></span> run
604: these substeps:</p>
1.90 avankest 605:
1.203 avankest 606: <ol>
607: <li><p>If the
608: <span><code>XMLHttpRequest</code> <code>Document</code></span> is not
1.330 avankest 609: <span data-anolis-spec=html>fully active</span> raise an
610: <code data-anolis-spec=domcore title=dom-DOMException-INVALID_STATE_ERR>INVALID_STATE_ERR</code>
1.203 avankest 611: exception and terminate the overall set of steps.</p></li>
612:
613: <li><p>Let <span><code>XMLHttpRequest</code> base URL</span> be the
1.330 avankest 614: <span data-anolis-spec=html>document base URL</span> of the
1.203 avankest 615: <span><code>XMLHttpRequest</code> <code>Document</code></span>.</p></li>
616:
617: <li><p>Let <span><code>XMLHttpRequest</code> origin</span> be the
1.330 avankest 618: <span data-anolis-spec=html>origin</span> of the
1.203 avankest 619: <span><code>XMLHttpRequest</code> <code>Document</code></span>.</p></li>
620: </ol>
621: </li>
1.90 avankest 622:
1.256 avankest 623: <li><p>If any code point in <var>method</var> is higher than
624: U+00FF LATIN SMALL LETTER Y WITH DIAERESIS or after
1.294 avankest 625: <span title="deflate a DOMString into a byte sequence">deflating</span>
1.256 avankest 626: <var>method</var> it does not match the
1.330 avankest 627: <span data-anolis-spec=http>Method</span> token production raise a <code data-anolis-spec=domcore title=dom-DOMException-SYNTAX_ERR>SYNTAX_ERR</code>
1.256 avankest 628: exception and terminate these steps. Otherwise let <var>method</var> be
629: the result of
1.294 avankest 630: <span title="deflate a DOMString into a byte sequence">deflating</span>
1.256 avankest 631: <var>method</var>.</p></li> <!-- This sounds lame, but it works. -->
1.118 avankest 632:
1.115 avankest 633: <li>
1.256 avankest 634: <p>If <var>method</var> is a case-insensitive match for
1.203 avankest 635: <code>CONNECT</code>, <code>DELETE</code>, <code>GET</code>,
636: <code>HEAD</code>, <code>OPTIONS</code>, <code>POST</code>,
637: <code>PUT</code>, <code>TRACE</code>, or <code>TRACK</code>
1.256 avankest 638: subtract 0x20 from each byte in the range 0x61 (ASCII a) to
639: 0x7A (ASCII z).</p>
1.118 avankest 640:
1.203 avankest 641: <p class="note">If it does not match any of the above, it is passed
642: through <em>literally</em>, including in the final request.</p>
1.115 avankest 643: </li>
1.203 avankest 644: <!-- WebKit (and supposedly Gecko) also uppercase: COPY, INDEX, LOCK,
645: M-POST, MKCOL, MOVE, PROPFIND, PROPPATCH, and UNLOCK. -->
1.118 avankest 646:
1.111 avankest 647: <li>
1.256 avankest 648: <p>If <var>method</var> is a case-sensitive match for
1.259 avankest 649: <code>CONNECT</code>, <code>TRACE</code>, or <code>TRACK</code> raise a
1.330 avankest 650: <code data-anolis-spec=domcore title=dom-DOMException-SECURITY_ERR>SECURITY_ERR</code> exception and terminate these steps.</p>
1.117 avankest 651:
1.203 avankest 652: <p class="note">Allowing these methods poses a security risk.
1.330 avankest 653: <span data-anolis-ref>HTTPVERBSEC</span>
1.111 avankest 654: </li>
655:
1.330 avankest 656: <li><p>Let <var title>url</var> be a
657: <span data-anolis-spec=html>URL</span> with character encoding UTF-8.
1.113 avankest 658:
1.330 avankest 659: <li><p><span title="Resolve a URL">Resolve</span> <var title>url</var>
1.203 avankest 660: relative to the <span><code>XMLHttpRequest</code> base URL</span>.
1.330 avankest 661: If the algorithm returns an error raise a <code data-anolis-spec=domcore title=dom-DOMException-SYNTAX_ERR>SYNTAX_ERR</code>
1.203 avankest 662: exception and terminate these steps.</p></li>
663:
664: <!-- Presto and Gecko override the encoding. WebKit does not. Trident
665: does not support non-ASCII URLs. This matters for the <query> component,
1.322 avankest 666: see HTML. -->
1.203 avankest 667:
1.330 avankest 668: <li><p>Drop
669: <code data-anolis-spec=html title=url-fragment><fragment></code> from
670: <var title>url</var>.</p></li>
1.203 avankest 671:
672: <li><p>If the <code>"user:password"</code> format in the
1.330 avankest 673: <code data-anolis-spec=uri>userinfo</code> production is not supported
674: for the relevant
675: <code data-anolis-spec=html title=url-scheme><scheme></code> and
676: <var title>url</var> contains this format raise a
677: <code data-anolis-spec=domcore title=dom-DOMException-SYNTAX_ERR>SYNTAX_ERR</code>
678: and terminate these steps.</p></li>
1.203 avankest 679:
1.310 avankest 680: <!-- XXX need to throw here for "user:password" or just "user" for
681: cross-origin unless we solve this in another way -->
682:
1.330 avankest 683: <li><p>If <var title>url</var> contains the <code>"user:password"</code>
1.203 avankest 684: format let <var>temp user</var> be the user part and
685: <var>temp password</var> be the password part.</p></li>
686:
1.330 avankest 687: <li><p>If <var title>url</var> just contains the <code>"user"</code>
1.203 avankest 688: format let <var>temp user</var> be the user part.</p></li>
689:
1.211 avankest 690: <li><p>Let <var>async</var> be the value of the <var>async</var> argument
1.266 avankest 691: or true if it was omitted.</p></li>
1.203 avankest 692:
693: <li>
1.330 avankest 694: <p>If the <var title>user</var> argument was not omitted follow these
1.300 avankest 695: sub steps:</p>
1.90 avankest 696:
1.203 avankest 697: <ol>
1.330 avankest 698: <li><p>If <var title>user</var> is not null and the
699: <span data-anolis-spec=html>origin</span> of <var title>url</var> is not
700: <span data-anolis-spec=html>same origin</span> with the
1.300 avankest 701: <span><code>XMLHttpRequest</code> origin</span> raise an
1.330 avankest 702: <code data-anolis-spec=domcore title=dom-DOMException-INVALID_ACCESS_ERR>INVALID_ACCESS_ERR</code> exception and terminate the overall set
1.300 avankest 703: of steps.</p></li>
1.263 avankest 704:
1.300 avankest 705: <li><p>Let <var>temp user</var> be <var>user</var>.</p></li>
1.203 avankest 706: </ol>
1.88 avankest 707:
1.203 avankest 708: <p class="note">These steps override anything that may have been set by
1.330 avankest 709: the <var title>url</var> argument.</p>
1.203 avankest 710: </li>
1.88 avankest 711:
1.128 avankest 712: <li>
1.330 avankest 713: <p>If the <var title>password</var> argument was not omitted follow
1.300 avankest 714: these sub steps:</p>
1.203 avankest 715:
716: <ol>
1.330 avankest 717: <li><p>If <var title>password</var> is not null and the
718: <span data-anolis-spec=html>origin</span> of <var title>url</var> is not
719: <span data-anolis-spec=html>same origin</span> with the
1.300 avankest 720: <span><code>XMLHttpRequest</code> origin</span> raise an
1.330 avankest 721: <code data-anolis-spec=domcore title=dom-DOMException-INVALID_ACCESS_ERR>INVALID_ACCESS_ERR</code> exception and terminate the overall set
1.300 avankest 722: of steps.</p></li>
1.263 avankest 723:
1.300 avankest 724: <li><p>Let <var>temp password</var> be <var>password</var>.</p></li>
1.203 avankest 725: </ol>
726:
727: <p class="note">These steps override anything that may have been set by
1.330 avankest 728: the <var title>url</var> argument.</p>
1.128 avankest 729: </li>
1.88 avankest 730:
1.314 avankest 731: <li><p><span title="terminate abort()">Terminate the <code>abort()</code> algorithm</span>.</p></li>
732:
733: <li><p><span title="terminate send()">Terminate the <code>send()</code> algorithm</span>.</p></li>
1.203 avankest 734:
1.330 avankest 735: <li><p>The user agent should cancel any network
1.203 avankest 736: activity for which the object is responsible.</p></li>
737: <!-- we can hardly require it... -->
738:
1.330 avankest 739: <li><p>If there are any
740: <span data-anolis-spec=html title=concept-task>tasks</span> from the
741: object's <span><code>XMLHttpRequest</code> task source</span> in one of
742: the <span data-anolis-spec=html title="task queue">task queues</span>,
743: then remove them.
1.252 avankest 744:
1.203 avankest 745: <li>
746: <p>Set variables associated with the object as follows:</p>
747:
748: <ul>
749:
750: <li><p>Set the <span>request method</span> to <var>method</var>.</p></li>
751:
1.330 avankest 752: <li><p>Set the <span>request URL</span> to <var title>url</var>.</p></li>
1.58 avankest 753:
1.303 avankest 754: <li><p>Set the <span>asynchronous flag</span> to the value of
755: <var>async</var>.</p></li>
756:
1.203 avankest 757: <li><p>Set the <span>request username</span> to <var>temp user</var>.</p></li>
1.12 avankest 758:
1.203 avankest 759: <li><p>Set the <span>request password</span> to <var>temp password</var>.</p></li>
1.12 avankest 760:
1.303 avankest 761: <li><p>Empty the list of <span>author request headers</span>.</p>
762:
1.304 avankest 763:
764:
1.303 avankest 765: <li><p>Set the <span><code>send()</code> flag</span> to false.</p></li>
766:
767: <li><p>Set <span>response entity body</span> to null.</p></li>
1.203 avankest 768: </ul>
769: </li>
1.58 avankest 770:
1.308 avankest 771: <li><p>Switch the state to
1.272 avankest 772: <span title="dom-XMLHttpRequest-OPENED">OPENED</span>.</p></li>
1.58 avankest 773:
1.330 avankest 774: <li><p><span data-anolis-spec=domcore title=concept-event-fire>Fire an event</span> named <code title=event-xhr-readystatechange>readystatechange</code>.</p></li>
1.203 avankest 775: </ol>
1.280 avankest 776:
1.58 avankest 777:
1.14 avankest 778:
1.330 avankest 779: <h4>The <code title>setRequestHeader()</code> method</h4>
1.12 avankest 780:
1.270 avankest 781: <dl class="domintro">
1.330 avankest 782: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader(<var title>header</var>, <var title>value</var>)</code></dt>
1.280 avankest 783:
1.270 avankest 784: <dd>
785: <p>Appends an header to the list of
1.310 avankest 786: <span>author request headers</span>, or if <var>header</var> is already
787: in the list of <span>author request headers</span>, combines its value
788: with <var>value</var>.</p>
1.280 avankest 789:
1.330 avankest 790: <p>Throws an <code data-anolis-spec=domcore title=dom-DOMException-INVALID_STATE_ERR>INVALID_STATE_ERR</code> exception if the state is
1.280 avankest 791: not <span title="dom-XMLHttpRequest-OPENED">OPENED</span> or if the
792: <span><code>send()</code> flag</span> is true.</p>
793:
1.330 avankest 794: <p>Throws a <code data-anolis-spec=domcore title=dom-DOMException-SYNTAX_ERR>SYNTAX_ERR</code> exception if
795: <var title>header</var> is not a valid HTTP header field name or if
796: <var title>value</var> is not a valid HTTP header field value.</p>
1.270 avankest 797: </dd>
798: </dl>
1.45 avankest 799:
1.279 avankest 800: <p class="note">As indicated in the algorithm below certain headers cannot
801: be set and are left up to the user agent. In addition there are certain
802: other headers the user agent will take control of if they are not set by
803: the author as indicated at the end of the
1.271 avankest 804: <code title="dom-XMLHttpRequest-send">send()</code> method section.</p>
1.203 avankest 805:
1.248 avankest 806:
807:
1.203 avankest 808: <p>When the
1.330 avankest 809: <dfn id="dom-xmlhttprequest-setrequestheader" title="dom-XMLHttpRequest-setRequestHeader"><code>setRequestHeader(<var title>header</var>, <var title>value</var>)</code></dfn>
810: method is invoked, the user agent must run these
1.279 avankest 811: steps:</p>
1.14 avankest 812:
1.203 avankest 813: <ol>
1.272 avankest 814: <li><p>If the state is not <span title="dom-XMLHttpRequest-OPENED">OPENED</span> raise
1.330 avankest 815: an <code data-anolis-spec=domcore title=dom-DOMException-INVALID_STATE_ERR>INVALID_STATE_ERR</code> exception and terminate these
1.203 avankest 816: steps.</p></li>
817:
818: <li><p>If the <span><code>send()</code> flag</span> is true raise an
1.330 avankest 819: <code data-anolis-spec=domcore title=dom-DOMException-INVALID_STATE_ERR>INVALID_STATE_ERR</code> exception and terminate these
1.203 avankest 820: steps.</p></li>
821:
1.256 avankest 822: <li><p>If any code point in <var>header</var> is higher than
823: U+00FF LATIN SMALL LETTER Y WITH DIAERESIS or after
1.294 avankest 824: <span title="deflate a DOMString into a byte sequence">deflating</span>
1.256 avankest 825: <var>header</var> it does not match the
1.330 avankest 826: <span data-anolis-spec=http>field-name</span> production raise a
827: <code data-anolis-spec=domcore title=dom-DOMException-SYNTAX_ERR>SYNTAX_ERR</code>
1.256 avankest 828: exception and terminate these steps. Otherwise let <var>header</var> be
829: the result of
1.294 avankest 830: <span title="deflate a DOMString into a byte sequence">deflating</span>
1.256 avankest 831: <var>header</var>.</p></li> <!-- This sounds lame, but it works. -->
1.203 avankest 832:
833: <li>
1.256 avankest 834: <p>If any code point in <var>value</var> is higher than
835: U+00FF LATIN SMALL LETTER Y WITH DIAERESIS or after
1.294 avankest 836: <span title="deflate a DOMString into a byte sequence">deflating</span>
1.256 avankest 837: <var>value</var> it does not match the
1.330 avankest 838: <span data-anolis-spec=http>field-value</span> production raise a
839: <code data-anolis-spec=domcore title=dom-DOMException-SYNTAX_ERR>SYNTAX_ERR</code>
1.256 avankest 840: exception and terminate these steps. Otherwise let <var>value</var> be
841: the result of
1.294 avankest 842: <span title="deflate a DOMString into a byte sequence">deflating</span>
1.256 avankest 843: <var>value</var>.</p> <!-- This sounds lame, but it works. -->
1.203 avankest 844:
845: <p class="note">The empty string is legal and represents the empty
846: header value.</p>
847: </li>
848:
849: <li>
1.259 avankest 850: <p>Terminate these steps if <var>header</var> is a case-insensitive
851: match for one of the following headers:</p>
1.203 avankest 852:
853: <ul>
854: <li><code>Accept-Charset</code></li>
855: <li><code>Accept-Encoding</code></li>
856: <li><code>Connection</code></li>
857: <li><code>Content-Length</code></li>
858: <li><code>Cookie</code></li>
859: <li><code>Cookie2</code></li>
860: <li><code>Content-Transfer-Encoding</code></li>
861: <li><code>Date</code></li>
862: <li><code>Expect</code></li>
863: <li><code>Host</code></li>
864: <li><code>Keep-Alive</code></li>
865: <li><code>Referer</code></li>
866: <li><code>TE</code></li>
867: <li><code>Trailer</code></li>
868: <li><code>Transfer-Encoding</code></li>
869: <li><code>Upgrade</code></li>
870: <li><code>User-Agent</code></li>
871: <li><code>Via</code></li>
872: </ul>
1.96 avankest 873:
1.256 avankest 874: <p>… or if the start of <var>header</var> is a case-insensitive
875: match for <code>Proxy-</code> or <code>Sec-</code> (including when
876: <var>header</var> is just <code>Proxy-</code> or <code>Sec-</code>).</p>
1.203 avankest 877:
1.280 avankest 878: <p class="note">The above headers are controlled by the user agent to
879: let it control those aspects of transport. This guarantees data
880: integrity to some extent. Header names starting with <code>Sec-</code>
881: are not allowed to be set to allow new headers to be minted that are
882: guaranteed not to come from <code>XMLHttpRequest</code>.</p>
1.203 avankest 883: </li>
1.14 avankest 884:
1.203 avankest 885: <li><p>If <var>header</var> is not in the
886: <span>author request headers</span> list append <var>header</var> with
887: its associated <var>value</var> to the list and terminate these
888: steps.</p></li>
889:
890: <li><p>If <var>header</var> is in the <span>author request headers</span>
891: list either use multiple headers, combine the values or use a combination
892: of those (section 4.2, RFC 2616).
1.330 avankest 893: <span data-anolis-ref>HTTP</span>
1.203 avankest 894: <!-- XXX it seems UAs always combine the values -->
895: </ol>
1.45 avankest 896:
1.271 avankest 897: <p class="note">See also the
898: <code title="dom-XMLHttpRequest-send">send()</code> method regarding user
1.203 avankest 899: agent header handling for caching, authentication, proxies, and
900: cookies.</p>
1.14 avankest 901:
1.203 avankest 902: <div class="example">
1.312 avankest 903: <p>Some simple code demonstrating what happens when setting the same
904: header twice:</p>
905:
1.203 avankest 906: <pre><code>// The following script:
1.14 avankest 907: var client = new XMLHttpRequest();
908: client.open('GET', 'demo.cgi');
909: client.setRequestHeader('X-Test', 'one');
910: client.setRequestHeader('X-Test', 'two');
911: client.send();
912:
1.312 avankest 913: // …results in the following header being sent:
914: X-Test: one, two</code></pre>
1.203 avankest 915: </div>
1.255 avankest 916:
1.248 avankest 917:
1.218 avankest 918:
1.203 avankest 919:
1.330 avankest 920: <h4>The <code title>send()</code> method</h4>
1.12 avankest 921:
1.271 avankest 922: <dl class="domintro">
1.330 avankest 923: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-send">send(<var title>data</var>)</code></dt>
1.280 avankest 924: <dd>
925: <p>Initiates the request. The optional argument provides the
926: <span>request entity body</span>. The argument is ignored if
927: <span>request method</span> is <code>GET</code> or
928: <code>HEAD</code>.</p>
929:
1.330 avankest 930: <p>Throws an <code data-anolis-spec=domcore title=dom-DOMException-INVALID_STATE_ERR>INVALID_STATE_ERR</code> exception if the state is
1.280 avankest 931: not <span title="dom-XMLHttpRequest-OPENED">OPENED</span> or if the
932: <span><code>send()</code> flag</span> is true.</p>
933: </dd>
1.271 avankest 934: </dl>
1.203 avankest 935:
936: <p>When the
1.331 avankest 937: <dfn title="dom-XMLHttpRequest-send"><code>send(<var>data</var>)</code></dfn>
1.330 avankest 938: method is invoked, the user agent must run these steps
1.314 avankest 939: (unless otherwise noted). This algorithm can be
940: <dfn title="terminate send()">terminated</dfn> by invoking the
941: <code title="dom-XMLHttpRequest-open">open()</code> or
942: <code title="dom-XMLHttpRequest-abort">abort()</code> method. When it is
943: <span title="terminate send()">terminated</span> the user agent
1.330 avankest 944: must terminate the algorithm after finishing the step
1.314 avankest 945: it is on.</p>
946:
947: <p class="note">The <code title="dom-XMLHttpRequest-send">send()</code>
948: algorithm can only be terminated when the <span>asynchronous flag</span>
949: is true and only after the method call has returned.</p>
1.181 avankest 950:
1.203 avankest 951: <ol>
1.272 avankest 952: <li><p>If the state is not <span title="dom-XMLHttpRequest-OPENED">OPENED</span> raise
1.330 avankest 953: an <code data-anolis-spec=domcore title=dom-DOMException-INVALID_STATE_ERR>INVALID_STATE_ERR</code> exception and terminate these
1.203 avankest 954: steps.</p></li>
955:
956: <li><p>If the <span><code>send()</code> flag</span> is true raise an
1.330 avankest 957: <code data-anolis-spec=domcore title=dom-DOMException-INVALID_STATE_ERR>INVALID_STATE_ERR</code> exception and terminate these
1.203 avankest 958: steps.</p></li>
1.58 avankest 959:
1.203 avankest 960: <li>
1.280 avankest 961: <p>If the <span>request method</span> is a case-sensitive match for
1.330 avankest 962: <code>GET</code> or <code>HEAD</code> act as if <var title>data</var>
1.280 avankest 963: is null.</p>
1.295 avankest 964:
1.232 avankest 965: <p>If the <var>data</var> argument has been omitted or is
1.239 avankest 966: null, do not include a <span>request entity body</span>
1.232 avankest 967: and go to the next step.</p>
1.248 avankest 968:
969: <p>Otherwise, let <var>encoding</var> be null, <var>mime type</var> be
970: null, and then follow these rules:</p>
1.203 avankest 971:
972: <dl class="switch">
1.248 avankest 973:
1.295 avankest 974:
1.330 avankest 975: <dt>If <var>data</var> is a <code data-anolis-spec=domcore>Document</code>
1.203 avankest 976:
977: <dd>
1.330 avankest 978: <p>Let <var>encoding</var> be the
979: <span data-anolis-spec=domcore>preferred MIME name</span> of the
980: <span data-anolis-spec=domcore title=concept-document-character-encoding>character encoding</span>
1.232 avankest 981: of <var>data</var>. If <var>encoding</var> is UTF-16 change it to
982: UTF-8.</p>
1.295 avankest 983:
1.302 avankest 984: <p>Let <var>mime type</var> be "<code>application/xml</code>" or
1.330 avankest 985: "<code>text/html</code>" if
986: <code data-anolis-spec=domcore>Document</code> is flagged as an
987: <span data-anolis-spec=domcore>HTML document</span>, followed by
1.302 avankest 988: "<code>;charset=</code>", followed by <var>encoding</var>.</p>
1.232 avankest 989:
990: <p>Let the <span>request entity body</span> be the result of getting
1.330 avankest 991: the <code data-anolis-spec=html title=dom-innerHTML>innerHTML</code>
992: attribute on <var>data</var>
993: <span data-anolis-spec=webidl title="convert a DOMString to a sequence of Unicode characters">converted to Unicode</span>
1.233 avankest 994: and encoded as <var>encoding</var>. Re-raise any exception this
995: raises.</p>
1.218 avankest 996:
1.233 avankest 997: <p class="note">In particular, if the document cannot be serialized an
1.330 avankest 998: <code data-anolis-spec=domcore title=dom-DOMException-INVALID_STATE_ERR>INVALID_STATE_ERR</code>
999: exception is raised.</p>
1.217 avankest 1000:
1.330 avankest 1001: <p class="note">Subsequent changes to the
1002: <code data-anolis-spec=domcore>Document</code> have no effect on what
1003: is transferred.</p>
1.203 avankest 1004: </dd>
1.237 avankest 1005:
1.248 avankest 1006: <dt>If <var>data</var> is a <code>DOMString</code></dt>
1.237 avankest 1007:
1.248 avankest 1008: <dd>
1009: <p>Let <var>encoding</var> be UTF-8.</p>
1.295 avankest 1010:
1.248 avankest 1011: <p>Let <var>mime type</var> be "<code>text/plain;charset=UTF-8</code>".</p>
1012:
1013: <p>Let the <span>request entity body</span> be <var>data</var>
1.330 avankest 1014: <span data-anolis-spec=webidl title="convert a DOMString to a sequence of Unicode characters">converted to Unicode</span>
1.248 avankest 1015: and encoded as UTF-8.</p>
1016: </dd>
1017:
1018:
1.203 avankest 1019: </dl>
1.58 avankest 1020:
1.232 avankest 1021: <p>If a <code>Content-Type</code> header is set using
1.279 avankest 1022: <code title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader()</code>
1.330 avankest 1023: whose value is a <span data-anolis-spec=html>valid MIME type</span> and
1024: has a <code>charset</code> parameter whose value is not a case-insensitive
1025: match for <var title>encoding</var>, and <var title>encoding</var>
1.279 avankest 1026: is not null, set all the <code>charset</code> parameters of the
1.330 avankest 1027: <code>Content-Type</code> header to <var title>encoding</var>.</p>
1.232 avankest 1028:
1029: <p>If no <code>Content-Type</code> header has been set using
1.279 avankest 1030: <code title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader()</code>
1.330 avankest 1031: and <var title>mime type</var> is not null set a
1.279 avankest 1032: <code>Content-Type</code> request header with as value
1.330 avankest 1033: <var title>mime type</var>.</p>
1.236 avankest 1034:
1035: <!-- reminder: if we ever change this to always include charset it has
1036: to be included as the first parameter for compatibility reasons -->
1.203 avankest 1037: </li>
1.202 avankest 1038:
1.203 avankest 1039: <li><p>If the <span>asynchronous flag</span> is false release the
1.330 avankest 1040: <span data-anolis-spec=html>storage mutex</span>.</p></li>
1.103 avankest 1041:
1.248 avankest 1042:
1043:
1.203 avankest 1044: <li><p>Set the <span>error flag</span> to false.</p></li>
1.218 avankest 1045:
1.248 avankest 1046:
1047:
1.211 avankest 1048: <li>
1049: <p>If the <span>asynchronous flag</span> is true run these substeps:</p>
1.218 avankest 1050:
1.211 avankest 1051: <ol>
1.217 avankest 1052: <li><p>Set the <span><code>send()</code> flag</span> to true.</p></li>
1053:
1.211 avankest 1054: <li>
1.330 avankest 1055: <p><span data-anolis-spec=domcore title=concept-event-fire>Fire an event</span> named <code title=event-xhr-readystatechange>readystatechange</code>.
1.145 avankest 1056:
1.211 avankest 1057: <p class="note">The state does not change. The event is dispatched for
1058: historical reasons.</p>
1059: </li>
1060:
1.248 avankest 1061:
1062:
1.271 avankest 1063: <li><p>Return the <code title="dom-XMLHttpRequest-send">send()</code>
1064: method call, but continue running the steps in this algorithm.</p></li>
1.211 avankest 1065: </ol>
1066: </li>
1.218 avankest 1067:
1.203 avankest 1068: <li>
1.300 avankest 1069: <dl class="switch">
1070: <dt>If the <span><code>XMLHttpRequest</code> origin</span> and the
1.330 avankest 1071: <span>request URL</span> are <span data-anolis-spec=html>same origin</span></dt>
1.300 avankest 1072:
1073: <dd>
1074: <p>These are the <dfn>same-origin request steps</dfn>.</p>
1.211 avankest 1075:
1.330 avankest 1076: <p><span data-anolis-spec=html>Fetch</span> the
1077: <span>request URL</span> from <i title>origin</i>
1.260 avankest 1078: <span><code>XMLHttpRequest</code> origin</span>, with the
1.330 avankest 1079: <i title>synchronous flag</i> set if the
1.260 avankest 1080: <span>asynchronous flag</span> is false, using HTTP method
1.248 avankest 1081: <span>request method</span>, user <span>request username</span> (if
1082: non-null) and password <span>request password</span> (if non-null),
1083: taking into account the <span>request entity body</span>, list of
1084: <span>author request headers</span> and the rules listed at the end of
1085: this section.</p>
1086:
1087: <dl class="switch">
1088: <dt>If the <span>asynchronous flag</span> is false</dt>
1089: <dd>
1090: <p>While making the request also follow the
1091: <span>same-origin request event rules</span>.</p>
1092:
1093: <!--
1094: This cannot involve any task queue whatsoever because that would
1095: mean other tasks on the task queue might get processed as well
1096: which is counter to the whole idea of doing things synchronous.
1097: -->
1098:
1.271 avankest 1099: <p class="note">The
1100: <code title="dom-XMLHttpRequest-send">send()</code> method call will
1101: now be returned by virtue of this algorithm ending.</p>
1.248 avankest 1102: </dd>
1103:
1104: <dt>If the <span>asynchronous flag</span> is true</dt>
1105: <dd>
1.300 avankest 1106:
1.248 avankest 1107:
1108: <p>While processing the request, as data becomes available and when
1109: the user interferes with the request,
1.330 avankest 1110: <span data-anolis-spec=html title="queue a task">queue tasks</span>
1111: to update the <span>response entity body</span> and follow the
1.254 avankest 1112: <span>same-origin request event rules</span>.</p>
1.248 avankest 1113: </dd>
1114: </dl>
1.300 avankest 1115: </dd>
1116:
1117: <dt>Otherwise</dt>
1118: <dd>
1119: <p>These are the <dfn>cross-origin request steps</dfn>.</p>
1120:
1121:
1122: <p>This is a <span>network error</span>.</p>
1123:
1124:
1125:
1126: </dd>
1127: </dl>
1.203 avankest 1128: </li>
1129: </ol>
1.60 avankest 1130:
1.203 avankest 1131: <hr>
1132:
1.227 avankest 1133: <p>If the user agent allows the end user to configure a proxy it
1.330 avankest 1134: should modify the request appropriately; i.e., connect
1.248 avankest 1135: to the proxy host instead of the origin server, modify the
1136: <code>Request-Line</code> and send <code>Proxy-Authorization</code>
1137: headers as specified.</p>
1.295 avankest 1138:
1.262 avankest 1139: <hr>
1.212 avankest 1140:
1.218 avankest 1141: <p>If the user agent supports HTTP Authentication and
1.262 avankest 1142: <code title="http-authorization">Authorization</code> is not in the list
1.330 avankest 1143: of <span>author request headers</span>, it should
1.218 avankest 1144: consider requests originating from the <code>XMLHttpRequest</code> object
1145: to be part of the protection space that includes the accessed URIs and
1.262 avankest 1146: send <code title="http-authorization">Authorization</code> headers and
1147: handle <code>401 Unauthorized</code> requests appropriately.</p>
1148:
1149: <p>If authentication fails,
1.311 avankest 1150: <span><code>XMLHttpRequest</code> origin</span> and the
1.330 avankest 1151: <span>request URL</span> are <span data-anolis-spec=html>same origin</span>,
1.262 avankest 1152: <code title="http-authorization">Authorization</code> is not in the list
1153: of <span>author request headers</span>, <span>request username</span> is
1154: null, and <span>request password</span> is null, user agents
1.330 avankest 1155: should prompt the end user for their username and
1.262 avankest 1156: password.</p>
1.295 avankest 1157:
1.311 avankest 1158: <p>Otherwise, if authentication fails, user agents
1.330 avankest 1159: must not prompt the end user for their username and
1160: password. <span data-anolis-ref>HTTPAUTH</span>
1.212 avankest 1161:
1.311 avankest 1162: <p class="note">End users are not prompted for various cases so that
1163: authors can implement their own user interface.</p>
1.295 avankest 1164:
1.262 avankest 1165: <hr>
1.212 avankest 1166:
1167: <p>If the user agent supports HTTP State Management it
1.330 avankest 1168: should persist, discard and send cookies (as received
1.297 avankest 1169: in the <code>Set-Cookie</code> response header, and sent in the
1170: <code>Cookie</code> header) as applicable.
1.330 avankest 1171: <span data-anolis-ref>COOKIES</span>
1.295 avankest 1172:
1.262 avankest 1173: <hr>
1.212 avankest 1174:
1.330 avankest 1175: <p>If the user agent implements a HTTP cache it should
1.248 avankest 1176: respect <code>Cache-Control</code> request headers set by the
1.279 avankest 1177: <code title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader()</code>
1178: (e.g., <code>Cache-Control: no-cache</code> bypasses the cache). It
1.330 avankest 1179: must not send <code>Cache-Control</code> or
1.279 avankest 1180: <code>Pragma</code> request headers automatically unless the end user
1181: explicitly requests such behavior (e.g. by reloading the page).</p>
1.212 avankest 1182:
1183: <p>For <code>304 Not Modified</code> responses that are a result of a
1184: user agent generated conditional request the user agent
1.330 avankest 1185: must act as if the server gave a <code>200 OK</code>
1.212 avankest 1186: response with the appropriate content. The user agent
1.330 avankest 1187: must allow
1.279 avankest 1188: <code title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader()</code>
1189: to override automatic cache validation by setting request headers (e.g.
1.248 avankest 1190: <code>If-None-Match</code> or <code>If-Modified-Since</code>), in which
1.330 avankest 1191: case <code>304 Not Modified</code> responses must be
1192: passed through. <span data-anolis-ref>HTTP</span>
1.295 avankest 1193:
1.262 avankest 1194: <hr>
1.212 avankest 1195:
1196: <p>If the user agent implements server-driven content-negotiation
1.330 avankest 1197: it must follow these constraints for the
1.298 avankest 1198: <code>Accept</code> and <code>Accept-Language</code> request headers:</p>
1.231 avankest 1199:
1200: <ul>
1.330 avankest 1201: <li><p>Both headers must not be modified if they are
1.279 avankest 1202: already set through
1203: <code title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader()</code>.</p></li>
1.255 avankest 1204:
1.279 avankest 1205: <li><p>If not set through
1206: <code title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader()</code>
1.330 avankest 1207: <code>Accept-Language</code> should be set as
1.231 avankest 1208: appropriate.</p></li>
1209:
1.279 avankest 1210: <li><p>If not set through
1211: <code title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader()</code>
1.330 avankest 1212: <code>Accept</code> must be set with as value
1.231 avankest 1213: <code>*/*</code>.</p></li>
1214: </ul>
1215:
1.330 avankest 1216: <p>Responses must have the content-encodings
1217: automatically decoded. <span data-anolis-ref>HTTP</span>
1.212 avankest 1218:
1.262 avankest 1219: <hr>
1220:
1.212 avankest 1221: <p>Besides the <span>author request headers</span> user agents
1.330 avankest 1222: should not include additional request headers other than those mentioned
1223: above or other than those authors are not allowed to set using
1.279 avankest 1224: <code title="dom-XMLHttpRequest-setRequestHeader">setRequestHeader()</code>.
1225: This ensures that authors have a reasonably predictable API.</p>
1.218 avankest 1226:
1.212 avankest 1227:
1.330 avankest 1228: <h4>Infrastructure for the <code title>send()</code> method</h4>
1.216 avankest 1229:
1.219 avankest 1230: <p>The <dfn>same-origin request event rules</dfn> are as follows:</p>
1.118 avankest 1231:
1.203 avankest 1232: <dl class="switch">
1.316 avankest 1233: <dt>If the response has an HTTP status code of 301, 302, 303, or 307</dt>
1.203 avankest 1234: <dd>
1.300 avankest 1235: <p>If the redirect violates infinite loop precautions this is a
1236: <span>network error</span>.</p>
1237:
1238: <p>Otherwise, run these steps:</p>
1239:
1240: <ol>
1.330 avankest 1241: <li><p>Set the <span>request URL</span> to the
1242: <span data-anolis-spec=html>URL</span> conveyed by the
1243: <code>Location</code> header.</p></li>
1.300 avankest 1244:
1245: <li><p>If the <span><code>XMLHttpRequest</code> origin</span> and the
1.330 avankest 1246: <span data-anolis-spec=html>origin</span> of <span>request URL</span>
1247: are <span data-anolis-spec=html>same origin</span> transparently follow
1248: the redirect while observing the
1249: <span>same-origin request event rules</span>.
1.295 avankest 1250:
1.300 avankest 1251: <li><p>Otherwise, follow the <span>cross-origin request steps</span>
1252: and terminate the steps for this algorithm.</p></li>
1253: </ol>
1.203 avankest 1254:
1255: <p class="note">HTTP places requirements on the user agent regarding the
1.204 avankest 1256: preservation of the <span>request method</span> and
1.248 avankest 1257: <span>request entity body</span> during redirects, and also requires end
1258: users to be notified of certain kinds of automatic redirections.</p>
1.203 avankest 1259: <!-- XXX HTTP needs fixing here -->
1.213 avankest 1260: </dd>
1.121 avankest 1261:
1.285 avankest 1262: <dt>If the end user cancels the request</dt>
1.213 avankest 1263: <dd><p>This is an <span>abort error</span>.</p></dd>
1.60 avankest 1264:
1.285 avankest 1265: <dt>If there is a network error</dt>
1.213 avankest 1266: <dd>
1267: <p>In case of DNS errors, TLS negotiation failure, or other type of
1268: network errors, this is a <span>network error</span>. Do not request any
1.227 avankest 1269: kind of end user interaction.</p>
1.121 avankest 1270:
1.213 avankest 1271: <p class="note">This does not include HTTP responses that indicate
1272: some type of error, such as HTTP status code 410.</p>
1273: </dd>
1.60 avankest 1274:
1.248 avankest 1275:
1276:
1.306 avankest 1277: <dt>Once all HTTP headers have been received, the
1.316 avankest 1278: <span>asynchronous flag</span> is true, and the HTTP status code of the
1279: response is not 301, 302, 303, or 307</dt>
1.284 avankest 1280: <dd><p><span>Switch to the HEADERS_RECEIVED state</span>.</p></dd>
1.186 avankest 1281:
1.220 avankest 1282: <dt>Once the first byte (or more) of the
1283: <span>response entity body</span> has been received and the
1284: <span>asynchronous flag</span> is true</dt>
1285: <dt>If there is no <span>response entity body</span> and the
1.213 avankest 1286: <span>asynchronous flag</span> is true</dt>
1.284 avankest 1287: <dd><p><span>Switch to the LOADING state</span>.</p></dd>
1.295 avankest 1288:
1.220 avankest 1289: <dt>Once the whole <span>response entity body</span> has been
1290: received</dt>
1.296 avankest 1291: <dt>If there is no <span>response entity body</span> and the state is
1292: <span title="dom-XMLHttpRequest-LOADING">LOADING</span></dt>
1.224 avankest 1293: <dt>If there is no <span>response entity body</span> and the
1.296 avankest 1294: <span>asynchronous flag</span> is false</dt>
1.284 avankest 1295: <dd><p><span>Switch to the DONE state</span>.</p></dd>
1.213 avankest 1296: </dl>
1.218 avankest 1297:
1.248 avankest 1298:
1299:
1.213 avankest 1300: <hr>
1.218 avankest 1301:
1.241 avankest 1302: <p>When something is said to be a <dfn>network error</dfn> run the
1303: <span>request error</span> steps for exception
1.330 avankest 1304: <code data-anolis-spec=domcore title=dom-DOMException-NETWORK_ERR>NETWORK_ERR</code>.</p>
1.241 avankest 1305:
1306: <p>When something is said to be an <dfn>abort error</dfn> run the
1307: <span>request error</span> steps for exception
1.330 avankest 1308: <code data-anolis-spec=domcore title=dom-DOMException-ABORT_ERR>ABORT_ERR</code>.</p>
1.60 avankest 1309:
1.248 avankest 1310:
1311:
1.242 avankest 1312: <p>When something is said to be a <dfn>request error</dfn> for
1.248 avankest 1313: exception <var>exception</var> run these
1314: steps:</p>
1.12 avankest 1315:
1.213 avankest 1316: <ol>
1.330 avankest 1317: <li><p>The user agent should cancel any network
1.254 avankest 1318: activity for which the object is responsible.</p></li>
1319:
1.330 avankest 1320: <li><p>If there are any
1321: <span data-anolis-spec=html title=concept-task>tasks</span> from the
1322: object's <span><code>XMLHttpRequest</code> task source</span> in one of
1323: the <span data-anolis-spec=html title="task queue">task queues</span>,
1324: then remove them.
1.250 avankest 1325:
1.213 avankest 1326: <li><p>Set the the <span>error flag</span> to true.</p></li>
1.12 avankest 1327:
1.272 avankest 1328: <li><p>Switch the state to <span title="dom-XMLHttpRequest-DONE">DONE</span>.</p></li>
1.203 avankest 1329:
1.241 avankest 1330: <li><p>If the <span>asynchronous flag</span> is false raise an
1331: <var>exception</var> exception and terminate the overall set of
1.213 avankest 1332: steps.</p></li>
1.203 avankest 1333:
1.248 avankest 1334: <li>
1.330 avankest 1335: <p><span data-anolis-spec=domcore title=concept-event-fire>Fire an event</span> named <code title=event-xhr-readystatechange>readystatechange</code>.</p>
1.248 avankest 1336:
1337: <p class="note">At this point it is clear that the
1338: <span>asynchronous flag</span> is true.</p>
1339: </li>
1340:
1341:
1.213 avankest 1342: </ol>
1.203 avankest 1343:
1.248 avankest 1344:
1345: <p class="note">A future version of this specification will dispatch an
1.330 avankest 1346: <code title="event-xhr-error">error</code>/<code title="event-xhr-abort">abort</code>
1347: event here as well. (Depending on the type of error.)
1.248 avankest 1348:
1.203 avankest 1349:
1.213 avankest 1350: <hr>
1.203 avankest 1351:
1.213 avankest 1352: <p>When it is said to
1.284 avankest 1353: <dfn id="switch-headers-received">switch to the HEADERS_RECEIVED state</dfn>
1.213 avankest 1354: run these steps:</p>
1.203 avankest 1355:
1.213 avankest 1356: <ol>
1.272 avankest 1357: <li><p>Switch the state to <span title="dom-XMLHttpRequest-HEADERS_RECEIVED">HEADERS_RECEIVED</span>.</p></li>
1.203 avankest 1358:
1.330 avankest 1359: <li><p><span data-anolis-spec=domcore title=concept-event-fire>Fire an event</span> named <code title=event-xhr-readystatechange>readystatechange</code>.</p></li>
1.213 avankest 1360: </ol>
1.218 avankest 1361:
1.213 avankest 1362: <p>When it is said to
1.284 avankest 1363: <dfn id="switch-loading">switch to the LOADING state</dfn> run these
1.213 avankest 1364: steps:</p>
1.218 avankest 1365:
1.213 avankest 1366: <ol>
1.272 avankest 1367: <li><p>Switch the state to <span title="dom-XMLHttpRequest-LOADING">LOADING</span>.</p></li>
1.203 avankest 1368:
1.330 avankest 1369: <li><p><span data-anolis-spec=domcore title=concept-event-fire>Fire an event</span> named <code title=event-xhr-readystatechange>readystatechange</code>.</p></li>
1.213 avankest 1370: </ol>
1.218 avankest 1371:
1.216 avankest 1372: <p>When it is said to
1.284 avankest 1373: <dfn id="switch-done">switch to the DONE state</dfn> run these steps:</p>
1.218 avankest 1374:
1.216 avankest 1375: <ol>
1.255 avankest 1376: <li><p>If the <span>asynchronous flag</span> is false update the
1377: <span>response entity body</span>.</p></li>
1378:
1.272 avankest 1379: <li><p>Switch the state to <span title="dom-XMLHttpRequest-DONE">DONE</span>.</p></li>
1.216 avankest 1380:
1.330 avankest 1381: <li><p><span data-anolis-spec=domcore title=concept-event-fire>Fire an event</span> named <code title=event-xhr-readystatechange>readystatechange</code>.</p></li>
1.248 avankest 1382:
1.220 avankest 1383:
1.216 avankest 1384: </ol>
1.218 avankest 1385:
1.248 avankest 1386:
1387:
1.203 avankest 1388:
1.330 avankest 1389: <h4>The <code title>abort()</code> method</h4>
1.295 avankest 1390:
1.275 avankest 1391: <dl class="domintro">
1.330 avankest 1392: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-abort">abort()</code></dt>
1.275 avankest 1393: <dd>Cancels any network activity.</dd>
1394: </dl>
1.203 avankest 1395:
1.275 avankest 1396: <p>When the
1.331 avankest 1397: <dfn title="dom-XMLHttpRequest-abort"><code>abort()</code></dfn>
1.330 avankest 1398: method is invoked, the user agent must run these steps
1.314 avankest 1399: (unless otherwise noted). This algorithm can be
1400: <dfn title="terminate abort()">terminated</dfn> by invoking the
1401: <code title="dom-XMLHttpRequest-open">open()</code> method. When it is
1402: <span title="terminate abort()">terminated</span> the user agent
1.330 avankest 1403: must terminate the algorithm after finishing the step
1.314 avankest 1404: it is on.</p>
1405:
1406: <p class="note">The <code title="dom-XMLHttpRequest-abort">abort()</code>
1407: algorithm can only be terminated by invoking
1408: <code title="dom-XMLHttpRequest-open">open()</code> from an event
1409: handler.</p>
1.12 avankest 1410:
1.203 avankest 1411: <ol>
1.314 avankest 1412: <li><p><span title="terminate send()">Terminate the <code>send()</code> algorithm</span>.</p></li>
1.203 avankest 1413:
1.330 avankest 1414: <li><p>The user agent should cancel any network
1.203 avankest 1415: activity for which the object is responsible.</p></li>
1.252 avankest 1416:
1.330 avankest 1417: <li><p>If there are any
1418: <span data-anolis-spec=html title=concept-task>tasks</span> from the
1419: object's <span><code>XMLHttpRequest</code> task source</span> in one of
1420: the <span data-anolis-spec=html title="task queue">task queues</span>,
1421: then remove them.
1.203 avankest 1422:
1423: <li><p>Set the <span>error flag</span> to true.</p></li>
1424:
1425: <li>
1.272 avankest 1426: <p>If the state is <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span>,
1427: <span title="dom-XMLHttpRequest-OPENED">OPENED</span> with the
1.203 avankest 1428: <span><code>send()</code> flag</span> being false, or
1.272 avankest 1429: <span title="dom-XMLHttpRequest-DONE">DONE</span> go to the next step.</p>
1.12 avankest 1430:
1.203 avankest 1431: <p>Otherwise run these substeps:</p>
1.58 avankest 1432:
1433: <ol>
1.272 avankest 1434: <li><p>Switch the state to <span title="dom-XMLHttpRequest-DONE">DONE</span>.</p></li>
1.170 avankest 1435:
1.203 avankest 1436: <li><p>Set the <span><code>send()</code> flag</span> to false.</p></li>
1.96 avankest 1437:
1.330 avankest 1438: <li><p><span data-anolis-spec=domcore title=concept-event-fire>Fire an event</span> named <code title=event-xhr-readystatechange>readystatechange</code>.</p></li>
1.248 avankest 1439:
1440:
1.58 avankest 1441: </ol>
1.250 avankest 1442:
1.248 avankest 1443:
1.250 avankest 1444: <p class="note">A future version of this specification will dispatch an
1.273 avankest 1445: <code title="event-xhr-abort">abort</code> event here.</p>
1.248 avankest 1446:
1.203 avankest 1447: </li>
1448:
1449: <li>
1.272 avankest 1450: <p>Switch the state to <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span>.</p>
1.203 avankest 1451:
1.273 avankest 1452: <p class="note">No <code title="event-xhr-readystatechange">readystatechange</code> event is dispatched.</p>
1.203 avankest 1453: </li>
1454: </ol>
1455:
1456:
1457:
1.205 avankest 1458: <h3 id="response">Response</h3>
1.203 avankest 1459:
1.330 avankest 1460: <h4>The <code title>status</code> attribute</h4>
1.203 avankest 1461:
1.276 avankest 1462: <dl class="domintro">
1.330 avankest 1463: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-status">status</code></dt>
1.276 avankest 1464: <dd><p>Returns the HTTP status code.</p></dd>
1465: </dl>
1466:
1467: <p>The
1.331 avankest 1468: <dfn title="dom-XMLHttpRequest-status"><code>status</code></dfn>
1.330 avankest 1469: attribute must return the result of running these
1.276 avankest 1470: steps:</p>
1.226 avankest 1471:
1.222 avankest 1472: <ol>
1.272 avankest 1473: <li><p>If the state is <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span> or
1474: <span title="dom-XMLHttpRequest-OPENED">OPENED</span> return 0 and terminate these
1.222 avankest 1475: steps.</p></li>
1476:
1.239 avankest 1477: <li><p>If the <span>error flag</span> is true return 0 and terminate
1478: these steps.</p></li>
1.295 avankest 1479:
1.222 avankest 1480: <li><p>Return the HTTP status code.</p></li>
1.295 avankest 1481: </ol>
1.203 avankest 1482:
1483:
1.330 avankest 1484: <h4>The <code title>statusText</code> attribute</h4>
1.203 avankest 1485:
1.276 avankest 1486: <dl class="domintro">
1.330 avankest 1487: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-statusText">statusText</code></dt>
1.276 avankest 1488: <dd><p>Returns the HTTP status text.</p></dd>
1489: </dl>
1490:
1491: <p>The
1.331 avankest 1492: <dfn title="dom-XMLHttpRequest-statusText"><code>statusText</code></dfn>
1.330 avankest 1493: attribute must return the result of running these
1.276 avankest 1494: steps:</p>
1.295 avankest 1495:
1.222 avankest 1496: <ol>
1.272 avankest 1497: <li><p>If the state is <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span> or
1498: <span title="dom-XMLHttpRequest-OPENED">OPENED</span> return the empty string and
1.239 avankest 1499: terminate these steps.</p></li>
1.222 avankest 1500:
1501: <li><p>If the <span>error flag</span> is true return the empty string and
1502: terminate these steps.</p></li>
1.295 avankest 1503:
1.222 avankest 1504: <li><p>Return the HTTP status text.</p></li>
1505: </ol>
1.203 avankest 1506:
1507:
1.330 avankest 1508: <h4>The <code title>getResponseHeader()</code> method</h4>
1.203 avankest 1509:
1.278 avankest 1510: <dl class="domintro">
1.330 avankest 1511: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-getResponseHeader">getResponseHeader(<var title>header</var>)</code></dt>
1.278 avankest 1512: <dd><p>Returns the header field value from the response of which the
1.330 avankest 1513: field name matches <var title>header</var>, unless the field name is
1514: <code>Set-Cookie</code> or <code>Set-Cookie2</code>.</p>
1.278 avankest 1515: </dl>
1516:
1.203 avankest 1517: <p>When the
1.331 avankest 1518: <dfn title="dom-XMLHttpRequest-getResponseHeader"><code>getResponseHeader(<var title>header</var>)</code></dfn>
1.330 avankest 1519: is invoked, the user agent must run these steps:</p>
1.203 avankest 1520:
1521: <ol>
1.272 avankest 1522: <li><p>If the state is <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span> or
1523: <span title="dom-XMLHttpRequest-OPENED">OPENED</span> return null and terminate these
1.203 avankest 1524: steps.</p></li>
1525:
1.239 avankest 1526: <li><p>If the <span>error flag</span> is true return null
1.203 avankest 1527: and terminate these steps.</p></li>
1528:
1.256 avankest 1529: <li><p>If any code point in <var>header</var> is higher than
1530: U+00FF LATIN SMALL LETTER Y WITH DIAERESIS return null and terminate
1531: these steps.</p></li>
1.295 avankest 1532:
1.256 avankest 1533: <li><p>Let <var>header</var> be the result of
1.294 avankest 1534: <span title="deflate a DOMString into a byte sequence">deflating</span>
1.256 avankest 1535: <var>header</var>.</p></li> <!-- This sounds lame, but it works. -->
1536:
1537: <li><p>If <var>header</var> is a case-insensitive match for
1538: <code>Set-Cookie</code> or <code>Set-Cookie2</code> return null and
1539: terminate these steps.</p></li>
1.203 avankest 1540:
1.256 avankest 1541: <li><p>If <var>header</var> is a case-insensitive match for multiple HTTP
1542: response headers, return the
1.294 avankest 1543: <span title="inflate a byte sequence into a DOMString">inflated</span>
1.256 avankest 1544: values of these headers as a single concatenated string separated from
1545: each other by a U+002C COMMA U+0020 SPACE character pair and terminate
1546: these steps.</p></li>
1.203 avankest 1547:
1.256 avankest 1548: <li><p>If <var>header</var> is a case-insensitive match for a single HTTP
1549: response header, return the
1.294 avankest 1550: <span title="inflate a byte sequence into a DOMString">inflated</span>
1.256 avankest 1551: value of that header and terminate these steps.</p></li>
1.203 avankest 1552:
1.239 avankest 1553: <li><p>Return null.</p></li>
1.203 avankest 1554: </ol>
1555:
1.248 avankest 1556:
1557:
1.203 avankest 1558: <div class="example">
1.295 avankest 1559:
1.250 avankest 1560: <p>For the following script:</p>
1561:
1562: <pre><code>var client = new XMLHttpRequest();
1563: client.open("GET", "unicorns-are-teh-awesome.txt", true);
1.5 avankest 1564: client.send();
1.12 avankest 1565: client.onreadystatechange = function() {
1.250 avankest 1566: if(this.readyState == 2) {
1567: print(client.getResponseHeader("Content-Type"));
1568: }
1569: }</code></pre>
1570:
1571: <p>The <code>print()</code> function will get to process something
1572: like:</p>
1.5 avankest 1573:
1.250 avankest 1574: <pre><code>text/plain; charset=UTF-8</code></pre>
1.203 avankest 1575: </div>
1.12 avankest 1576:
1577:
1.330 avankest 1578: <h4>The <code title>getAllResponseHeaders()</code> method</h4>
1.14 avankest 1579:
1.278 avankest 1580: <dl class="domintro">
1.330 avankest 1581: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-getAllResponseHeaders">getAllResponseHeaders()</code></dt>
1.278 avankest 1582: <dd><p>Returns all headers from the response, with the exception of those
1583: whose field name is <code>Set-Cookie</code> or
1584: <code>Set-Cookie2</code>.</p></dd>
1585: </dl>
1586:
1.203 avankest 1587: <p>When the
1.331 avankest 1588: <dfn title="dom-XMLHttpRequest-getAllResponseHeaders"><code>getAllResponseHeaders()</code></dfn>
1.330 avankest 1589: method is invoked, the user agent must run these steps:</p>
1.58 avankest 1590:
1.203 avankest 1591: <ol>
1.272 avankest 1592: <li><p>If the state is <span title="dom-XMLHttpRequest-UNSENT">UNSENT</span> or
1593: <span title="dom-XMLHttpRequest-OPENED">OPENED</span> return the empty string and
1.239 avankest 1594: terminate these steps.</p></li>
1.203 avankest 1595:
1596: <li><p>If the <span>error flag</span> is true return the empty string and
1597: terminate these steps.</p></li>
1598:
1.256 avankest 1599: <li><p>Return all the HTTP headers, excluding headers that are a
1600: case-insensitive match for <code>Set-Cookie</code> or
1601: <code>Set-Cookie2</code>,
1.294 avankest 1602: <span title="inflate a byte sequence into a DOMString">inflated</span>,
1.256 avankest 1603: as a single string, with each header line
1604: separated by a U+000D CR U+000A LF pair, excluding the status line, and
1.203 avankest 1605: with each header name and header value separated by a
1606: U+003A COLON U+0020 SPACE pair.</p></li>
1607: </ol>
1.58 avankest 1608:
1.250 avankest 1609:
1610:
1.203 avankest 1611: <div class="example">
1.250 avankest 1612: <p>For the following script:</p>
1.295 avankest 1613:
1.250 avankest 1614: <pre><code>var client = new XMLHttpRequest();
1615: client.open("GET", "narwhals-too.txt", true);
1.5 avankest 1616: client.send();
1.12 avankest 1617: client.onreadystatechange = function() {
1.308 avankest 1618: if(this.readyState == 2) {
1619: print(this.getAllResponseHeaders());
1620: }
1.250 avankest 1621: }</code></pre>
1622:
1623: <p>The <code>print()</code> function will get to process something
1624: like:</p>
1.1 avankest 1625:
1.250 avankest 1626: <pre><code>Date: 2004年10月24日 04:58:38 GMT
1.203 avankest 1627: Server: Apache/1.3.31 (Unix)
1628: Keep-Alive: timeout=15, max=99
1629: Connection: Keep-Alive
1630: Transfer-Encoding: chunked
1631: Content-Type: text/plain; charset=utf-8</code></pre>
1632: </div>
1633:
1.250 avankest 1634:
1.203 avankest 1635:
1.334 ! avankest 1636: <h4>Response entity body</h4>
1.203 avankest 1637:
1.248 avankest 1638: <p>The <dfn id="response-mime-type">response MIME type</dfn> is the MIME
1639: type the <code>Content-Type</code> header contains without any
1640: parameters or null if the header could not be parsed properly or was
1641: omitted. The <dfn id="override-mime-type">override MIME type</dfn> is
1642: always null. <dfn id="final-mime-type">Final MIME type</dfn> is the
1643: override MIME type unless that is null in which case it is the response
1644: MIME type.</p>
1645:
1646: <p>The <dfn id="response-charset">response charset</dfn> is the value of
1647: the <code>charset</code> parameter of the <code>Content-Type</code> header
1648: or null if there was no <code>charset</code> parameter or if
1649: the header could not be parsed properly or was omitted. The
1650: <dfn id="override-charset">override charset</dfn> is always null.
1651: <dfn id="final-charset">Final charset</dfn> is the override charset unless
1652: that is null in which case it is the response charset.</p>
1.250 avankest 1653:
1.248 avankest 1654:
1655: <p class="note"><span>Override MIME type</span> and
1656: <span>override charset</span> are introduced here solely to make editing
1657: several levels of XMLHttpRequest simultaneously somewhat easier. Apologies
1658: for any confusion they might cause.</p>
1659:
1.250 avankest 1660:
1.248 avankest 1661: <hr>
1662:
1.203 avankest 1663: <p>The <dfn id="response-entity-body">response entity body</dfn> is the
1.330 avankest 1664: fragment of the <span data-anolis-spec=http>entity body</span> of the
1665: response received so far
1666: (<span title="dom-XMLHttpRequest-LOADING">LOADING</span>) or the complete
1667: entity body of the response
1668: (<span title="dom-XMLHttpRequest-DONE">DONE</span>). If the response
1.255 avankest 1669: does not have an entity body the response entity body is null.</p>
1670:
1671: <p class="note">The <span>response entity body</span> is updated as part
1.271 avankest 1672: of the <code title="dom-XMLHttpRequest-send">send()</code> algorithm.</p>
1.250 avankest 1673:
1.203 avankest 1674: <hr>
1675:
1676: <p>The <dfn id="text-response-entity-body">text response entity body</dfn>
1.248 avankest 1677: is a <code>DOMString</code> representing the <span>response entity
1678: body</span>. The text response entity body is the return value of the
1.203 avankest 1679: following algorithm:</p>
1680:
1681: <ol>
1.248 avankest 1682: <li><p>If the response entity body is null return the empty string and
1683: terminate these steps.</p>
1684:
1685: <li><p>Let <var>charset</var> be the <span>final charset</span>.</p></li>
1.203 avankest 1686:
1.248 avankest 1687: <li><p>Let <var>mime</var> be the <span>final MIME type</span>.</p></li>
1.203 avankest 1688:
1.248 avankest 1689: <li><p>If <var>charset</var> is null and <var>mime</var> is null,
1.203 avankest 1690: <code>text/xml</code>, <code>application/xml</code> or ends in
1.330 avankest 1691: <code title>+xml</code> use the rules set forth in the XML
1.248 avankest 1692: specifications to determine the character encoding. Let
1693: <var>charset</var> be the determined character encoding.</p></li>
1694:
1695: <li><p>If <var>charset</var> is null and <var>mime</var> is
1696: <code>text/html</code> follow the rules set forth in the HTML
1697: specification to determine the character encoding. Let
1.203 avankest 1698: <var>charset</var> be the determined character encoding.
1.330 avankest 1699: <span data-anolis-ref>HTML</span>
1.203 avankest 1700:
1701: <li>
1702: <p>If <var>charset</var> is null then, for each of the rows in the
1703: following table, starting with the first one and going down, if the first
1704: bytes of <var>bytes</var> match the bytes given in the first column, then
1705: let <var>charset</var> be the encoding given in the cell in the second
1706: column of that row. If there is no match <var>charset</var> remains
1707: null.</p>
1708:
1709: <table>
1710: <thead>
1711: <tr>
1712: <th>Bytes in Hexadecimal
1713: <th>Description
1.237 avankest 1714: <tbody>
1.203 avankest 1715: <tr>
1716: <td>FE FF
1717: <td>UTF-16BE BOM
1718: <tr>
1719: <td>FF FE
1720: <td>UTF-16LE BOM
1721: <tr>
1722: <td>EF BB BF
1.237 avankest 1723: <td>UTF-8 BOM
1.203 avankest 1724: </table>
1725: </li>
1726:
1727: <li><p>If <var>charset</var> is null let <var>charset</var> be
1728: UTF-8.</p></li>
1729:
1730: <li><p>Return the result of decoding the response entity body using
1731: <var>charset</var>. Replace bytes or sequences of bytes that are not
1.248 avankest 1732: valid accordng to the <var>charset</var> with a single
1.315 avankest 1733: U+FFFD REPLACEMENT CHARACTER character. Remove one leading
1734: U+FEFF BYTE ORDER MARK character, if present.</p></li>
1.203 avankest 1735: </ol>
1736:
1.315 avankest 1737: <p class="note">Authors are strongly encouraged to always encode their
1738: resources using UTF-8.</p>
1.295 avankest 1739:
1.203 avankest 1740: <hr>
1741:
1.248 avankest 1742: <p>The <dfn id="document-response-entity-body">document response entity
1.330 avankest 1743: body</dfn> is either a <code data-anolis-spec=domcore>Document</code> representing the
1.320 avankest 1744: <span>response entity body</span> or null. If it is a
1.330 avankest 1745: <code data-anolis-spec=domcore>Document</code> its <span data-anolis-spec=html>origin</span> is the
1.320 avankest 1746: <span><code>XMLHttpRequest</code> origin</span>. If the
1.317 avankest 1747: <span>document response entity body</span> has no value assigned to it let
1748: it be the return value of the following algorithm:</p>
1.12 avankest 1749:
1.203 avankest 1750: <ol>
1.309 avankest 1751: <li><p>If the <span>response entity body</span> is null, return null and
1752: terminate these steps.</p></li>
1.12 avankest 1753:
1.248 avankest 1754: <li><p>If <span>final MIME type</span> is not null,
1755: <code>text/xml</code>,
1.295 avankest 1756: <code>application/xml</code>, or does not end in
1.330 avankest 1757: <code title>+xml</code>, return null and terminate these
1.309 avankest 1758: steps.</p></li>
1.248 avankest 1759:
1760:
1.203 avankest 1761:
1762: <li>
1.330 avankest 1763: <p>Let <var title>document</var> be a
1764: <code data-anolis-spec=domcore>Document</code> object that represents the result of parsing the
1.319 avankest 1765: <span>response entity body</span> into a document tree following the
1766: rules set forth in the XML specifications. If that fails
1.265 avankest 1767: (unsupported character encoding, namespace well-formedness error et
1.309 avankest 1768: cetera) return null and terminate these steps.
1.330 avankest 1769: <span data-anolis-ref>XML</span> <span data-anolis-ref>XMLNS</span>
1.248 avankest 1770:
1771: <p class="note">Scripts in the resulting document tree will not be executed,
1772: resources referenced will not be loaded and no associated XSLT will be
1.319 avankest 1773: applied.</p> <!-- XXX more formally?! -->
1.203 avankest 1774: </li>
1.88 avankest 1775:
1.330 avankest 1776: <li><p>Return <var title>document</var>.</p></li>
1.203 avankest 1777: </ol>
1.12 avankest 1778:
1.248 avankest 1779:
1780:
1781:
1.330 avankest 1782: <h4>The <code title>responseText</code> attribute</h4>
1.12 avankest 1783:
1.276 avankest 1784: <dl class="domintro">
1.330 avankest 1785: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-responseText">responseText</code></dt>
1.305 avankest 1786: <dd>
1787: <p>Returns the <span>text response entity body</span>.</p>
1788:
1789: </dd>
1.276 avankest 1790: </dl>
1791:
1792: <p>The
1.331 avankest 1793: <dfn title="dom-XMLHttpRequest-responseText"><code>responseText</code></dfn>
1.330 avankest 1794: attribute must return the result of running these
1.276 avankest 1795: steps:</p>
1.79 avankest 1796:
1.203 avankest 1797: <ol>
1.305 avankest 1798:
1799:
1.272 avankest 1800: <li><p>If the state is not <span title="dom-XMLHttpRequest-LOADING">LOADING</span> or
1801: <span title="dom-XMLHttpRequest-DONE">DONE</span> return the empty string and
1.203 avankest 1802: terminate these steps.</p></li>
1.75 avankest 1803:
1.313 avankest 1804: <li><p>If the <span>error flag</span> is true return the empty string and
1805: terminate these steps.</p></li>
1806:
1.203 avankest 1807: <li><p>Return the <span>text response entity body</span>.</p></li>
1808: </ol>
1.12 avankest 1809:
1810:
1.330 avankest 1811: <h4>The <code title>responseXML</code> attribute</h4>
1.12 avankest 1812:
1.276 avankest 1813: <dl class="domintro">
1.330 avankest 1814: <dt><var title>client</var> . <code title="dom-XMLHttpRequest-responseXML">responseXML</code></dt>
1.305 avankest 1815: <dd>
1816: <p>Returns the <span>document response entity body</span>.</p>
1817:
1818: </dd>
1.276 avankest 1819: </dl>
1820:
1821: <p>The
1.331 avankest 1822: <dfn title="dom-XMLHttpRequest-responseXML"><code>responseXML</code></dfn>
1823: attribute must return the result of running these steps:</p>
1.12 avankest 1824:
1.203 avankest 1825: <ol>
1.305 avankest 1826:
1827:
1.272 avankest 1828: <li><p>If the state is not <span title="dom-XMLHttpRequest-DONE">DONE</span> return
1.239 avankest 1829: null and terminate these steps.</p></li>
1.12 avankest 1830:
1.313 avankest 1831: <li><p>If the <span>error flag</span> is true return null and terminate
1832: these steps.</p></li>
1833:
1.317 avankest 1834: <li><p>Return the <span>document response entity body</span>.</p></li>
1.203 avankest 1835: </ol>
1.121 avankest 1836:
1.248 avankest 1837:
1838:
1.12 avankest 1839:
1.330 avankest 1840: <h2 class=no-num>References</h2>
1841: <h3 class=no-num>Normative references</h3>
1842: <div id=anolis-references-normative></div>
1.248 avankest 1843:
1.330 avankest 1844: <h3 class=no-num>Informative references</h3>
1845: <div id=anolis-references-informative></div>
1.11 avankest 1846:
1.203 avankest 1847:
1848:
1.130 avankest 1849: <h2 class="no-num" id="acknowledgments">Acknowledgments</h2>
1.11 avankest 1850:
1.159 avankest 1851: <p>The editor would like to thank
1.12 avankest 1852:
1.163 avankest 1853: Addison Phillips,
1.159 avankest 1854: Ahmed Kamel,
1855: Alex Hopmann,
1856: Alex Vincent,
1857: Alexey Proskuryakov,
1858: Asbjørn Ulsberg,
1859: Boris Zbarsky,
1860: Björn Höhrmann,
1861: Cameron McCormack,
1.321 avankest 1862: Chris Marrin,
1.159 avankest 1863: Christophe Jolif,
1864: Charles McCathieNevile,
1865: Dan Winship,
1.248 avankest 1866: David Andersson,
1.321 avankest 1867: David Flanagan,
1.159 avankest 1868: David Håsäther,
1.248 avankest 1869: David Levin,
1.159 avankest 1870: Dean Jackson,
1871: Denis Sureau,
1872: Doug Schepers,
1873: Douglas Livingstone,
1874: Elliotte Harold,
1875: Eric Lawrence,
1.321 avankest 1876: Eric Uhrhane,
1.196 avankest 1877: Erik Dahlström,
1.163 avankest 1878: Geoffrey Sneddon,
1.159 avankest 1879: Gideon Cohn,
1880: Gorm Haug Eriksen,
1.247 avankest 1881: Håkon Wium Lie,
1.159 avankest 1882: Hallvord R. M. Steen,
1.328 avankest 1883: Henri Sivonen,
1.247 avankest 1884: Huub Schaeks,
1.159 avankest 1885: Ian Davis,
1886: Ian Hickson,
1887: Ivan Herman,
1888: Jeff Walden,
1889: Jens Lindström,
1890: Jim Deegan,
1891: Jim Ley,
1892: Joe Farro,
1893: Jonas Sicking,
1894: Julian Reschke,
1895: Karl Dubost,
1.175 avankest 1896: Lachlan Hunt,
1.159 avankest 1897: Maciej Stachowiak,
1898: Magnus Kristiansen,
1899: Marc Hadley,
1900: Marcos Caceres,
1901: Mark Baker,
1.203 avankest 1902: Mark Birbeck,
1.159 avankest 1903: Mark Nottingham,
1.267 avankest 1904: Mark S. Miller,
1.248 avankest 1905: Martin Hassman,
1.159 avankest 1906: Mohamed Zergaoui,
1.256 avankest 1907: Olli Pettay,
1.159 avankest 1908: Pawel Glowacki,
1.231 avankest 1909: Peter Michaux,
1.264 avankest 1910: Philip Taylor,
1.159 avankest 1911: Robin Berjon,
1.248 avankest 1912: Rune Halvorsen,
1.159 avankest 1913: Ruud Steltenpool,
1.310 avankest 1914: Sergiu Dumitriu,
1.159 avankest 1915: Simon Pieters,
1916: Stewart Brodie,
1917: Sunava Dutta,
1.186 avankest 1918: Thomas Roessler,
1.203 avankest 1919: Tom Magliery, and
1.159 avankest 1920: Zhenbin Xu
1.181 avankest 1921:
1.159 avankest 1922: for their contributions to this specification.</p>
1.12 avankest 1923:
1.1 avankest 1924: <p>Special thanks to the Microsoft employees who first implemented the
1.330 avankest 1925: <code title>XMLHttpRequest</code> interface, which was first widely
1.143 avankest 1926: deployed by the Windows Internet Explorer browser.</p>
1.12 avankest 1927:
1.143 avankest 1928: <p>Special thanks also to the WHATWG for drafting an initial version of
1929: this specification in their Web Applications 1.0 document (now renamed to
1.330 avankest 1930: HTML). <span data-anolis-ref>HTML</span></p>
1.12 avankest 1931:
1.143 avankest 1932: <p>Thanks also to all those who have helped to improve this specification
1933: by sending suggestions and corrections. (Please, keep bugging us with your
1.22 avankest 1934: issues!)</p>
1.1 avankest 1935: </body>
1936: </html>
Webmaster