[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.152

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

Webmaster

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