Annotation of 2006/webapi/XMLHttpRequest/Overview.src.html, revision 1.196
1.60 avankest 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
1.1 avankest 2: <html lang="en-US">
3: <head>
4: <title>The XMLHttpRequest Object</title>
1.16 avankest 5: <style type="text/css">
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.89 avankest 12: .issue { padding:.5em; border:solid #f00 }
1.16 avankest 13: p.issue::before { content:"Issue: " }
1.119 avankest 14: dl.switch { padding-left:2em }
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.16 avankest 17: em.ct { text-transform:lowercase; font-variant:small-caps; font-style:normal }
18: dfn { font-weight:bold; font-style:normal }
19: code { color:orangered }
20: code :link, code :visited { color:inherit }
1.122 avankest 21: h1 code, h2 code, h3 code { color:inherit; background:inherit; font:inherit }
1.16 avankest 22: </style>
1.147 avankest 23: <link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/W3C-[STATUS]">
1.1 avankest 24: </head>
25: <body>
26: <div class="head">
27: <p><a href="http://www.w3.org/"><img height="48" width="72" alt="W3C" src="http://www.w3.org/Icons/w3c_home"></a></p>
1.12 avankest 28:
1.156 avankest 29: <h1 class="head" id="the-xmlhttprequest-object">The
30: <code title="">XMLHttpRequest</code> Object</h1>
1.12 avankest 31:
1.149 avankest 32: <h2 class="no-num no-toc" id="w3c-doctype">[LONGSTATUS] [DATE: 3 August 2002]</h2>
1.12 avankest 33:
1.1 avankest 34: <dl>
1.10 avankest 35: <dt>This Version:</dt>
1.173 avankest 36: <dd><a href="[VERSION]/">http://www.w3.org/TR/[YEAR]/ED-XMLHttpRequest-[CDATE]/</a></dd>
1.14 avankest 37:
1.10 avankest 38: <dt>Latest Version:</dt>
1.1 avankest 39: <dd><a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a></dd>
1.189 avankest 40:
41: <dt>Latest Editor Version:</dt>
42: <dd><a href="http://dev.w3.org/2006/webapi/XMLHttpRequest/">http://dev.w3.org/2006/webapi/XMLHttpRequest/</a></dd>
1.14 avankest 43:
1.10 avankest 44: <dt>Previous Versions:</dt>
1.173 avankest 45: <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 46: <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 47: <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 48: <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 49: <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 50: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/</a></dd>
51: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060405/</a></dd>
1.14 avankest 52:
1.1 avankest 53: <dt>Editor:</dt>
54: <dd><a href="http://annevankesteren.nl/">Anne van Kesteren</a>
55: (<a href="http://www.opera.com/">Opera Software ASA</a>)
56: <<a href="mailto:annevk@opera.com">annevk@opera.com</a>></dd>
57: </dl>
1.14 avankest 58:
1.1 avankest 59: <p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a>
1.51 avankest 60: © 2007
61: <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a><sup>®</sup>
62: (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>,
63: <a href="http://www.ercim.org/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>,
64: <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C
65: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
66: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>
67: and
68: <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document
69: use</a> rules apply.</p>
1.1 avankest 70: </div>
1.12 avankest 71:
1.1 avankest 72: <hr>
1.12 avankest 73:
1.1 avankest 74: <h2 class="no-num no-toc" id="specabstract">Abstract</h2>
1.10 avankest 75:
1.22 avankest 76: <p>The <code title="">XMLHttpRequest</code> Object specification defines an
77: <abbr title="Application Programming Interface">API</abbr> that provides
78: scripted client functionality for transferring data between a client and a
79: server.</p>
1.12 avankest 80:
1.1 avankest 81: <h2 class="no-num no-toc" id="sotd">Status of this Document</h2>
1.12 avankest 82:
1.1 avankest 83: <p><em>This section describes the status of this document at the time of its
1.36 avankest 84: publication. Other documents may supersede this document. A list of current
85: W3C publications and the latest revision of this technical report can be
86: found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a>
1.117 avankest 87: at http://www.w3.org/TR/.</em></p>
1.36 avankest 88:
1.172 avankest 89: <p>This is the [DATE: 3 August 2002] Last Call Working Draft of The
1.147 avankest 90: <code title="">XMLHttpRequest</code> Object specification. Please send
91: comments to <a href="mailto:public-webapi@w3.org">public-webapi@w3.org</a>
1.47 avankest 92: (<a href="http://lists.w3.org/Archives/Public/public-webapi/">archived</a>)
1.172 avankest 93: with either <samp>[XHR]</samp> or <samp title="">[XMLHttpRequest]</samp>
94: at the start of the subject line before befor 2 June 2008.</p>
1.51 avankest 95:
1.47 avankest 96: <p>This document is produced by the
97: <a href="http://www.w3.org/2006/webapi/">Web API Working Group</a>, part of
98: the <a href="http://www.w3.org/2006/rwc/Activity">Rich Web Clients
99: Activity</a> in the W3C <a href="http://www.w3.org/Interaction/">Interaction
1.51 avankest 100: Domain</a>. Changes made to this document can be found in the
1.47 avankest 101: <a href="http://dev.w3.org/cvsweb/2006/webapi/XMLHttpRequest/Overview.html">W3C
1.117 avankest 102: public CVS server</a>.</p>
1.12 avankest 103:
1.1 avankest 104: <p>Publication as a Working Draft does not imply endorsement by the W3C
1.36 avankest 105: Membership. This is a draft document and may be updated, replaced or
106: obsoleted by other documents at any time. It is inappropriate to cite this
107: document as other than work in progress.</p>
1.12 avankest 108:
1.1 avankest 109: <p>This document was produced by a group operating under the
1.36 avankest 110: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February
1.52 avankest 111: 2004 W3C Patent Policy</a>. W3C maintains a
1.36 avankest 112: <a rel="disclosure" href="http://www.w3.org/2004/01/pp-impl/38482/status">public
113: list of any patent disclosures</a> made in connection with the deliverables
114: of the group; that page also includes instructions for disclosing a patent.
115: An individual who has actual knowledge of a patent which the individual
116: believes contains
117: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential
118: Claim(s)</a> must disclose the information in accordance with
119: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section
120: 6 of the W3C Patent Policy</a>.</p>
1.12 avankest 121:
1.1 avankest 122: <h2 class="no-num no-toc" id="toc">Table of Contents</h2>
1.21 avankest 123:
1.1 avankest 124: <!--toc-->
1.12 avankest 125:
1.1 avankest 126: <h2 id="introduction">Introduction</h2>
1.12 avankest 127:
1.1 avankest 128: <p><em>This section is non-normative.</em></p>
1.12 avankest 129:
1.183 avankest 130: <p>The <code>XMLHttpRequest</code> object implements an interface exposed
131: by a scripting engine that allows scripts to perform HTTP client
132: functionality, such as submitting form data or loading data from a
133: server. It is the ECMAScript HTTP API.</p>
1.24 avankest 134:
1.1 avankest 135: <p>The name of the object is <code>XMLHttpRequest</code> for compatibility
1.183 avankest 136: with the Web, though each component of this name is potentially
137: misleading. First, the object supports any text based format, including
138: XML. Second, it can be used to make requests over both HTTP and HTTPS
139: (some implementations support protocols in addition to HTTP and HTTPS, but
140: that functionality is not covered by this specification). Finally, it
141: supports "requests" in a broad sense of the term as it pertains to HTTP;
142: namely all activity involved with HTTP requests or responses for the
143: defined HTTP methods.</p>
1.12 avankest 144:
1.14 avankest 145: <div class="example">
146: <p>Some simple code to do something with data from an XML document fetched
1.22 avankest 147: over the network:</p>
1.16 avankest 148:
1.58 avankest 149: <pre><code>function test(data) {
1.14 avankest 150: // taking care of data
151: }
152:
153: function handler() {
1.117 avankest 154: if(this.readyState == 4 && this.status == 200) {
1.14 avankest 155: // so far so good
1.117 avankest 156: if(this.responseXML != null && this.responseXML.getElementById('test').firstChild.data)
157: // success!
1.14 avankest 158: test(this.responseXML.getElementById('test').firstChild.data);
159: else
160: test(null);
1.117 avankest 161: } else if (this.readyState == 4 && this.status != 200) {
1.14 avankest 162: // fetched the wrong page or network error...
163: test(null);
164: }
165: }
1.12 avankest 166:
1.14 avankest 167: var client = new XMLHttpRequest();
168: client.onreadystatechange = handler;
169: client.open("GET", "test.xml");
1.58 avankest 170: client.send();</code></pre>
1.16 avankest 171:
1.56 avankest 172: <p>If you just want to log a message to the server:</p>
1.16 avankest 173:
1.58 avankest 174: <pre><code>function log(message) {
1.14 avankest 175: var client = new XMLHttpRequest();
1.56 avankest 176: client.open("POST", "/log");
1.57 avankest 177: client.setRequestHeader("Content-Type", "text/plain;charset=UTF-8");
1.14 avankest 178: client.send(message);
1.58 avankest 179: }</code></pre>
1.16 avankest 180:
1.14 avankest 181: <p>Or if you want to check the status of a document on the server:</p>
1.16 avankest 182:
1.58 avankest 183: <pre><code>function fetchStatus(address) {
1.14 avankest 184: var client = new XMLHttpRequest();
185: client.onreadystatechange = function() {
186: // in case of network errors this might not give reliable results
187: if(this.readyState == 4)
188: returnStatus(this.status);
189: }
190: client.open("HEAD", address);
191: client.send();
1.58 avankest 192: }</code></pre>
1.14 avankest 193: </div>
1.12 avankest 194:
1.153 avankest 195: <h2 id="conformance">Conformance</h2>
1.12 avankest 196:
1.27 avankest 197: <p>Everything in this specification is normative except for diagrams,
198: examples, notes and sections marked non-normative.</p>
1.12 avankest 199:
1.1 avankest 200: <p>The key words <em class="ct">must</em>, <em class="ct">must not</em>,
1.74 avankest 201: <em class="ct">should</em> and <em class="ct">may</em> in this document are
202: to be interpreted as described in RFC 2119.
203: [<cite><span>RFC2119</span></cite>]</p>
1.12 avankest 204:
1.1 avankest 205: <p>This specification defines the following classes of products:</p>
1.12 avankest 206:
1.1 avankest 207: <dl>
1.74 avankest 208: <dt><dfn id="conforming-user-agent">Conforming user agent</dfn></dt>
1.24 avankest 209:
1.74 avankest 210: <dd>
211: <p>A user agent <em class="ct">must</em> behave as described in this
1.106 avankest 212: specification in order to be considered conformant.</p>
1.95 avankest 213:
1.140 avankest 214: <p>If the user agent is not a conforming XML user agent the <span>XML
215: response entity body</span> <em class="ct">must</em> (always) be
216: <code>null</code>.</p>
217:
218: <p>User agents <em class="ct">may</em> implement algorithms given in
219: this specification in any way desired, so long as the end result is
220: indistinguishable from the result that would be obtained by the
221: specification's algorithms.</p>
1.110 avankest 222:
1.95 avankest 223: <p class="note">This specification uses both the terms "conforming user
224: agent(s)" and "user agent(s)" to refer to this product class.</p>
1.74 avankest 225: </dd>
1.110 avankest 226:
1.94 avankest 227: <dt><dfn id="conforming-xml-user-agent">Conforming XML user agent</dfn></dt>
1.110 avankest 228:
1.163 avankest 229: <dd><p>An XML user agent <em class="ct">must</em> be a <span>conforming
230: user agent</span> and <em class="ct">must</em> be a conforming XML
231: processor that reports violations of namespace well-formedness.
232: [<cite><span>XML</span></cite>]
1.140 avankest 233: [<cite><span>XMLNS</span></cite>]</p></dd>
1.1 avankest 234: </dl>
1.32 avankest 235:
1.153 avankest 236: <h3 id="dependencies">Dependencies</h3>
1.33 avankest 237:
1.29 avankest 238: <p>This specification relies on several underlying specifications.</p>
239: <dl>
240: <dt>DOM</dt>
1.33 avankest 241:
1.155 avankest 242: <dd><p>A <span title="conforming user agent">conforming user agent</span>
1.176 avankest 243: <em class="ct">must</em> support at least the subset of the functionality
1.182 avankest 244: defined in DOM Events and DOM Core that this specification relies upon,
245: such as various exceptions and <code>EventTarget</code>.
1.155 avankest 246: [<cite><span>DOM2Events</span></cite>]
247: [<cite><span>DOM3Core</span></cite>]</p></dd>
1.29 avankest 248:
1.161 avankest 249: <dt>HTML 5</dt>
250:
251: <dd>
1.189 avankest 252: <p>A <span>conforming user agent</span> <em class="ct">must</em> support
253: at least the subset of the functionality defined in HTML 5 that
254: this specification relies upon, such as the <code>Window</code> object
255: and serializing a <code>Document</code> object.
1.161 avankest 256: [<cite><span>HTML5</span></cite>]</p>
257:
258: <p class="note">The
259: <a href="http://www.w3.org/TR/2006/WD-Window-20060407/">Window Object
260: 1.0</a> draft is not referenced normatively as it appears to be no
261: longer maintained and HTML 5 defines the <code>Window</code> object
262: in more detail. This specification already depends on HTML 5 for
263: other reasons so there is not much additional overhead because of
264: this.</p>
265:
1.29 avankest 266: <dt>HTTP</dt>
1.33 avankest 267:
1.29 avankest 268: <dd>
1.155 avankest 269: <p>A <span>conforming user agent</span>
1.126 avankest 270: <em class="ct">must</em> support some version of the HTTP protocol. It
271: <em class="ct">should</em> support any HTTP method that matches the
1.149 avankest 272: <span><code>Method</code> production</span> and <em class="ct">must</em>
273: at least support the following methods:</p>
1.58 avankest 274:
275: <ul>
276: <li><code>GET</code></li>
277: <li><code>POST</code></li>
278: <li><code>HEAD</code></li>
279: <li><code>PUT</code></li>
280: <li><code>DELETE</code></li>
281: <li><code>OPTIONS</code></li>
282: </ul>
1.135 avankest 283:
1.58 avankest 284: <p>Other requirements regarding HTTP are made throughout the
1.39 avankest 285: specification. [<cite><span>RFC2616</span></cite>]</p>
1.29 avankest 286: </dd>
1.189 avankest 287:
1.181 avankest 288: <dt>Web IDL</dt>
289:
290: <dd>A <span>conforming user agent</span> <em class="ct">must</em> also be
291: a conforming implementation of the IDL fragment in this specification, as
292: described in the Web IDL specification.
293: [<cite><span>WebIDL</span></cite>]
1.29 avankest 294: </dl>
1.12 avankest 295:
1.157 avankest 296:
1.153 avankest 297: <h3 id="terminology">Terminology</h3>
1.12 avankest 298:
1.80 avankest 299: <p>There is a <dfn id="case-insensitive-match">case-insensitive match</dfn>
1.153 avankest 300: of strings <var>s1</var> and <var>s2</var> if after mapping the ASCII
301: character range A-Z to the range a-z both strings are identical.</p>
1.144 avankest 302:
1.184 avankest 303: <p>The terms <dfn id="origin">origin</dfn>,
304: <dfn id="same-origin">same origin</dfn>, and
1.157 avankest 305: <dfn id="event-handler-attribute">event handler DOM attribute</dfn> are
306: defined by the HTML 5 specification.
307: [<cite><span>HTML5</span></cite>]</p>
1.155 avankest 308:
1.80 avankest 309:
1.153 avankest 310: <h3 id="extensibility">Extensibility</h3>
1.12 avankest 311:
1.81 avankest 312: <p>Extensions of the API defined by this specification are <em>strongly
1.22 avankest 313: discouraged</em>. User agents, Working Groups and other interested parties
1.33 avankest 314: should discuss extensions on a relevant public forum, preferably
1.22 avankest 315: <a href="mailto:public-webapi@w3.org">public-webapi@w3.org</a>.</p>
1.12 avankest 316:
1.153 avankest 317:
1.157 avankest 318:
1.153 avankest 319: <h2 id="security">Security Considerations</h2>
320:
1.154 avankest 321: <p>Apart from requirements affecting security made throughout this
322: specification implementations <em class="ct">may</em>, at their
1.175 avankest 323: discretion, not expose certain headers, such as headers containing
1.177 avankest 324: HttpOnly cookies. [<cite><span>HTTPONLY</span></cite>]</p>
1.153 avankest 325:
326:
1.157 avankest 327:
1.153 avankest 328: <h2 id="xmlhttprequest">The <code title="">XMLHttpRequest</code>
329: Object</h2>
1.12 avankest 330:
1.58 avankest 331: <p>The <code>XMLHttpRequest</code> object can be used by scripts to
1.22 avankest 332: programmatically connect to their originating server via HTTP.</p>
1.12 avankest 333:
1.1 avankest 334: <p>Objects implementing the <code>XMLHttpRequest</code> interface
1.22 avankest 335: <em class="ct">must</em> also implement the <code>EventTarget</code>
1.155 avankest 336: interface. [<cite><span>DOM2Events</span></cite>]</p>
1.12 avankest 337:
1.58 avankest 338: <p>Objects implementing the <code title="">Window</code> interface
339: <em class="ct">must</em> provide an <code title="">XMLHttpRequest()</code>
1.155 avankest 340: constructor. [<cite><span>HTML5</span></cite>]</p>
1.12 avankest 341:
1.1 avankest 342: <div class="example">
1.58 avankest 343: <p>In ECMAScript this can be used as follows:</p>
344:
345: <pre><code>var client = new XMLHttpRequest();</code></pre>
1.1 avankest 346: </div>
1.12 avankest 347:
1.150 avankest 348: <p>When the <code title="">XMLHttpRequest()</code> constructor is invoked
1.157 avankest 349: a persistent pointer to the associated <code title="">Document</code>
350: object is stored on the newly created object. This is the
351: <dfn title="Document pointer" id="document-pointer"><code>Document</code>
352: pointer</dfn>. The associated <code>Document</code> object is the one
353: returned by the <code>document</code> attribute from the object on which
354: the <code title="">XMLHttpRequest()</code> constructor was invoked (a
355: <code>Window</code> object). The pointer can become "null" if the
356: object is destroyed.</p>
357:
358: <p class="note">As per the conformance criteria implementations are free
1.195 avankest 359: to implement the <code>Document</code> pointer in any way they desire as
360: long as the end results are identical to those given by the English
361: prose.</p>
1.27 avankest 362:
1.58 avankest 363: <div class="example">
1.157 avankest 364: <p>If <var><code>iframe</code></var> is a <code title="">Window</code>
1.175 avankest 365: object, <var><code>client</code></var> will have a pointer to
1.157 avankest 366: <var><code>iframe.document</code></var> in the following example:</p>
1.58 avankest 367:
1.157 avankest 368: <pre><code>var client = new iframe.XMLHttpRequest()</code></pre>
1.58 avankest 369: </div>
1.12 avankest 370:
1.181 avankest 371: <pre class="idl">[Constructor] interface <dfn id="xmlhttprequest-object">XMLHttpRequest</dfn> {
1.58 avankest 372: // event handler
1.70 avankest 373: attribute EventListener <span>onreadystatechange</span>;
1.58 avankest 374:
375: // state
1.71 avankest 376: const unsigned short <span title="UNSENT state">UNSENT</span> = 0;
1.134 avankest 377: const unsigned short <span title="OPENED state">OPENED</span> = 1;
1.123 avankest 378: const unsigned short <span title="HEADERS_RECEIVED state">HEADERS_RECEIVED</span> = 2;
1.86 avankest 379: const unsigned short <span title="LOADING state">LOADING</span> = 3;
1.117 avankest 380: const unsigned short <span title="DONE state">DONE</span> = 4;
1.70 avankest 381: readonly attribute unsigned short <span>readyState</span>;
1.58 avankest 382:
383: // request
1.70 avankest 384: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>);
385: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>);
1.181 avankest 386: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>, [Null=Null, Undefined=Null] in DOMString <var>user</var>);
387: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>, [Null=Null, Undefined=Null] in DOMString <var>user</var>, [Null=Null, Undefined=Null] in DOMString <var>password</var>);
1.70 avankest 388: void <span>setRequestHeader</span>(in DOMString <var>header</var>, in DOMString <var>value</var>);
389: void <span>send</span>();
1.181 avankest 390: void <span>send</span>([Null=Null, Undefined=Null] in DOMString <var>data</var>);
1.70 avankest 391: void <span>send</span>(in Document <var>data</var>);
392: void <span>abort</span>();
1.58 avankest 393:
394: // response
1.70 avankest 395: DOMString <span>getAllResponseHeaders</span>();
396: DOMString <span>getResponseHeader</span>(in DOMString <var>header</var>);
397: readonly attribute DOMString <span>responseText</span>;
398: readonly attribute Document <span>responseXML</span>;
399: readonly attribute unsigned short <span>status</span>;
400: readonly attribute DOMString <span>statusText</span>;
1.1 avankest 401: };</pre>
1.8 avankest 402:
1.58 avankest 403: <p>The <code>XMLHttpRequest</code> object can be in five states:
1.71 avankest 404: <span title="UNSENT state">UNSENT</span>,
1.134 avankest 405: <span title="OPENED state">OPENED</span>,
1.123 avankest 406: <span title="HEADERS_RECEIVED state">HEADERS_RECEIVED</span>,
1.86 avankest 407: <span title="LOADING state">LOADING</span> and
1.79 avankest 408: <span title="DONE state">DONE</span>. The current state is exposed through
409: the <code>readyState</code> attribute. The method definitions below define
410: when a state transition takes place.</p>
1.58 avankest 411:
412: <p>When constructed, the <code>XMLHttpRequest</code> object
1.71 avankest 413: <em class="ct">must</em> be in the UNSENT state. This state is represented
1.134 avankest 414: by the <dfn id="unsent-state" title="UNSENT state"><code>UNSENT</code></dfn>
1.58 avankest 415: constant, whose value is <code>0</code>.</p>
416:
1.134 avankest 417: <p>The OPENED state is the state of the object when the <code>open()</code>
1.184 avankest 418: method has been successfully invoked. During this state
419: <span>author request headers</span> can
1.58 avankest 420: be set using <code>setRequestHeader()</code> and the request can be made
421: using <code>send()</code>. This state is represented by the
1.134 avankest 422: <dfn id="opened-state" title="OPENED state"><code>OPENED</code></dfn> constant,
1.131 avankest 423: whose value is <code>1</code>.</p>
1.58 avankest 424:
1.134 avankest 425: <p>The OPENED state has an associated <dfn id="send-flag"><code>send()</code>
1.185 avankest 426: flag</dfn> that indicates whether the <code>send()</code> method has been
1.174 avankest 427: invoked. It can be either "true" or "false" and has an initial value of
428: "false".</p>
1.87 avankest 429:
1.123 avankest 430: <p>The HEADERS_RECEIVED state is the state of the object when all response
431: headers have been received. This state is represented by the
1.131 avankest 432: <dfn id="headers-received-state" title="HEADERS_RECEIVED state"><code>HEADERS_RECEIVED</code></dfn>
1.123 avankest 433: constant, whose value is <code>2</code>.</p>
434:
435: <p>The LOADING state is the state of the object when the response entity body
436: is being received. This state is represented by the
1.131 avankest 437: <dfn id="loading-state" title="LOADING state"><code>LOADING</code></dfn> constant,
1.86 avankest 438: whose value is <code>3</code>.</p>
1.58 avankest 439:
1.79 avankest 440: <p>The DONE state is the state of the object when either the data transfer
1.58 avankest 441: has been completed or something went wrong during the transfer (infinite
442: redirects for instance). This state is represented by the
1.131 avankest 443: <dfn id="done-state" title="DONE state"><code>DONE</code></dfn> constant,
444: whose value is <code>4</code>.</p>
1.90 avankest 445:
1.124 avankest 446: <p>The DONE state has an associated <dfn id="error-flag">error flag</dfn>
1.185 avankest 447: that indicates some type of network error or abortion. It can be either
1.174 avankest 448: "true" or "false" and has an initial value of "false".</p>
1.124 avankest 449:
1.88 avankest 450: <p>The <dfn id="response-entity-body">response entity body</dfn> is the
451: fragment of the <span>entity body</span> received so far (LOADING state) or
452: the complete entity body (DONE state). If there is no entity body the
453: response entity body is "null".</p>
454:
455: <p>The <dfn id="text-response-entity-body">text response entity body</dfn>
1.169 avankest 456: is a <code>DOMString</code> representing the <span>response entity
457: body</span>. The text response entity body is the return value of the
458: following algorithm:</p>
1.90 avankest 459:
1.88 avankest 460: <ol>
1.167 avankest 461: <li><p>If the response entity body is "null" return the empty string and
1.107 avankest 462: terminate these steps.</p>
1.90 avankest 463:
1.113 avankest 464: <li><p>Let <var>charset</var> be "null".</p></li>
1.90 avankest 465:
466: <li><p>If there is no <code>Content-Type</code> header or there is a
467: <code>Content-Type</code> header which contains a MIME type that is
1.116 avankest 468: <code>text/xml</code>, <code>application/xml</code> or ends in
1.167 avankest 469: <code title="">+xml</code> (ignoring any parameters) use the rules set
470: forth in the XML specifications to determine the character encoding. Let
1.195 avankest 471: <var>charset</var> be the determined character encoding.
472: [<cite><span>XML</span></cite>] [<cite><span>XMLNS</span></cite>]
473: </p></li>
1.90 avankest 474:
1.185 avankest 475: <li><p>If the <code>Content-Type</code> header contains a
1.145 avankest 476: <code>text/html</code> MIME type follow the rules set forth in the
477: HTML 5 specification to determine the character encoding. Let
478: <var>charset</var> be the determined character encoding.
479: [<cite><span>HTML5</span></cite>]</p></li>
1.118 avankest 480:
1.115 avankest 481: <li>
1.140 avankest 482: <p>If the MIME type specified by the <code>Content-Type</code> header
483: contains a <code>charset</code> parameter and <var>charset</var> is
484: "null" let <var>charset</var> be the value of that parameter.</p>
1.118 avankest 485:
1.145 avankest 486: <p class="note">The algorithms described by the XML and HTML
487: specifications already take <code>Content-Type</code> into account.</p>
1.115 avankest 488: </li>
1.118 avankest 489:
1.111 avankest 490: <li>
491: <!-- This stuff is copied from HTML5. Thanks Hixie! -->
1.113 avankest 492: <p>If <var>charset</var> is "null" then, for each of the rows in the
1.127 avankest 493: following table, starting with the first one and going down, if the first
494: bytes of <var>bytes</var> match the bytes given in the first column, then
495: let <var>charset</var> be the encoding given in the cell in the second
496: column of that row. If there is no match <var>charset</var> remains
497: "null".</p>
1.117 avankest 498:
499: <table>
500: <thead>
501: <tr>
1.111 avankest 502: <th>Bytes in Hexadecimal
503: <th>Description
1.188 avankest 504: <tbody><!-- UTF-32 is dead
1.117 avankest 505: <tr>
1.111 avankest 506: <td>00 00 FE FF
1.117 avankest 507: <td>UTF-32BE BOM
508: <tr>
509: <td>FF FE 00 00
1.188 avankest 510: <td>UTF-32LE BOM-->
1.117 avankest 511: <tr>
512: <td>FE FF
513: <td>UTF-16BE BOM
514: <tr>
515: <td>FF FE
516: <td>UTF-16LE BOM
517: <tr>
518: <td>EF BB BF
519: <td>UTF-8 BOM<!-- nobody uses this
520: <tr>
521: <td>DD 73 66 73
522: <td>UTF-EBCDIC
523: -->
524: </table>
1.111 avankest 525: </li>
526:
1.113 avankest 527: <li><p>If <var>charset</var> is "null" let <var>charset</var> be
528: UTF-8.</p></li>
529:
1.107 avankest 530: <li><p>Return the result of decoding the response entity body using
1.167 avankest 531: <var>charset</var>. Replace bytes or sequences of bytes that are not
1.173 avankest 532: valid according to the <var>charset</var> with a single U+FFFD
1.192 avankest 533: REPLACEMENT CHARACTER character.</p></li>
1.88 avankest 534: </ol>
1.90 avankest 535:
1.185 avankest 536: <p class="note">Authors are encouraged to encode their resources using
537: UTF-8.</p>
1.163 avankest 538:
1.88 avankest 539: <p>The <dfn id="xml-response-entity-body">XML response entity body</dfn> is
1.107 avankest 540: either a <code>Document</code> representing the <span>response entity
1.126 avankest 541: body</span> or <code>null</code>. The XML response entity body is the return
542: value of the following algorithm:</p>
1.90 avankest 543:
1.88 avankest 544: <ol>
1.107 avankest 545: <li><p>If the response entity body is "null" terminate these steps and
546: return <code>null</code>.</p></li>
1.88 avankest 547:
1.103 avankest 548: <li><p>If a <code>Content-Type</code> is present and it does not contain a
549: MIME type (ignoring any parameters) that is <code>text/xml</code>,
1.116 avankest 550: <code>application/xml</code> or ends in <code title="">+xml</code> terminate
551: these steps and return <code>null</code>. (Do not terminate these steps if
552: there is no <code>Content-Type</code> header at all.)</p></li>
1.88 avankest 553:
1.128 avankest 554: <li>
555: <p>Parse the response entity body into a document tree following the
556: rules from the XML specifications. Let the result be <var>parsed
557: document</var>. If this fails (unsupported character encoding, namespace
1.196 ! avankest 558: well-formedness error, et cetera) terminate these steps return
1.128 avankest 559: <code>null</code>. [<cite><span>XML</span></cite>]
560: [<cite><span>XMLNS</span></cite>]</p>
1.167 avankest 561:
562: <p class="note">Scripts in the resulting document tree will not be
563: executed, resources referenced will not be loaded and no associated XSLT
564: will be applied.</p>
1.128 avankest 565: </li>
1.88 avankest 566:
1.96 avankest 567: <li><p>Return an object implementing the <code>Document</code>
1.88 avankest 568: interface representing the <var>parsed document</var>.</p></li>
569: </ol>
1.58 avankest 570:
1.5 avankest 571: <dl>
1.131 avankest 572: <dt><dfn id="onreadystatechange"><code>onreadystatechange</code></dfn>
1.39 avankest 573: of type <code>EventListener</code></dt>
1.12 avankest 574:
1.157 avankest 575: <dd><p>This attribute is an <span>event handler DOM attribute</span> and
576: <em class="ct">must</em> be invoked whenever a
1.173 avankest 577: <code>readystatechange</code> event is targeted at the object.</p></dd>
1.12 avankest 578:
1.131 avankest 579: <dt><dfn id="readystate"><code>readyState</code></dfn> of type
1.22 avankest 580: <code>unsigned short</code>, readonly</dt>
1.12 avankest 581:
1.185 avankest 582: <dd><p>On getting, the attribute <em class="ct">must</em> return the
583: value of the constant corresponding to the object's current
584: state.</p></dd>
1.12 avankest 585:
1.131 avankest 586: <dt><dfn id="open" title="open"><code>open(<var>method</var>,
1.22 avankest 587: <var>url</var>, <var>async</var>, <var>user</var>,
588: <var>password</var>)</code></dfn>, method</dt>
1.12 avankest 589:
1.1 avankest 590: <dd>
1.58 avankest 591: <p>When invoked, the user agent <em class="ct">must</em> follow the
1.96 avankest 592: following steps (unless otherwise indicated):</p>
1.58 avankest 593:
594: <ol>
1.156 avankest 595: <li><p>Let <var>stored method</var> be the <var>method</var>
596: argument.</p></li>
1.58 avankest 597:
1.156 avankest 598: <li><p>If <var>stored method</var> does not match the
599: <dfn><code>Method</code> production</dfn>, defined in section 5.1.1 of
600: RFC 2616, raise a <code>SYNTAX_ERR</code> exception and terminate these
601: steps. [<cite><span>RFC2616</span></cite>]</p></li>
1.58 avankest 602:
1.183 avankest 603: <li>
604: <p>If <var>stored method</var>
605: <span title="case-insensitive match">case-insensitively matches</span>
606: <code>CONNECT</code>, <code>DELETE</code>, <code>GET</code>,
607: <code>HEAD</code>, <code>OPTIONS</code>, <code>POST</code>,
608: <code>PUT</code>, <code>TRACE</code>, or <code>TRACK</code> let
609: <var>stored method</var> be the canonical uppercase form of the
610: matched method name.</p>
611:
612: <p class="note">If it does not match any of the above, it is passed
613: through literally, including in the final request.</p>
614: </li>
1.156 avankest 615: <!-- WebKit (and supposedly Firefox) also uppercase: COPY, INDEX, LOCK,
616: M-POST, MKCOL, MOVE, PROPFIND, PROPPATCH, and UNLOCK. -->
1.58 avankest 617:
1.176 avankest 618: <li>
619: <p>If <var>stored method</var> is one of <code>CONNECT</code>,
620: <code>TRACE</code>, or <code>TRACK</code> the user agent
621: <em class="ct">should</em> raise a <code>SECURITY_ERR</code> exception
622: and terminate these steps.</p>
1.189 avankest 623:
1.176 avankest 624: <p class="note"><code>TRACK</code> poses a security issue to legacy
625: server deployments.</p>
626: </li>
1.58 avankest 627:
1.187 avankest 628: <li><p>If <var>stored url</var> is a relative reference as defined by
1.189 avankest 629: RFC 3987, resolve it using
1.96 avankest 630: the current value of the <code>baseURI</code> attribute of the
1.157 avankest 631: <span><code>Document</code> pointer</span>. If this fails raise a
1.187 avankest 632: <code>SYNTAX_ERR</code> exception and terminate these steps.
633: [<cite><span>RFC3987</span></cite>]</p></li>
634:
1.191 avankest 635: <li><p>Convert <var>stored url</var> to a URI as defined by section 3.1
1.196 ! avankest 636: of RFC 3987. If this fails (the ToASCII operation fails for instance),
! 637: raise a <code>SYNTAX_ERR</code> exception and terminate these steps.
1.191 avankest 638: [<cite><span>RFC3987</span></cite>]</p></li>
639:
1.187 avankest 640: <li><p>Drop the fragment identifier (if any) from <var>url</var> and
641: let <var>stored url</var> be the result of that operation.</p></li>
1.58 avankest 642:
1.101 avankest 643: <li><p>If <var>stored url</var> contains an unsupported scheme raise a
644: <code>NOT_SUPPORTED_ERR</code> and terminate these steps.</p></li>
1.110 avankest 645:
1.58 avankest 646: <li><p>If the <code>"user:password"</code> format in the
1.141 avankest 647: <code>userinfo</code> production defined in section 3.2.1 of RFC 3986
648: is not supported for the relevant scheme and <var>stored url</var>
649: contains this format raise a <code>SYNTAX_ERR</code> and terminate
650: these steps. [<cite><span>RFC3986</span></cite>]</p></li>
1.58 avankest 651:
652: <li><p>If <var>stored url</var> contains the <code>"user:password"</code>
653: format let <var>stored user</var> be the user part and <var>stored
654: password</var> be the password part.</p></li>
655:
656: <li><p>If <var>stored url</var> just contains the <code>"user"</code>
657: format let <var>stored user</var> be the user part.</p></li>
658:
1.184 avankest 659: <li><p>If <var>stored url</var> is not of the <span>same origin</span>
1.157 avankest 660: as the <span>origin</span> of the <span><code>Document</code>
661: pointer</span> the user agent <em class="ct">should</em> raise a
662: <code>SECURITY_ERR</code> exception and terminate these steps.</p></li>
1.58 avankest 663:
1.145 avankest 664: <li><p>Let <var>async</var> be the value of the <var>async</var>
665: argument or <code>true</code> if it was omitted.</p></li>
1.58 avankest 666:
1.126 avankest 667: <li><p>If the <var>user</var> argument was not omitted, and its syntax
1.145 avankest 668: does not match that specified by the relevant authentication scheme,
669: raise a <code>SYNTAX_ERR</code> exception and terminate these
670: steps.</p></li>
1.14 avankest 671:
1.58 avankest 672: <li>
673: <p>If the <var>user</var> argument was not omitted and is not
1.190 avankest 674: <code>null</code>, let <var>stored user</var> be <var>user</var>.</p>
1.14 avankest 675:
1.58 avankest 676: <p class="note">This step overrides any user that may have been set by
677: the <var>url</var> argument.</p>
678: </li>
1.16 avankest 679:
1.58 avankest 680: <li><p>If the <var>user</var> argument was not omitted and is
681: <code>null</code> remove <var>stored user</var>.</p></li>
1.14 avankest 682:
1.145 avankest 683: <li><p>If the <var>password</var> argument was not omitted and its
684: syntax does not match that specified by the relevant authentication
685: scheme raise a <code>SYNTAX_ERR</code> exception and terminate these
686: steps.</p></li>
1.58 avankest 687:
688: <li><p>If the <var>password</var> argument was not omitted and is not
1.190 avankest 689: <code>null</code>, let <var>stored password</var> be
690: <var>password</var>.</p>
1.58 avankest 691:
692: <li><p>If the <var>password</var> argument was not omitted and is
693: <code>null</code> remove <var>stored password</var>.</p></li>
694:
1.175 avankest 695: <li>
696: <p><span title="abort send()">Abort the <code>send()</code>
697: algorithm</span>, set <span>response entity body</span> to "null" and
1.189 avankest 698: empty the list of <span>author request headers</span>.</p>
1.175 avankest 699:
700: <p class="note">This step and the next only has effect if
701: <code>send()</code> and/or <code>setRequestHeader()</code> has been
702: used.</p>
703: </li>
1.58 avankest 704:
1.108 avankest 705: <li><p>The user agent <em class="ct">should</em> cancel any network
706: activity for which the object is responsible.</p></li>
1.58 avankest 707: <!-- we can hardly require it... -->
708:
1.145 avankest 709: <li><p>Switch the object to the
710: <span title="OPENED state">OPENED</span> state, set the
711: <span><code>send()</code> flag</span> to "false" and then synchronously
712: dispatch a <code>readystatechange</code> event on the object and return
713: the method call.</p></li>
1.58 avankest 714: </ol>
1.14 avankest 715:
1.19 avankest 716: <p class="note">A future version or extension of this specification will
1.33 avankest 717: most likely define a way of doing cross-site requests.</p>
1.1 avankest 718: </dd>
1.12 avankest 719:
1.131 avankest 720: <dt><dfn id="setrequestheader" title="setrequestheader"><code>setRequestHeader(<var>header</var>,
1.22 avankest 721: <var>value</var>)</code></dfn>, method</dt>
1.12 avankest 722:
1.5 avankest 723: <dd>
1.184 avankest 724: <p>
725: The object has an associated list of <dfn id="author-request-headers">author request headers</dfn>
726: consisting of HTTP header name/value pairs. The
727: <code>setRequestHeader()</code> method can be used to set new request
728: headers and append to request headers already in the list.</p>
729:
730: <p>As indicated in the algorithm below certain headers cannot be
731: set and are left up to the user agent. In addition there are certain
732: other headers the user agent will take control of if they are not set by
733: the author as indicated at the end of the <code>send()</code> method
734: section.</p>
1.163 avankest 735:
736: <p class="note">The <code>setRequestHeader()</code> method appends a
1.189 avankest 737: value if the HTTP header given as argument is already part of the
738: <span>author request headers</span> list.</p>
1.45 avankest 739:
1.58 avankest 740: <p>When invoked, the user agent <em class="ct">must</em> follow the
1.96 avankest 741: following steps (unless otherwise indicated):</p>
1.14 avankest 742:
1.58 avankest 743: <ol>
744: <li><p>If the state of the object is not
1.134 avankest 745: <span title="OPENED state">OPENED</span> raise an
1.98 avankest 746: <code>INVALID_STATE_ERR</code> exception and terminate these
747: steps.</p></li>
1.96 avankest 748:
749: <li><p>If the <span><code>send()</code> flag</span> is "true" raise an
1.98 avankest 750: <code>INVALID_STATE_ERR</code> exception and terminate these
751: steps.</p></li>
1.14 avankest 752:
1.97 avankest 753: <li><p>If the <var>header</var> argument does not match the
1.22 avankest 754: <dfn><code>field-name</code> production</dfn> as defined by section 4.2
1.181 avankest 755: of RFC 2616 raise a <code>SYNTAX_ERR</code> exception and terminate
756: these steps. [<cite><span>RFC2616</span></cite>]</p></li>
1.79 avankest 757:
1.178 avankest 758: <li>
759: <p>If the <var>value</var> argument does not match the
760: <dfn><code>field-value</code> production</dfn> as defined by section
761: 4.2 of RFC 2616 raise a <code>SYNTAX_ERR</code> and terminate these
762: steps. [<cite><span>RFC2616</span></cite>]</p>
763:
1.184 avankest 764: <p class="note">The empty string is legal and represents the empty
765: header value.</p>
1.178 avankest 766: </li>
1.14 avankest 767:
1.32 avankest 768: <li>
1.132 avankest 769: <p>For security reasons, these steps <em class="ct">should</em> be
1.98 avankest 770: terminated if the <var>header</var> argument
1.80 avankest 771: <span title="case-insensitive match">case-insensitively matches</span>
772: one of the following headers:</p>
1.58 avankest 773:
1.32 avankest 774: <ul>
775: <li><code>Accept-Charset</code></li>
776: <li><code>Accept-Encoding</code></li>
1.176 avankest 777: <li><code>Authorization</code></li>
1.68 avankest 778: <li><code>Connection</code></li>
1.32 avankest 779: <li><code>Content-Length</code></li>
1.176 avankest 780: <li><code>Cookie</code></li>
781: <li><code>Cookie2</code></li>
1.68 avankest 782: <li><code>Content-Transfer-Encoding</code></li>
783: <li><code>Date</code></li>
1.32 avankest 784: <li><code>Expect</code></li>
785: <li><code>Host</code></li>
786: <li><code>Keep-Alive</code></li>
787: <li><code>Referer</code></li>
788: <li><code>TE</code></li>
789: <li><code>Trailer</code></li>
790: <li><code>Transfer-Encoding</code></li>
791: <li><code>Upgrade</code></li>
1.184 avankest 792: <li><code>User-Agent</code></li>
1.68 avankest 793: <li><code>Via</code></li>
1.32 avankest 794: </ul>
1.189 avankest 795:
1.184 avankest 796: <p>… or if the start of the <var>header</var> argument
797: <span title="case-insensitive match">case-insensitively matches</span>
798: <code>Proxy-</code> or <code>Sec-</code> (including when the argument
799: is just <code>Proxy-</code> or <code>Sec-</code>).</p>
800:
801: <p class="note">The above headers are not allowed to be set as they
802: are better controlled by the user agent as it knows best what value
803: they should have. Header names starting with <code>Sec-</code> are not
804: allowed to be set to allow new headers to be minted in the future that
805: are guaranteed not to come from <code>XMLHttpRequest</code>. (Older
806: clients would however still be vulnerable as they allow such headers
807: to be set.)</p>
1.32 avankest 808: </li>
1.5 avankest 809:
1.184 avankest 810: <li><p>If the <var>header</var> argument is not in the <span>author request
811: headers</span> list append the <var>header</var> with its associated <var>value</var>
1.98 avankest 812: to the list and terminate these steps.</p></li>
1.58 avankest 813:
1.184 avankest 814: <li><p>If the <var>header</var> argument is in the <span>author request
815: headers</span> list either use multiple headers, combine the values or use a
1.96 avankest 816: combination of those (section 4.2, RFC 2616).
817: [<cite><span>RFC2616</span></cite>]</p></li>
818: <!-- XXX it seems UAs always combine the values -->
1.58 avankest 819: </ol>
1.45 avankest 820:
821: <p class="note">See also the <code>send()</code> method regarding user
1.71 avankest 822: agent header handling for caching, authentication, proxies, and
823: cookies.</p>
1.14 avankest 824:
825: <div class="example">
1.58 avankest 826: <pre><code>// The following script:
1.14 avankest 827: var client = new XMLHttpRequest();
828: client.open('GET', 'demo.cgi');
829: client.setRequestHeader('X-Test', 'one');
830: client.setRequestHeader('X-Test', 'two');
831: client.send();
832:
833: // ...would result in the following header being sent:
834: ...
835: X-Test: one, two
1.58 avankest 836: ...</code></pre>
1.14 avankest 837: </div>
1.5 avankest 838: </dd>
1.12 avankest 839:
1.131 avankest 840: <dt><dfn id="send" title="send"><code>send(<var>data</var>)</code></dfn>,
1.22 avankest 841: method</dt>
1.12 avankest 842:
1.17 avankest 843: <dd>
1.58 avankest 844: <p>The <code>send()</code> method initiates the request and its optional
1.163 avankest 845: argument provides the <span>entity body</span>.</p>
1.181 avankest 846:
1.163 avankest 847: <p class="note">Authors are encouraged to ensure that they have
848: specified the <code>Content-Type</code> header via
849: <code>setRequestHeader()</code> before invoking <code>send()</code> with
850: a non-<code>null</code> <var>data</var> argument.</p>
1.58 avankest 851:
852: <p>When invoked, the user agent <em class="ct">must</em> follow the
1.108 avankest 853: following steps (unless otherwise noted). Note that this algorithm might
1.126 avankest 854: get aborted if the <code>open()</code> or <code>abort()</code> method is
855: invoked. When the
1.109 avankest 856: <dfn title="abort send()" id="abort-send-algorithm"><code>send()</code>
1.110 avankest 857: algorithm is aborted</dfn> the user agent <em class="ct">must</em>
858: terminate the algorithm after finishing the step it is on.</p>
859:
1.192 avankest 860: <p class="note">The <code title="">send()</code> algorithm can only be
861: aborted when <var>async</var> is <code>true</code> (i.e., the request is
862: done asynchronously) and only after the method call has returned.</p>
1.58 avankest 863:
864: <ol>
865: <li><p>If the state of the object is not
1.134 avankest 866: <span title="OPENED state">OPENED</span> raise an
1.98 avankest 867: <code>INVALID_STATE_ERR</code> exception and terminate these
868: steps.</p></li>
1.96 avankest 869:
870: <li><p>If the <span><code>send()</code> flag</span> is "true" raise an
1.98 avankest 871: <code>INVALID_STATE_ERR</code> exception and terminate these
872: steps.</p></li>
1.58 avankest 873:
1.102 avankest 874: <li><p>If <var>async</var> is <code>true</code> set the
1.103 avankest 875: <span><code>send()</code> flag</span> to "true".</p></li>
876:
1.58 avankest 877: <li>
1.183 avankest 878: <p>If <var>stored method</var> is <code>GET</code> or
879: <code>HEAD</code> act as if the
1.166 avankest 880: <var>data</var> argument is <code>null</code>.</p>
1.181 avankest 881:
1.58 avankest 882: <p>If the <var>data</var> argument has not been omitted and is not
1.145 avankest 883: <code>null</code> use it for the <dfn id="entity-body">entity
884: body</dfn> as defined by section 7.2 of RFC 2616 observing the
885: following rules: [<cite><span>RFC2616</span></cite>]</p>
1.58 avankest 886:
1.119 avankest 887: <dl class="switch">
1.58 avankest 888: <dt><var>data</var> is a <code>DOMString</code></dt>
889:
1.163 avankest 890: <dd>
891: <p>Encode <var>data</var> using UTF-8 for transmission.</p>
892:
1.164 avankest 893: <p>If a <code>Content-Type</code> header is set using
1.194 avankest 894: <code>setRequestHeader()</code> and its value is not malformed, set
895: the <code>charset</code> parameter of that header, by either
896: changing the <code>charset</code> parameter (if one is present) or
897: appending one, to <code>UTF-8</code>.</p>
898:
899: <p>If no <code>Content-Type</code> header has been set using
900: <code>setRequestHeader()</code> set a <code>Content-Type</code>
901: request header with a value of
902: <code>text/plain;charset=UTF-8</code>.</p>
1.163 avankest 903: </dd>
1.58 avankest 904:
905: <dt><var>data</var> is a <code>Document</code>
906:
907: <dd>
1.181 avankest 908: <p>Let <var>data</var> be <code><var>data</var>.innerHTML</code> as
1.182 avankest 909: defined by section 2.5 of HTML 5. Encode it using
1.183 avankest 910: <code><var>data</var>.inputEncoding</code> or UTF-8 if
911: <code><var>data</var>.inputEncoding</code> is
1.181 avankest 912: <code>null</code>. Re-raise any exceptions the
913: <code><var>data</var>.innerHTML</code> getter algorithm raises.
914: [<cite><span>HTML5</span></cite>]</p>
1.183 avankest 915:
1.181 avankest 916: <p class="note">If the document cannot be serialized the
917: <code>document.innerHTML</code> algorithm raises an
918: <code>INVALID_STATE_ERR</code> exception.</p>
1.183 avankest 919:
1.194 avankest 920: <p>If a <code>Content-Type</code> header is set using
921: <code>setRequestHeader()</code> and its value is not malformed, set
922: the <code>charset</code> parameter of that header, by either
923: changing the <code>charset</code> parameter (if one is present) or
924: appending one, to the encoding used to encode the document.</p>
925:
1.165 avankest 926: <p>If no <code>Content-Type</code> header has been set using
1.175 avankest 927: <code>setRequestHeader()</code> set a <code>Content-Type</code>
928: request header with a value of
1.165 avankest 929: <code>application/xml;charset=<var>charset</var></code> where
930: <var>charset</var> is the encoding used to encode the document.</p>
1.58 avankest 931:
932: <p class="note">Subsequent changes to the <code>Document</code> have
933: no effect on what is submitted.</p>
934: </dd>
935:
936: <dt><var>data</var> is not a <code>DOMString</code> or
937: <code>Document</code></dt>
938:
1.96 avankest 939: <dd><p>Use the stringification mechanisms of the host language on
940: <var>data</var> and treat the result as if <var>data</var> is a
1.166 avankest 941: <code>DOMString</code>. Or, if this fails, act as if the
942: <var>data</var> argument is <code>null</code>.</p></dd>
1.58 avankest 943: </dl>
944:
1.126 avankest 945: <p>If the <var>data</var> argument has been omitted, or is
946: <code>null</code>, no entity body is used in the request.</p>
1.58 avankest 947: </li>
948:
1.71 avankest 949: <li><p>Make a request to <var>stored url</var>, using HTTP method
950: <var>stored method</var>, user <var>stored user</var> (if provided) and
951: password <var>stored password</var> (if provided), taking into account
1.184 avankest 952: the entity body, list of <span>author request headers</span> and the
953: rules listed directly after this set of steps.</p></li>
1.60 avankest 954:
1.67 avankest 955: <li>
1.96 avankest 956: <p>Synchronously dispatch a <code>readystatechange</code> event on the
957: object.</p>
1.67 avankest 958:
1.96 avankest 959: <p class="note">The state of the object does not change. The event is
960: dispatched for historical reasons.</p>
1.67 avankest 961: </li>
962:
1.102 avankest 963: <li><p>If <var>async</var> is <code>true</code> return the
1.98 avankest 964: <code>send()</code> method call. (Do not terminate the steps in the
965: algorithm though.)</p></li>
1.58 avankest 966:
1.117 avankest 967: <li>
1.175 avankest 968: <p>While executing the request the following rules are to be
1.123 avankest 969: observed.</p>
970:
1.119 avankest 971: <dl class="switch">
1.118 avankest 972: <dt>If the response is an HTTP redirect</dt>
1.167 avankest 973:
1.118 avankest 974: <dd>
1.145 avankest 975: <p>If the redirect does not violate security (it is
1.184 avankest 976: <span>same origin</span> for instance) or infinite loop precautions
1.145 avankest 977: and the scheme is supported transparently follow the redirect and go
1.166 avankest 978: to the start of this step (step 8).</p>
1.145 avankest 979:
980: <p class="note">HTTP places requirements on the user agent regarding
981: the preservation of the request method and entity body during
982: redirects, and also requires users to be notified of certain kinds
983: of automatic redirections.</p>
1.118 avankest 984: <!-- Arguably HTTP should be fixed for the latter case. No browser
985: follows that as far as I know. -->
986:
987: <p>Otherwise, follow the following set of steps:</p>
1.145 avankest 988:
1.118 avankest 989: <ol>
1.124 avankest 990: <li><p>Set the <span>response entity body</span> to "null", the
1.184 avankest 991: <span>error flag</span> to "true" and empty the list of
992: <span>author request headers</span>.</p></li>
1.118 avankest 993:
994: <li><p>Synchronously switch the state to
995: <span title="DONE state">DONE</span>.</p></li>
996:
997: <li><p>If <var>async</var> is set to <code>false</code> raise a
998: <code>NETWORK_ERR</code> exception and terminate the overall
999: algorithm.</p></li>
1000:
1001: <li><p>Synchronously dispatch a <code>readystatechange</code> event on
1002: the object.</p></li>
1003:
1004: <li><p>Terminate the overall algorithm.</p></li>
1005: </ol>
1006:
1007: <p class="note">It is likely that a future version of the
1008: <code>XMLHttpRequest</code> object will dispatch an <code>error</code>
1009: event here as well.</p>
1010: </dd>
1.117 avankest 1011:
1.121 avankest 1012:
1.118 avankest 1013: <dt>If the user cancels the download</dt>
1.58 avankest 1014:
1.118 avankest 1015: <dd>
1016: <p>Run the following set of steps:</p>
1.60 avankest 1017:
1.118 avankest 1018: <ol>
1.124 avankest 1019: <li><p>Set the <span>response entity body</span> to "null", the
1.184 avankest 1020: <span>error flag</span> to "true" and empty the list of
1021: <span>author request headers</span>.</p></li>
1.118 avankest 1022:
1023: <li><p>Synchronously switch the state to
1024: <span title="DONE state">DONE</span>.</p></li>
1025:
1.121 avankest 1026: <li><p>If <var>async</var> is set to <code>false</code> raise an
1027: <code>ABORT_ERR</code> exception and terminate the overall
1.118 avankest 1028: algorithm.</p></li>
1029:
1030: <li><p>Synchronously dispatch a <code>readystatechange</code> event on
1031: the object.</p></li>
1032:
1033: <li><p>Terminate the overall algorithm.</p></li>
1034: </ol>
1.121 avankest 1035:
1.118 avankest 1036: <p class="note">It is likely that a future version of the
1.121 avankest 1037: <code>XMLHttpRequest</code> object will dispatch an
1038: <code title="">abort</code> event here as well.</p>
1.118 avankest 1039: </dd>
1.60 avankest 1040:
1.121 avankest 1041:
1.118 avankest 1042: <dt>In case of network errors</dt>
1.60 avankest 1043:
1.118 avankest 1044: <dd>
1.176 avankest 1045: <p>In case of DNS errors, timeout, TLS negotiation failure, or other
1.186 avankest 1046: type of network errors, do not request user interaction and run the
1047: following set of steps:</p>
1048:
1049: <p class="note">This does not include HTTP responses that
1050: indicate some type of error, such as HTTP status code 410.</p>
1.118 avankest 1051:
1052: <ol>
1.124 avankest 1053: <li><p>Set the <span>response entity body</span> to "null", the
1.184 avankest 1054: <span>error flag</span> to "true" and empty the list of
1055: <span>author request headers</span>.</p></li>
1.118 avankest 1056:
1057: <li><p>Synchronously switch the state to
1058: <span title="DONE state">DONE</span>.</p></li>
1059:
1060: <li><p>If <var>async</var> is set to <code>false</code> raise a
1061: <code>NETWORK_ERR</code> exception and terminate the overall
1062: algorithm.</p></li>
1063:
1064: <li><p>Synchronously dispatch a <code>readystatechange</code> event on
1065: the object.</p></li>
1066:
1067: <li><p>Terminate the overall algorithm.</p></li>
1068: </ol>
1069:
1070: <p class="note">It is likely that a future version of the
1071: <code>XMLHttpRequest</code> object will dispatch an <code>error</code>
1072: event here as well.</p>
1073: </dd>
1074:
1075: <dt>Once all HTTP headers have been received</dt>
1076:
1077: <dd>
1078: <p>If all HTTP headers have been received, before receiving the message
1.123 avankest 1079: body (if any), run the following steps:</p>
1.60 avankest 1080:
1.118 avankest 1081: <ol>
1082: <li><p>Synchronously switch the state to
1.123 avankest 1083: <span title="HEADERS_RECEIVED state">HEADERS_RECEIVED</span>.</p></li>
1.118 avankest 1084:
1085: <li><p>Synchronously dispatch a <code>readystatechange</code> event on
1086: the object.</p></li>
1.123 avankest 1087: </ol>
1088: </dd>
1089:
1090: <dt>Once the first byte (or more) of the response entity body has been
1091: received</dt>
1092: <dt>If there is no response entity body</dt>
1.153 avankest 1093:
1.123 avankest 1094: <dd>
1095: <ol>
1.118 avankest 1096: <li><p>Synchronously switch the state to
1097: <span title="LOADING state">LOADING</span>.</p></li>
1098:
1099: <li><p>Synchronously dispatch a <code>readystatechange</code> event on
1100: the object.</p></li>
1101: </ol>
1102: </dd>
1103: </dl>
1.153 avankest 1104:
1.124 avankest 1105: <p>Finally, once the complete resource has been downloaded go to the next
1.118 avankest 1106: step.</p>
1.58 avankest 1107: </li>
1108:
1.82 avankest 1109: <li><p>When the request has successfully completed loading, synchronously
1.96 avankest 1110: switch the state to <span title="DONE state">DONE</span> and then
1111: synchronously dispatch a <code>readystatechange</code> event on the
1112: object and return the method call in case of <var>async</var> being
1113: <code>false</code>.</p></li>
1.58 avankest 1114: </ol>
1.14 avankest 1115:
1.91 avankest 1116: <p>If the user agent allows the user to configure a proxy it
1.22 avankest 1117: <em class="ct">should</em> modify the request appropriately;
1.42 avankest 1118: <abbr title="in other words">i.e.</abbr>, connect to the proxy host
1119: instead of the origin server, modify the <code>Request-Line</code> and
1120: send <code>Proxy-Authorization</code> headers as specified.</p>
1.12 avankest 1121:
1.42 avankest 1122: <p>If the user agent supports HTTP Authentication it
1.184 avankest 1123: <em class="ct">should</em> consider requests originating from this
1124: object to be part of the protection space that includes the accessed
1125: URIs and send <code>Authorization</code> headers and handle <code>401
1126: Unauthorized</code> requests appropriately. If authentication fails,
1.185 avankest 1127: and <var>stored user</var> and <var>stored password</var> are not
1128: provided, user agents <em class="ct">should</em> prompt the users for
1129: credentials.
1.42 avankest 1130: [<cite><span>RFC2617</span></cite>]</p>
1131:
1.185 avankest 1132: <p class="note">Users are not prompted if credentials are provided
1133: through the <code>open()</code> API so that authors can implement their
1134: own user interface.</p>
1135:
1.57 avankest 1136: <p>If the user agent supports HTTP State Management it
1.42 avankest 1137: <em class="ct">should</em> persist, discard and send cookies (as received
1138: in the <code>Set-Cookie</code> and <code>Set-Cookie2</code> response
1139: headers, and sent in the <code>Cookie</code> header) as applicable.
1.178 avankest 1140: [<cite><span>RFC2109</span></cite>]
1.42 avankest 1141: [<cite><span>RFC2965</span></cite>]</p>
1142:
1.178 avankest 1143: <!-- These specs do not match reality. -->
1.163 avankest 1144:
1.42 avankest 1145: <p>If the user agent implements a HTTP cache it <em class="ct">should</em>
1.184 avankest 1146: respect <code>Cache-Control</code> request headers set by
1147: <code>setRequestHeader()</code> (e.g., <code>Cache-Control: no-cache</code>
1148: bypasses the cache). It <em class="ct">must not</em> send
1.42 avankest 1149: <code>Cache-Control</code> or <code>Pragma</code> request headers
1.137 avankest 1150: automatically unless the user explicitly requests such behavior
1.179 avankest 1151: (<abbr>e.g.</abbr>, by (force-)reloading the page).</p>
1.184 avankest 1152:
1.179 avankest 1153: <p>For <code>304 Not Modified</code> responses that are a result of a
1154: user agent generated conditional request the user agent
1155: <em class="ct">must</em> act as if the server gave a <code>200
1156: OK</code> response with the appropriate content. The user agent
1.184 avankest 1157: <em class="ct">must</em> allow <code>setRequestHeader()</code> to
1158: override automatic cache validation by setting request headers (e.g.,
1159: <code>If-None-Match</code>, <code>If-Modified-Since</code>), in which
1160: case <code>304 Not Modified</code> responses <em class="ct">must</em> be
1161: passed through. [<cite><span>RFC2616</span></cite>]</p>
1.12 avankest 1162:
1.8 avankest 1163: <p>If the user agent implements server-driven content-negotiation
1.161 avankest 1164: it <em class="ct">should</em> set <code>Accept-Encoding</code> and
1.174 avankest 1165: <code>Accept-Charset</code> headers as appropriate.
1166: Unless set through <code>setRequestHeader()</code> user agents
1167: <em class="ct">should</em> set the <code>Accept</code> and
1.180 avankest 1168: <code>Accept-Language</code> headers as well. If <code>Accept</code> is
1169: set by the user agent it <em class="ct">must</em> have the value
1170: <code>*/*</code>. Responses <em class="ct">must</em> have the
1171: content-encodings automatically decoded.
1172: [<cite><span>RFC2616</span></cite>]</p>
1.184 avankest 1173:
1.185 avankest 1174: <p>Besides the <span>author request headers</span> user agents
1175: <em class="ct">should not</em> include additional request headers other
1176: than those mentioned above or other than those authors are not allowed
1177: to set using <code>setRequestHeader()</code>. This ensures that authors
1178: have a reasonably predictable API.</p>
1.8 avankest 1179: </dd>
1.12 avankest 1180:
1.131 avankest 1181: <dt><dfn id="abort"><code>abort()</code></dfn>, method</dt>
1.12 avankest 1182:
1.5 avankest 1183: <dd>
1.60 avankest 1184: <p>When invoked, the user agent <em class="ct">must</em> run the following
1.96 avankest 1185: steps (unless otherwise noted):</p>
1.60 avankest 1186:
1187: <ol>
1.108 avankest 1188: <li><p><span title="abort send()">Abort the <code>send()</code>
1189: algorithm</span>, set the <span>response entity body</span> to "null",
1.135 avankest 1190: the <span>error flag</span> to "true" and remove any registered request
1191: headers.</p></li>
1.60 avankest 1192:
1.108 avankest 1193: <li><p>The user agent <em class="ct">should</em> cancel any network
1194: activity for which the object is responsible.</p></li>
1.60 avankest 1195:
1.83 avankest 1196: <li>
1.85 avankest 1197: <p>If the state is <span title="UNSENT state">UNSENT</span>,
1.134 avankest 1198: <span title="OPENED state">OPENED</span> and the <span><code>send()</code>
1.87 avankest 1199: flag</span> is "false", or <span title="DONE state">DONE</span> go to
1200: the next step.</p>
1.85 avankest 1201:
1.135 avankest 1202: <p>Otherwise, switch the state to
1203: <span title="DONE state">DONE</span>, set the
1204: <span><code>send()</code> flag</span> to "false" and synchronously
1205: dispatch a <code>readystatechange</code> event on the object.</p>
1.83 avankest 1206: </li>
1.67 avankest 1207:
1.60 avankest 1208: <li>
1.97 avankest 1209: <p>Switch the state to <span title="UNSENT state">UNSENT</span>. (Do not
1.71 avankest 1210: dispatch the <code>readystatechange</code> event.)</p>
1.60 avankest 1211:
1.82 avankest 1212: <p class="note">It is likely that a future version of the
1213: <code>XMLHttpRequest</code> object will dispatch an
1214: <code title="">abort</code> event here as well.</p>
1.60 avankest 1215: </li>
1216: </ol>
1.5 avankest 1217: </dd>
1.12 avankest 1218:
1.131 avankest 1219: <dt><dfn id="getallresponseheaders"><code>getAllResponseHeaders()</code></dfn>,
1.22 avankest 1220: method</dt>
1.12 avankest 1221:
1.5 avankest 1222: <dd>
1.60 avankest 1223: <p>When invoked, the user agent <em class="ct">must</em> run
1.58 avankest 1224: the following steps:</p>
1225:
1226: <ol>
1.124 avankest 1227: <li><p>If the state is <span title="UNSENT state">UNSENT</span> or
1.134 avankest 1228: <span title="OPENED state">OPENED</span> raise an
1.98 avankest 1229: <code>INVALID_STATE_ERR</code> exception and terminate these
1230: steps.</p></li>
1.170 avankest 1231:
1232: <li><p>If the <span>error flag</span> is "true" return the empty string
1.124 avankest 1233: and terminate these steps.</p></li>
1.96 avankest 1234:
1.167 avankest 1235: <li><p>Return all the HTTP headers, as a single string, with each
1.192 avankest 1236: header line separated by a U+000D CR U+000A LF pair excluding the
1237: status line, and with each header name and header value separated by a
1238: U+003A COLON U+0020 SPACE pair.</p></li>
1.58 avankest 1239: </ol>
1.24 avankest 1240:
1.5 avankest 1241: <div class="example">
1.58 avankest 1242: <pre><code>// The following script:
1.5 avankest 1243: var client = new XMLHttpRequest();
1.14 avankest 1244: client.open("GET", "test.txt", true);
1.5 avankest 1245: client.send();
1.12 avankest 1246: client.onreadystatechange = function() {
1.179 avankest 1247: if(this.readyState == 2) {
1.12 avankest 1248: print(this.getAllResponseHeaders());
1249: }
1250: }
1.5 avankest 1251:
1252: // ...should output something similar to the following text:
1253: Date: 2004年10月24日 04:58:38 GMT
1254: Server: Apache/1.3.31 (Unix)
1255: Keep-Alive: timeout=15, max=99
1256: Connection: Keep-Alive
1257: Transfer-Encoding: chunked
1.58 avankest 1258: Content-Type: text/plain; charset=utf-8</code></pre>
1.5 avankest 1259: </div>
1260: </dd>
1.12 avankest 1261:
1.131 avankest 1262: <dt><dfn id="getresponseheader" title="getresponseheader"><code>getResponseHeader(<var>header</var>)</code></dfn>,
1.22 avankest 1263: method</dt>
1.12 avankest 1264:
1.1 avankest 1265: <dd>
1.58 avankest 1266: <p>When the method is invoked, the user agent <em class="ct">must</em> run
1267: the following steps:</p>
1.14 avankest 1268:
1.58 avankest 1269: <ol>
1.124 avankest 1270: <li><p>If the state is <span title="UNSENT state">UNSENT</span> or
1.134 avankest 1271: <span title="OPENED state">OPENED</span> raise an
1.98 avankest 1272: <code>INVALID_STATE_ERR</code> exception and terminate these
1273: steps.</p></li>
1.58 avankest 1274:
1.149 avankest 1275: <li><p>If the <var>header</var> argument does not match the
1.171 avankest 1276: <span><code>field-name</code> production</span> return
1277: <code>null</code> and terminate these steps.</p></li>
1.124 avankest 1278:
1.149 avankest 1279: <li><p>If the <span>error flag</span> is "true" return
1280: <code>null</code> and terminate these steps.</p></li>
1.58 avankest 1281:
1.80 avankest 1282: <li><p>If the <var>header</var> argument
1283: <span title="case-insensitive match">case-insensitively matches</span>
1.127 avankest 1284: multiple HTTP headers for the last request sent, return the values of
1.149 avankest 1285: these headers as a single concatenated string separated from each
1.192 avankest 1286: other by a U+002C COMMA U+0020 SPACE character pair and terminate
1.149 avankest 1287: these steps.</p></li>
1.58 avankest 1288:
1.80 avankest 1289: <li><p>If the <var>header</var> argument
1.149 avankest 1290: <span title="case-insensitive match">case-insensitively matches</span>
1291: a single HTTP header for the last request sent return the value of
1292: that header and terminate these steps.</p></li>
1.58 avankest 1293:
1.96 avankest 1294: <li><p>Return <code>null</code>.</p></li>
1.58 avankest 1295: </ol>
1.12 avankest 1296:
1.1 avankest 1297: <div class="example">
1.58 avankest 1298: <pre><code>// The following script:
1.1 avankest 1299: var client = new XMLHttpRequest();
1.14 avankest 1300: client.open("GET", "test.txt", true);
1.5 avankest 1301: client.send();
1.12 avankest 1302: client.onreadystatechange = function() {
1.179 avankest 1303: if(this.readyState == 2) {
1.14 avankest 1304: print(client.getResponseHeader("Content-Type"));
1.12 avankest 1305: }
1306: }
1.1 avankest 1307:
1.5 avankest 1308: // ...should output something similar to the following text:
1.163 avankest 1309: text/plain; charset=utf-8</code></pre>
1.1 avankest 1310: </div>
1.5 avankest 1311: </dd>
1.12 avankest 1312:
1.131 avankest 1313: <dt><dfn id="responsetext"><code>responseText</code></dfn> of type
1.22 avankest 1314: <code>DOMString</code>, readonly</dt>
1.12 avankest 1315:
1.5 avankest 1316: <dd>
1.88 avankest 1317: <p>On getting, the user agent <em class="ct">must</em> run the following
1318: steps:</p>
1319:
1320: <ol>
1.169 avankest 1321: <li><p>If the state is not <span title="LOADING state">LOADING</span>
1322: or <span title="DONE state">DONE</span> return the empty string and
1323: terminate these steps.</p></li>
1.12 avankest 1324:
1.88 avankest 1325: <li><p>Return the <span>text response entity body</span>.</p></li>
1326: </ol>
1.5 avankest 1327: </dd>
1.12 avankest 1328:
1.131 avankest 1329: <dt><dfn id="responsexml"><code>responseXML</code></dfn> of type
1.22 avankest 1330: <code>Document</code>, readonly</dt>
1.12 avankest 1331:
1.8 avankest 1332: <dd>
1.75 avankest 1333: <p>On getting, the user agent <em class="ct">must</em> run the following
1334: steps:</p>
1.79 avankest 1335:
1.75 avankest 1336: <ol>
1.169 avankest 1337: <li><p>If the state is not <span title="DONE state">DONE</span> return
1338: <code>null</code> and terminate these steps.</p></li>
1.75 avankest 1339:
1.88 avankest 1340: <li><p>Return the <span>XML response entity body</span>.</p></li>
1.75 avankest 1341: </ol>
1.5 avankest 1342: </dd>
1.12 avankest 1343:
1.131 avankest 1344: <dt><dfn id="status"><code>status</code></dfn> of type <code>unsigned
1.22 avankest 1345: short</code>, readonly</dt>
1.12 avankest 1346:
1.5 avankest 1347: <dd>
1.72 avankest 1348: <p>On getting, if available, it <em class="ct">must</em> return the HTTP
1349: status code sent by the server (typically <code>200</code> for a
1350: successful request). Otherwise, if not available, the user agent
1351: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1352: exception.</p>
1.12 avankest 1353: </dd>
1354:
1.131 avankest 1355: <dt><dfn id="statustext"><code>statusText</code></dfn> of type
1.22 avankest 1356: <code>DOMString</code>, readonly</dt>
1.12 avankest 1357:
1.5 avankest 1358: <dd>
1.72 avankest 1359: <p>On getting, if available, it <em class="ct">must</em> return the HTTP
1360: status text sent by the server (appears after the status code). Otherwise,
1.179 avankest 1361: if not available (request is not initiated for instance), the user
1362: agent <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code>
1363: exception.</p>
1.1 avankest 1364: </dd>
1365: </dl>
1.12 avankest 1366:
1.121 avankest 1367:
1.31 avankest 1368: <h3 id="events">Events for the <code title="">XMLHttpRequest</code>
1369: Object</h3>
1.12 avankest 1370:
1.1 avankest 1371: <dl>
1.131 avankest 1372: <dt><dfn id="readystatechange"><code>readystatechange</code></dfn></dt>
1.24 avankest 1373:
1.72 avankest 1374: <dd>When the user agent dispatches a <code title="">readystatechange</code>
1375: event (as indicated above) it <em class="ct">must not</em> bubble,
1376: <em class="ct">must not</em> be cancelable and <em class="ct">must</em>
1377: implement the <code>Event</code> interface. Its <code>namespaceURI</code>
1378: attribute <em class="ct">must</em> be <code>null</code>.
1.155 avankest 1379: [<cite><span>DOM2Events</span></cite>]</dd>
1.1 avankest 1380: </dl>
1.32 avankest 1381:
1.31 avankest 1382: <h3 id="exceptions">Exceptions for the <code title="">XMLHttpRequest</code>
1383: Object</h3>
1.138 avankest 1384:
1385: <p>Several algorithms in this specification may result in an exception
1386: being thrown. These exceptions are all part of the group
1.185 avankest 1387: <code>ExceptionCode</code> and use the <code>DOMException</code> object,
1.138 avankest 1388: which is defined in DOM Level 3 Core. In addition this specification
1389: extends the <code>ExceptionCode</code> group with several new
1390: constants as indicated below. [<cite><span>DOM3Core</span></cite>]</p>
1.193 avankest 1391:
1392: <p class="note">Thus, exceptions used by this specification and not
1393: defined in this section are defined by DOM Level 3 Core.</p>
1.31 avankest 1394:
1.138 avankest 1395: <pre class="idl">const unsigned short <span>SECURITY_ERR</span> = 18;
1.121 avankest 1396: const unsigned short <span>NETWORK_ERR</span> = 101;
1397: const unsigned short <span>ABORT_ERR</span> = 102;</pre>
1.31 avankest 1398:
1.138 avankest 1399: <p>The <dfn id="security-err"><code>SECURITY_ERR</code></dfn> exception is
1400: raised if an attempt is made to perform an operation or access some data
1401: in a way that would be a security risk or a violation of the user agent's
1402: security policy.</p>
1403:
1404: <!-- http://lists.w3.org/Archives/Public/public-webapi/2006May/0027.html -->
1405:
1406: <p class="note">The <code title="">SECURITY_ERR</code> exception is
1407: expected to be eventually folded into an update of the the DOM Level 3
1408: Core specification with an equivalent definition and identical constant
1409: value. Until that happens it is defined here to guide implementors. (This
1.153 avankest 1410: is also the reason the constant value is not in line with the other
1.138 avankest 1411: exceptions.)</p>
1412:
1.33 avankest 1413: <p>The <dfn id="network-err"><code>NETWORK_ERR</code></dfn> exception is
1.138 avankest 1414: raised when a network error occurs in synchronous requests.</p>
1.121 avankest 1415:
1.138 avankest 1416: <p>The <dfn id="abort-err"><code>ABORT_ERR</code></dfn> exception is
1417: raised when the user aborts a request in synchronous requests.</p>
1.121 avankest 1418:
1419:
1.29 avankest 1420: <h2 class="no-num" id="notcovered">Not in this Specification</h2>
1421:
1.143 avankest 1422: <p><em>This section is non-normative.</em></p>
1.29 avankest 1423:
1.72 avankest 1424: <p>This specification does not include the following features which are
1425: being considered for a future version of this specification:</p>
1.29 avankest 1426:
1427: <ul>
1428: <li><code>load</code> event and <code>onload</code> attribute;</li>
1429: <li><code>error</code> event and <code>onerror</code> attribute;</li>
1430: <li><code>progress</code> event and <code>onprogress</code> attribute;</li>
1431: <li><code title="">abort</code> event and <code>onabort</code> attribute;</li>
1432: <li>Timers have been suggested, perhaps an <code>ontimeout</code>
1433: attribute;</li>
1434: <li>Property to disable following redirects;</li>
1.30 avankest 1435: <li><code title="">responseXML</code> for <code>text/html</code>
1436: documents;</li>
1.40 avankest 1437: <li>Cross-site <code title="">XMLHttpRequest</code>;</li>
1.87 avankest 1438: <li><code>responseBody</code> to deal with byte streams;</li>
1.114 avankest 1439: <li><code>overrideMimeType</code> to fix up MIME types;</li>
1.87 avankest 1440: <li><code>getRequestHeader()</code> and
1441: <code>removeRequestHeader()</code>.</li>
1.29 avankest 1442: </ul>
1443:
1.1 avankest 1444: <h2 class="no-num" id="bibref">References</h2>
1.177 avankest 1445:
1446: <p>Unless marked "Non-normative" these references are normative.</p>
1.11 avankest 1447:
1.6 avankest 1448: <dl>
1.155 avankest 1449: <dt>[<dfn id="ref-dom2events">DOM2Events</dfn>]</dt>
1450: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-2-Events/">Document
1.160 avankest 1451: Object Model (DOM) Level 2 Events Specification</a></cite>, T. Pixley,
1452: editor. W3C, November 2000.</dd>
1.155 avankest 1453:
1.145 avankest 1454: <dt>[<dfn id="ref-dom3core">DOM3Core</dfn>]</dt>
1.11 avankest 1455: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-3-Core">Document Object
1.92 avankest 1456: Model (DOM) Level 3 Core Specification</a></cite>, A. Le Hors, P. Le
1.139 avankest 1457: Hégaret, L. Wood, G. Nicol, J. Robie, M. Champion, S. Byrne,
1458: editors. W3C, April 2004.</dd>
1.11 avankest 1459:
1.117 avankest 1460: <dt>[<dfn id="ref-ecmascript">ECMAScript</dfn>]</dt>
1.92 avankest 1461: <dd><cite><a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript
1462: Language Specification</a></cite>, Third Edition. ECMA, December 1999.</dd>
1.171 avankest 1463:
1.145 avankest 1464: <dt>[<dfn id="ref-html5">HTML5</dfn>]</dt>
1.171 avankest 1465: <dd><cite><a href="http://www.w3.org/html/wg/html5/">HTML 5</a></cite>
1466: (work in progress), I. Hickson, D. Hyatt, editors. W3C, 2008.</dd>
1.142 avankest 1467: <dd><cite><a href="http://www.whatwg.org/specs/web-apps/current-work/">HTML 5</a></cite>
1.171 avankest 1468: (work in progress), I. Hickson, editor. WHATWG, 2008.</dd>
1.177 avankest 1469:
1470: <dt>[<dfn id="ref-httponly">HTTPONLY</dfn>]</dt>
1471: <dd>(Non-normative) <cite><a href="http://msdn.microsoft.com/en-us/library/ms533046.aspx">Mitigating
1472: Cross-site Scripting With HTTP-only Cookies</a></cite>, MSDN.</dd>
1.14 avankest 1473:
1.178 avankest 1474: <dt>[<dfn id="ref-rfc2109">RFC2109</dfn>]</dt>
1475:
1476: <dd><cite><a href="http://ietf.org/rfc/rfc2109">HTTP State Management
1477: Mechanism</a></cite>, D. Kristol, L. Montulli, editors. IETF, February
1478: 1997.</dd>
1479:
1.145 avankest 1480: <dt>[<dfn id="ref-rfc2119">RFC2119</dfn>]</dt>
1.117 avankest 1481: <dd><cite><a href="http://ietf.org/rfc/rfc2119">Key words for use in RFCs to
1482: Indicate Requirement Levels</a></cite>, S. Bradner. IETF, March 1997.</dd>
1.12 avankest 1483:
1.145 avankest 1484: <dt>[<dfn id="ref-rfc2616">RFC2616</dfn>]</dt>
1.11 avankest 1485: <dd><cite><a href="http://ietf.org/rfc/rfc2616">Hypertext Transfer Protocol
1.92 avankest 1486: -- HTTP/1.1</a></cite>, R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L.
1487: Masinter, P. Leach, T. Berners-Lee, editors. IETF, June 1999.</dd>
1.12 avankest 1488:
1.37 avankest 1489: <dt>[<dfn id="ref-rfc2617">RFC2617</dfn>]</dt>
1.11 avankest 1490: <dd><cite><a href="http://ietf.org/rfc/rfc2617">HTTP Authentication: Basic
1.92 avankest 1491: and Digest Access Authentication</a></cite>, P. Hallam-Baker, J.
1492: Hostetler, S. Lawrence, P. Leach, A. Luotonen, L. Stewart, editors. IETF,
1493: June 1999.</dd>
1.12 avankest 1494:
1.37 avankest 1495: <dt>[<dfn id="ref-rfc2965">RFC2965</dfn>]</dt>
1.19 avankest 1496: <dd><cite><a href="http://ietf.org/rfc/rfc2965">HTTP State Management
1.92 avankest 1497: Mechanism</a></cite>, D. Kristol, L. Montulli, editors. IETF, October
1498: 2000.</dd>
1.19 avankest 1499:
1.37 avankest 1500: <dt>[<dfn id="ref-rfc3986">RFC3986</dfn>]</dt>
1.11 avankest 1501: <dd><cite><a href="http://ietf.org/rfc/rfc3986">Uniform Resource Identifier
1.92 avankest 1502: (URI): Generic Syntax</a></cite>, T. Berners-Lee, R. Fielding, L. Masinter,
1503: editors. IETF, January 2005.</dd>
1.184 avankest 1504:
1505: <dt>[<dfn id=ref-rfc3987>RFC3987</dfn>]</dt>
1.141 avankest 1506: <dd><cite><a href="http://ietf.org/rfc/rfc3987">Internationalized
1507: Resource Identifiers (IRIs)</a></cite>, M. Duerst, M. Suignard, editors.
1.189 avankest 1508: IETF, January 2005.</dd>
1.28 avankest 1509:
1.181 avankest 1510: <dt>[<dfn id="ref-webidl">Web IDL</dfn>]</dt>
1511: <dd><cite><a href="http://dev.w3.org/2006/webapi/Binding4DOM/">Web
1512: IDL</a></cite> (editor's draft), C. McCormack, editor. W3C, 2008.</dd>
1513:
1.92 avankest 1514: <dt>[<dfn id="ref-xml">XML</dfn>]</dt>
1515: <dd><cite><a href="http://www.w3.org/TR/xml/">Extensible Markup Language
1516: (XML) 1.0 (Fourth Edition)</a></cite>, T. Bray, J. Paoli, C.
1.117 avankest 1517: Sperberg-McQueen, E. Maler, F. Yergeau, editors. W3C, September 2006.</dd>
1.41 avankest 1518:
1.92 avankest 1519: <dt>[<dfn id="ref-xmlns">XMLNS</dfn>]</dt>
1520: <dd><cite><a href="http://www.w3.org/TR/xml-names/">Namespaces in XML
1.117 avankest 1521: (Second Edition)</a></cite>, T. Bray, D. Hollander, A. Layman, R. Tobin,
1522: editors. W3C, August 2006.</dd>
1.1 avankest 1523: </dl>
1.11 avankest 1524:
1.130 avankest 1525: <h2 class="no-num" id="acknowledgments">Acknowledgments</h2>
1.11 avankest 1526:
1.159 avankest 1527: <p>The editor would like to thank
1.12 avankest 1528:
1.163 avankest 1529: Addison Phillips,
1.159 avankest 1530: Ahmed Kamel,
1531: Alex Hopmann,
1532: Alex Vincent,
1533: Alexey Proskuryakov,
1534: Asbjørn Ulsberg,
1535: Boris Zbarsky,
1536: Björn Höhrmann,
1537: Cameron McCormack,
1538: Christophe Jolif,
1539: Charles McCathieNevile,
1540: Dan Winship,
1541: David Håsäther,
1542: Dean Jackson,
1543: Denis Sureau,
1544: Doug Schepers,
1545: Douglas Livingstone,
1546: Elliotte Harold,
1547: Eric Lawrence,
1.196 ! avankest 1548: Erik Dahlström,
1.163 avankest 1549: Geoffrey Sneddon,
1.159 avankest 1550: Gideon Cohn,
1551: Gorm Haug Eriksen,
1552: Hallvord R. M. Steen,
1553: Håkon Wium Lie,
1554: Ian Davis,
1555: Ian Hickson,
1556: Ivan Herman,
1557: Jeff Walden,
1558: Jens Lindström,
1559: Jim Deegan,
1560: Jim Ley,
1561: Joe Farro,
1562: Jonas Sicking,
1563: Julian Reschke,
1564: Karl Dubost,
1.175 avankest 1565: Lachlan Hunt,
1.159 avankest 1566: Maciej Stachowiak,
1567: Magnus Kristiansen,
1568: Marc Hadley,
1569: Marcos Caceres,
1570: Mark Baker,
1571: Mark Nottingham,
1572: Mohamed Zergaoui,
1573: Pawel Glowacki,
1574: Robin Berjon,
1575: Ruud Steltenpool,
1576: Simon Pieters,
1577: Stewart Brodie,
1578: Sunava Dutta,
1.186 avankest 1579: Thomas Roessler,
1.159 avankest 1580: Tom Magliery and
1581: Zhenbin Xu
1.181 avankest 1582:
1.159 avankest 1583: for their contributions to this specification.</p>
1.12 avankest 1584:
1.1 avankest 1585: <p>Special thanks to the Microsoft employees who first implemented the
1.143 avankest 1586: <code title="">XMLHttpRequest</code> interface, which was first widely
1587: deployed by the Windows Internet Explorer browser.</p>
1.12 avankest 1588:
1.143 avankest 1589: <p>Special thanks also to the WHATWG for drafting an initial version of
1590: this specification in their Web Applications 1.0 document (now renamed to
1591: HTML 5). [<cite><span>HTML5</span></cite>]</p>
1.12 avankest 1592:
1.143 avankest 1593: <p>Thanks also to all those who have helped to improve this specification
1594: by sending suggestions and corrections. (Please, keep bugging us with your
1.22 avankest 1595: issues!)</p>
1.1 avankest 1596: </body>
1597: </html>
Webmaster