[BACK] Return to Overview.src.html CVS log [TXT] [DIR] Up to [Public] / 2006 / webapi / XMLHttpRequest

Annotation of 2006/webapi/XMLHttpRequest/Overview.src.html, revision 1.130

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

Webmaster

AltStyle によって変換されたページ (->オリジナル) /