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

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

Webmaster

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