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