Annotation of 2006/webapi/XMLHttpRequest/Overview.src.html, revision 1.35
1.1 avankest 1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
2: <html lang="en-US">
3: <head>
4: <title>The XMLHttpRequest Object</title>
1.16 avankest 5: <style type="text/css">
6: pre.idl { border:solid thin; background:#eee; color:#000; padding:0.5em }
7: pre.idl :link, pre.idl :visited { color:inherit; background:transparent }
8: div.example { margin-left:1em; padding-left:1em; border-left:double; color:#222; background:#fcfcfc }
9: p.note { margin-left:2em; font-weight:bold; font-style:italic; color:#008000 }
10: p.note::before { content:"Note: " }
11: p.issue { padding:.5em; border:solid #f00 }
12: p.issue::before { content:"Issue: " }
13: em.ct { text-transform:lowercase; font-variant:small-caps; font-style:normal }
14: dfn { font-weight:bold; font-style:normal }
15: code { color:orangered }
16: code :link, code :visited { color:inherit }
17: </style>
1.7 avankest 18: <link rel="stylesheet" href="http://www.w3.org/StyleSheets/TR/base">
1.1 avankest 19: </head>
20: <body>
21: <div class="head">
22: <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 23:
1.10 avankest 24: <h1 class="head">The <code title="">XMLHttpRequest</code> Object</h1>
1.12 avankest 25:
1.22 avankest 26: <h2 class="no-num no-toc" id="pagesubtitle">Editors' draft <!--W3C Working Draft--> [DATE: 3 August 2002]</h2>
1.12 avankest 27:
1.1 avankest 28: <dl>
1.10 avankest 29: <dt>This Version:</dt>
1.24 avankest 30:
1.22 avankest 31: <dd><a href="[VERSION]">http://www.w3.org/TR/[YEAR]/WD-XMLHttpRequest-[CDATE]/</a></dd>
1.14 avankest 32:
1.10 avankest 33: <dt>Latest Version:</dt>
1.24 avankest 34:
1.1 avankest 35: <dd><a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a></dd>
1.14 avankest 36:
1.10 avankest 37: <dt>Previous Versions:</dt>
1.24 avankest 38:
1.22 avankest 39: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060927/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060927/</a></dd>
1.24 avankest 40:
1.1 avankest 41: <dd><a href="http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/">http://www.w3.org/TR/2006/WD-XMLHttpRequest-20060619/</a></dd>
1.24 avankest 42:
1.1 avankest 43: <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 44:
1.1 avankest 45: <dt>Editor:</dt>
1.24 avankest 46:
1.1 avankest 47: <dd><a href="http://annevankesteren.nl/">Anne van Kesteren</a>
48: (<a href="http://www.opera.com/">Opera Software ASA</a>)
49: <<a href="mailto:annevk@opera.com">annevk@opera.com</a>></dd>
50: </dl>
1.14 avankest 51:
1.1 avankest 52: <p class="copyright"><a href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a>
53: ©2006
54: <a href="http://www.w3.org/"><abbr title="World Wide Web Consortium">W3C</abbr></a><sup>®</sup>
55: (<a href="http://www.csail.mit.edu/"><abbr title="Massachusetts Institute of Technology">MIT</abbr></a>,
56: <a href="http://www.ercim.org/"><abbr title="European Research Consortium for Informatics and Mathematics">ERCIM</abbr></a>,
57: <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C
58: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
59: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>
60: and
61: <a href="http://www.w3.org/Consortium/Legal/copyright-documents">document
62: use</a> rules apply.
63: </p>
64: </div>
1.12 avankest 65:
1.1 avankest 66: <hr>
1.12 avankest 67:
1.1 avankest 68: <h2 class="no-num no-toc" id="specabstract">Abstract</h2>
1.10 avankest 69:
1.22 avankest 70: <p>The <code title="">XMLHttpRequest</code> Object specification defines an
71: <abbr title="Application Programming Interface">API</abbr> that provides
72: scripted client functionality for transferring data between a client and a
73: server.</p>
1.12 avankest 74:
1.1 avankest 75: <h2 class="no-num no-toc" id="sotd">Status of this Document</h2>
1.12 avankest 76:
1.1 avankest 77: <p><em>This section describes the status of this document at the time of its
78: publication. Other documents may supersede this document. A list of current
79: W3C publications and the latest revision of this technical report can be
80: found in the <a href="http://www.w3.org/TR/">W3C technical reports index</a>
81: at http://www.w3.org/TR/.</em></p>
1.12 avankest 82:
1.35 ! avankest 83: <p>This is the [DATE: 3 August 2002] Last Call Working Draft of The
1.25 avankest 84: <code title="">XMLHttpRequest</code> Object specifcation. This document is
85: produced by the <a href="http://www.w3.org/2006/webapi/">Web API Working
1.33 avankest 86: Group</a>, part of the <a href="http://www.w3.org/2006/rwc/Activity">Rich
87: Web Clients Activity</a> in the W3C
1.25 avankest 88: <a href="http://www.w3.org/Interaction/">Interaction Domain</a>.</p>
1.12 avankest 89:
1.1 avankest 90: <p>Web content and browser developers are encouraged to review this draft.
91: Please send comments to
1.25 avankest 92: <a href="mailto:public-webapi@w3.org">public-webapi@w3.org</a> with either
1.33 avankest 93: <samp>[XHR]</samp> or <samp title="">[XMLHttpRequest]</samp> at the start
94: of the subject line.
95: <a href="http://lists.w3.org/Archives/Public/public-webapi/">Archives</a>
96: of this list are available.</p>
1.12 avankest 97:
1.1 avankest 98: <p>Publication as a Working Draft does not imply endorsement by the W3C
99: Membership. This is a draft document and may be updated, replaced or
100: obsoleted by other documents at any time. It is inappropriate to cite this
101: document as other than work in progress.</p>
1.12 avankest 102:
1.1 avankest 103: <p>This document was produced by a group operating under the
104: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/">5 February
105: 2004 W3C Patent Policy</a>. This document is informative only. W3C maintains
106: a
107: <a rel="disclosure" href="http://www.w3.org/2004/01/pp-impl/38482/status">public
108: list of any patent disclosures</a> made in connection with the deliverables
109: of the group; that page also includes instructions for disclosing a patent.
110: An individual who has actual knowledge of a patent which the individual
111: believes contains
112: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#def-essential">Essential
113: Claim(s)</a> must disclose the information in accordance with
114: <a href="http://www.w3.org/Consortium/Patent-Policy-20040205/#sec-Disclosure">section
115: 6 of the W3C Patent Policy</a>.</p>
1.12 avankest 116:
1.1 avankest 117: <h2 class="no-num no-toc" id="toc">Table of Contents</h2>
1.21 avankest 118:
1.1 avankest 119: <!--toc-->
1.12 avankest 120:
1.1 avankest 121: <h2 id="introduction">Introduction</h2>
1.12 avankest 122:
1.1 avankest 123: <p><em>This section is non-normative.</em></p>
1.12 avankest 124:
1.33 avankest 125: <p>The <code>XMLHttpRequest</code> object implements an interface exposed by
126: a scripting engine that allows scripts to perform HTTP client functionality,
1.22 avankest 127: such as submitting form data or loading data from a server.</p>
1.24 avankest 128:
1.1 avankest 129: <p>The name of the object is <code>XMLHttpRequest</code> for compatibility
1.22 avankest 130: with the web, though each component of this name is potentially misleading.
131: First, the object is data transport agnostic — it supports any data format,
132: including XML. Second, it can be used to make requests over both HTTP and
133: HTTPS (some implementations support protocols in addition to HTTP and HTTPS,
134: but that functionality is not covered by this specification). Finally, it
135: supports "requests" in a broad sense of the term as it pertains to HTTP;
136: namely all activity involved with HTTP requests or responses for the defined
137: 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.32 avankest 143: <p>Some [<cite><a href="#ref-ecmascript">ECMAScript</a></cite>] examples
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.14 avankest 150: <pre>function test(data) {
151: // taking care of data
152: }
153:
154: function handler() {
155: if(this.readyState == 4 && this.status == 200) {
156: // so far so good
157: if(this.responseXML != null && this.responseXML.getElementById('test').firstChild.data)
158: // success!
159: test(this.responseXML.getElementById('test').firstChild.data);
160: else
161: test(null);
162: } else if (this.readyState == 4 && this.status != 200) {
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");
171: client.send();</pre>
1.16 avankest 172:
1.14 avankest 173: <p>If you just want to ping the server with a message you could do something
1.22 avankest 174: like:</p>
1.16 avankest 175:
1.14 avankest 176: <pre>function ping(message) {
177: var client = new XMLHttpRequest();
178: client.open("POST", "/ping");
179: client.send(message);
180: }</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.14 avankest 184: <pre>function fetchStatus(address) {
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();
193: }</pre>
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.22 avankest 202: <em class="ct">required</em>, <em class="ct">shall</em>, <em class="ct">shall
203: not</em>, <em class="ct">should</em>, <em class="ct">should not</em>,
204: <em class="ct">recommended</em>, <em class="ct">may</em> and
205: <em class="ct">optional</em> in this document are to be interpreted as
206: described in RFC 2119 [<cite><a href="#RFC2119">RFC2119</a></cite>].</p>
1.12 avankest 207:
1.1 avankest 208: <p>This specification defines the following classes of products:</p>
1.12 avankest 209:
1.1 avankest 210: <dl>
211: <dt><dfn>conforming implementation</dfn></dt>
1.24 avankest 212:
1.8 avankest 213: <dd>A user agent that implements all interfaces described in this
1.22 avankest 214: specification and follows all <em class="ct">must</em>-,
1.27 avankest 215: <em class="ct">required</em>- and <em class="ct">shall</em>-level of criteria
1.22 avankest 216: in this specification.</dd>
1.24 avankest 217:
1.1 avankest 218: <dt><dfn>conforming document</dfn></dt>
1.24 avankest 219:
1.1 avankest 220: <dd>A document that follows all <em class="ct">must</em>-,
1.27 avankest 221: <em class="ct">required</em>- and <em class="ct">shall</em>-level of criteria
1.22 avankest 222: in this specification that apply to document authors.</dd>
1.24 avankest 223:
1.1 avankest 224: <dt><dfn>conforming authoring tool</dfn></dt>
1.24 avankest 225:
1.1 avankest 226: <dd>One that produces conforming documents.</dd>
227: </dl>
1.32 avankest 228:
1.30 avankest 229: <h4 id="dependencies">Dependencies</h4>
1.33 avankest 230:
1.29 avankest 231: <p>This specification relies on several underlying specifications.</p>
232: <dl>
233: <dt>DOM</dt>
1.33 avankest 234:
1.29 avankest 235: <dd>
236: <p>Implementations <em class="ct">must</em> support some version of DOM
1.34 avankest 237: Events, because this specification uses some of the features defined in
238: that specification [<cite><a href="#DOM3EV">DOM3Events</a></cite>].</p>
1.29 avankest 239:
240: <p>Implementations <em class="ct">must</em> support some version of the
241: Window Object, because some of the functionality in this specification
242: relies on it [<cite><a href="#ref-window">Window</a></cite>].</p>
243: </dd>
244:
245: <dt>HTTP</dt>
1.33 avankest 246:
1.29 avankest 247: <dd>
248: <p>Implementations <em class="ct">must</em> support the <code>http</code>
249: scheme defined in HTTP. Other requirements regarding HTTP are made
250: throughout the specification
251: [<cite><a href="#RFC2616">RFC2616</a></cite>].</p>
252: </dd>
253: </dl>
1.12 avankest 254:
1.1 avankest 255: <h3 id="extensibility">Extensibility</h3>
1.12 avankest 256:
257: <p><em>This section is non-normative.</em></p>
258:
1.25 avankest 259: <p>Extensions of the APIs defined by this specification are <em>strongly
1.22 avankest 260: discouraged</em>. User agents, Working Groups and other interested parties
1.33 avankest 261: should discuss extensions on a relevant public forum, preferably
1.22 avankest 262: <a href="mailto:public-webapi@w3.org">public-webapi@w3.org</a>.</p>
1.12 avankest 263:
264: <h2 id="xmlhttprequest">The <code title="">XMLHttpRequest</code> Object</h2>
265:
1.1 avankest 266: <p>The <code>XMLHttpRequest</code> interface may be used to allow scripts to
1.22 avankest 267: programmatically connect to their originating server via HTTP.</p>
1.12 avankest 268:
1.1 avankest 269: <p>Objects implementing the <code>XMLHttpRequest</code> interface
1.22 avankest 270: <em class="ct">must</em> also implement the <code>EventTarget</code>
271: interface [<cite><a href="#DOM3EV">DOM3Events</a></cite>].</p>
1.12 avankest 272:
1.34 avankest 273: <p>In [<cite><a href="#ref-ecmascript">ECMAScript</a></cite>], an instance
274: of <code>XMLHttpRequest</code> can be created using the
1.22 avankest 275: <code title="">XMLHttpRequest()</code> constructor:</p>
1.12 avankest 276:
1.1 avankest 277: <div class="example">
278: <pre>var client = new XMLHttpRequest();</pre>
279: </div>
1.12 avankest 280:
1.25 avankest 281: <p>When the constructor is invoked a pointer to the <code>Window</code> object
282: which initially had <code title="">XMLHttpRequest</code> as an attribute of
283: which the constructor was invoked <em class="ct">must</em> be stored on the
1.26 avankest 284: newly created object, called the
1.25 avankest 285: <dfn title="Window pointer" id="window-pointer"><code>Window</code>
286: pointer</dfn>. This <span title="Window pointer">pointer</span>
287: <em class="ct">must</em> persist even if the browsing context in which the
288: <code>Window</code> is located is destroyed (by removing it from a parent
289: browsing context, for instance).</p>
290:
1.27 avankest 291: <p>The term browsing context is defined by the <cite>Window Object 1.0</cite>
1.29 avankest 292: specification .</p>
1.27 avankest 293:
294: <!-- XXX if the document object changes in the browsing context you get an
1.33 avankest 295: exception in some implementations. -->
1.27 avankest 296:
1.31 avankest 297: <h3 id="xmlhttprequest-members">Members of the
298: <code title="">XMLHttpRequest</code> Object</h3>
1.12 avankest 299:
1.1 avankest 300: <pre class="idl">interface <dfn>XMLHttpRequest</dfn> {
1.7 avankest 301: attribute EventListener <span>onreadystatechange</span>;
1.1 avankest 302: readonly attribute unsigned short <span>readyState</span>;
1.12 avankest 303: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>);
304: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>);
305: void <span>open</span>(in DOMString <var>method</var>, in DOMString <var>url</var>, in boolean <var>async</var>, in DOMString <var>user</var>);
306: 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>);
1.3 avankest 307: void <span>setRequestHeader</span>(in DOMString <var>header</var>, in DOMString <var>value</var>);
1.1 avankest 308: void <span>send</span>();
1.3 avankest 309: void <span>send</span>(in DOMString <var>data</var>);
310: void <span>send</span>(in Document <var>data</var>);
1.1 avankest 311: void <span>abort</span>();
312: DOMString <span>getAllResponseHeaders</span>();
1.3 avankest 313: DOMString <span>getResponseHeader</span>(in DOMString <var>header</var>);
1.7 avankest 314: readonly attribute DOMString <span>responseText</span>;
315: readonly attribute Document <span>responseXML</span>;
316: readonly attribute unsigned short <span>status</span>;
317: readonly attribute DOMString <span>statusText</span>;
1.1 avankest 318: };</pre>
1.8 avankest 319:
1.5 avankest 320: <dl>
1.12 avankest 321:
1.22 avankest 322: <dt><dfn id="dfn-onreadystatechange"><code>onreadystatechange</code></dfn> of
323: type <code>EventListener</code></dt>
1.12 avankest 324:
1.1 avankest 325: <dd>
326: <p>An attribute that takes an <code>EventListener</code> as value that
1.22 avankest 327: <em class="ct">must</em> be invoked when <code>readystatechange</code> is
328: dispatched on the object implementing the <code>XMLHttpRequest</code>
329: interface. Its initial value <em class="ct">must</em> be
330: <code>null</code>.</p>
1.1 avankest 331: </dd>
1.12 avankest 332:
1.1 avankest 333: <dt><dfn id="dfn-readystate"><code>readyState</code></dfn> of type
1.22 avankest 334: <code>unsigned short</code>, readonly</dt>
1.12 avankest 335:
1.1 avankest 336: <dd>
337: <p>The state of the object. The attribute <em class="ct">must</em> be one of
1.22 avankest 338: the following values:</p>
1.12 avankest 339:
1.1 avankest 340: <dl>
1.25 avankest 341: <dt><dfn title="uninitialized state">0 Uninitialized</dfn></dt>
1.24 avankest 342:
1.1 avankest 343: <dd>The initial value.</dd>
1.24 avankest 344:
1.25 avankest 345: <dt><dfn title="open state">1 Open</dfn></dt>
1.24 avankest 346:
1.1 avankest 347: <dd>The <code>open()</code> method has been successfully called.</dd>
1.24 avankest 348:
1.25 avankest 349: <dt><dfn title="sent state">2 Sent</dfn></dt>
1.24 avankest 350:
1.15 avankest 351: <dd>The user agent successfully acknowledged the request.</dd>
1.24 avankest 352:
1.25 avankest 353: <dt><dfn title="receiving state">3 Receiving</dfn></dt>
1.24 avankest 354:
1.1 avankest 355: <dd>Immediately before receiving the message body (if any). All HTTP
1.22 avankest 356: headers have been received.</dd>
1.24 avankest 357:
1.25 avankest 358: <dt><dfn title="loaded state">4 Loaded</dfn></dt>
1.24 avankest 359:
1.1 avankest 360: <dd>The data transfer has been completed.</dd>
361: </dl>
1.21 avankest 362:
363: <p class="note">When <code>readyState</code> changes value a
1.22 avankest 364: <code>readystatechange</code> event is to be dispatched on the
365: <code>XMLHttpRequest</code> object.</p>
1.1 avankest 366: </dd>
1.12 avankest 367:
1.14 avankest 368: <dt><dfn id="dfn-open" title="open"><code>open(<var>method</var>,
1.22 avankest 369: <var>url</var>, <var>async</var>, <var>user</var>,
370: <var>password</var>)</code></dfn>, method</dt>
1.12 avankest 371:
1.1 avankest 372: <dd>
1.26 avankest 373: <p>Invoking this method <em class="ct">must</em> initialize the object by
374: remembering the <var>method</var>, <var>url</var>, <var>async</var>
375: (defaulting to <code>true</code> if omitted), <var>user</var> (defaulting to
376: <code>null</code> if omitted), and <var>password</var> (defaulting to
377: <code>null</code> if omitted) arguments, setting the state to
378: <span title="open state">open</span>, resetting the
1.22 avankest 379: <code>responseText</code>, <code>responseXML</code>, <code>status</code>,
380: and <code>statusText</code> attributes to their initial values, and
381: resetting the list of request headers.</p>
1.12 avankest 382:
1.26 avankest 383: <p>In addition, when the state is not
1.27 avankest 384: <span title="uninitialized state">uninitialized</span>, all members of the
385: object with the exception of <code>onreadystate</code>
386: <em class="ct">must</em> be set to their initial values and user agents
387: <em class="ct">must</em> behave as if <code>abort()</code> was invoked.</p>
1.24 avankest 388:
1.13 avankest 389: <p>If the <var>method</var> argument doesn't match the <dfn>method
1.22 avankest 390: production</dfn> defined in section 5.1.1 of
391: [<cite><a href="#RFC2616">RFC2616</a></cite>] a <code>SYNTAX_ERR</code>
392: <em class="ct">must</em> be raised by the user agent. If the user agent
393: doesn't support the given method for security reasons a
394: <code>SECURITY_ERR</code> <em class="ct">should</em> be raised.</p>
1.14 avankest 395:
1.13 avankest 396: <p>User agents <em class="ct">must</em> at least support the following list
1.22 avankest 397: of methods (see [<cite><a href="#RFC2616">RFC2616</a></cite>]):</p>
1.14 avankest 398:
1.13 avankest 399: <ul>
400: <li><code>GET</code></li>
401: <li><code>POST</code></li>
402: <li><code>HEAD</code></li>
403: <li><code>PUT</code></li>
404: <li><code>DELETE</code></li>
405: </ul>
1.16 avankest 406:
1.13 avankest 407: <p>User agents <em class="ct">should</em> support any <var>method</var>
1.22 avankest 408: argument that matches the <span>method production</span>.</p>
1.14 avankest 409:
1.13 avankest 410: <p>When <var>method</var> case-insensitively matches <code>GET</code>,
1.22 avankest 411: <code>POST</code>, <code>HEAD</code>, <code>PUT</code> or
1.25 avankest 412: <code>DELETE</code> user agents <em class="ct">must</em> use the
1.22 avankest 413: uppercase equivalent instead.</p>
1.12 avankest 414:
1.33 avankest 415: <p>When <var>url</var> is a relative reference, it
416: <em class="ct">must</em> be resolved using the current value of the
417: <code>baseURI</code> attribute of the <code>Document</code> object
418: currently associated with the <span><code>Window</code> pointer</span> and
419: the fragment identifier component, if any, <em class="ct">must</em> be
420: dropped. If it can't be resolved user agents <em class="ct">must</em>
421: throw a <code>SYNTAX_ERR</code>. When a non same-origin <var>url</var>
422: argument is given user agents <em class="ct">should</em> throw a
1.25 avankest 423: <code>SECURITY_ERR</code> exception.</p>
1.14 avankest 424:
1.19 avankest 425: <p class="note">A future version or extension of this specification will
1.33 avankest 426: most likely define a way of doing cross-site requests.</p>
1.21 avankest 427:
1.17 avankest 428: <p>User agents <em class="ct">should not</em> support the "user:password"
1.22 avankest 429: format in the <code>userinfo</code> production defined in section 3.2.1 of
430: [<cite><a href="#ref-rfc3986">RFC3986</a></cite>] and
1.33 avankest 431: <em class="ct">must</em> throw a <code>SYNTAX_ERR</code> when doing so
432: (not supporting it). When they do support it, or in case of people using
433: the format "user", user agents <em class="ct">must</em> use them if the
1.22 avankest 434: <var>user</var> and <var>password</var> arguments are omitted. If the
435: arguments are not omitted, they take precedence, even if they are
436: <code>null</code>.</p>
1.17 avankest 437:
438: <p>If the <var>user</var> argument doesn't match the
1.22 avankest 439: <code>username-value</code> production defined in section 3.2.2 of
440: [<cite><a href="#ref-rfc2617">RFC2617</a></cite>] user agents
441: <em class="ct">must</em> throw a <code>SYNTAX_ERR</code> exception.</p>
442:
1.27 avankest 443: <p>It is undefined in this specification what production <var>password</var>
444: has to match. User agents <em class="ct">may</em> throw a
445: <code>SYNTAX_ERR</code> for a production they don't accept.</p>
446:
447: <p class="note">[<cite><a href="#ref-rfc2617">RFC2617</a></cite>] doesn't
448: clearly define what the passwd production can or can't contain.</p>
449:
1.34 avankest 450: <p>When <code>null</code> is passed for either <var>user</var> or
451: <var>password</var> user agents <em class="ct">must</em> act as if the
452: relevant data (the user name or password) is not provided.</p>
453:
454: <p class="note">The empty string value is not to be treated as the
455: <code>null</code> value. If it's disallowed by the syntax for either
456: <var>user</var> or <var>password</var> a <code>SYNTAX_ERR</code> has to be
457: thrown as indicated above.</p>
1.1 avankest 458: </dd>
1.12 avankest 459:
1.14 avankest 460: <dt><dfn id="dfn-setrequestheader" title="setrequestheader"><code>setRequestHeader(<var>header</var>,
1.22 avankest 461: <var>value</var>)</code></dfn>, method</dt>
1.12 avankest 462:
1.5 avankest 463: <dd>
464: <p>The nominated request header (<var>header</var>) field value
1.22 avankest 465: <em class="ct">must</em> be set to <var>value</var>, with the following
466: exceptions:</p>
1.14 avankest 467:
1.5 avankest 468: <ul>
1.25 avankest 469: <li>If the state is not <span title="open state">open</span> or the
470: <span><code>send()</code> flag</span> is set an
1.22 avankest 471: <code>INVALID_STATE_ERR</code> exception <em class="ct">must</em> be
472: raised;</li>
1.14 avankest 473:
1.13 avankest 474: <li>If the <var>header</var> argument doesn't match the
1.22 avankest 475: <dfn><code>field-name</code> production</dfn> as defined by section 4.2
476: of [<cite><a href="#RFC2616">RFC2616</a></cite>] a <code>SYNTAX_ERR</code>
477: <em class="ct">must</em> be raised;</li>
1.14 avankest 478:
1.13 avankest 479: <li>If the <var>value</var> argument doesn't match the
1.22 avankest 480: <dfn><code>field-value</code> production</dfn> as defined by section 4.2
481: of [<cite><a href="#RFC2616">RFC2616</a></cite>] a <code>SYNTAX_ERR</code>
482: <em class="ct">must</em> be raised;</li>
1.14 avankest 483:
1.32 avankest 484: <li>
1.35 ! avankest 485: <p>For security reasons the invocation <em class="ct">should</em> be
! 486: ignored if the <var>header</var> argument matches one of the following
! 487: headers case-insensitively:</p>
1.32 avankest 488: <ul>
489: <li><code>Accept-Charset</code></li>
490: <li><code>Accept-Encoding</code></li>
491: <li><code>Content-Length</code></li>
492: <li><code>Expect</code></li>
493: <li><code>Date</code></li>
494: <li><code>Host</code></li>
495: <li><code>Keep-Alive</code></li>
496: <li><code>Referer</code></li>
497: <li><code>TE</code></li>
498: <li><code>Trailer</code></li>
499: <li><code>Transfer-Encoding</code></li>
500: <li><code>Upgrade</code></li>
501: </ul>
502: <!-- XXX or should this throw an exception? -->
503: </li>
1.5 avankest 504: </ul>
505:
1.32 avankest 506: <!-- Add "Expect" back in below if we remove it above. -->
1.5 avankest 507: <p>Implementations <em class="ct">must</em> replace any existing value if
1.32 avankest 508: the nominated request header field value is one of:</p>
509:
510: <ul>
511: <li><code>Authorization</code></li>
512: <li><code>Content-Base</code></li>
513: <li><code>Content-Location</code></li>
514: <li><code>Content-MD5</code></li>
515: <li><code>Content-Range</code></li>
516: <li><code>Content-Type</code></li>
517: <li><code>Content-Version</code></li>
518: <li><code>Delta-Base</code></li>
519: <li><code>Depth</code></li>
520: <li><code>Destination</code></li>
521: <li><code>ETag</code></li>
522: <li><code>From</code></li>
523: <li><code>If-Modified-Since</code></li>
524: <li><code>If-Range</code></li>
525: <li><code>If-Unmodified-Since</code></li>
526: <li><code>Max-Forwards</code></li>
527: <li><code>MIME-Version</code></li>
528: <li><code>Overwrite</code></li>
529: <li><code>Proxy-Authorization</code></li>
530: <li><code>SOAPAction</code></li>
531: <li><code>Timeout</code></li>
532: </ul>
1.14 avankest 533:
1.5 avankest 534: <p>Otherwise, if the nominated request header field already has a value, the
1.22 avankest 535: new value <em class="ct">must</em> be combined with the existing value
536: (section 4.2, [<cite><a href="#RFC2616">RFC2616</a></cite>]). See also the
537: <code>send()</code> method regarding user agent header handling for caching,
538: authentication, proxies, and cookies.</p>
1.14 avankest 539:
540: <div class="example">
541: <pre>// The following script:
542: var client = new XMLHttpRequest();
543: client.open('GET', 'demo.cgi');
544: client.setRequestHeader('X-Test', 'one');
545: client.setRequestHeader('X-Test', 'two');
546: client.send();
547:
548: // ...would result in the following header being sent:
549: ...
550: X-Test: one, two
551: ...</pre>
552: </div>
553:
1.13 avankest 554: <p>The list of request headers <em class="ct">must</em> be reset when the
1.22 avankest 555: <code>open()</code> method is invoked.</p>
1.5 avankest 556: </dd>
1.12 avankest 557:
1.14 avankest 558: <dt><dfn id="dfn-send" title="send"><code>send(<var>data</var>)</code></dfn>,
1.22 avankest 559: method</dt>
1.12 avankest 560:
1.17 avankest 561: <dd>
1.25 avankest 562: <p>If the state is not <span title="open state">open</span> or the
563: <span><code>send()</code> flag</code> is set an
564: <code>INVALID_STATE_ERR</code> exception <em class="ct">must</em> be raised.
565: Otherwise user agents <em class="ct">must</em> make a request to
1.22 avankest 566: <var>url</var> using method <var>method</var> and set the
567: <dfn><code>send()</code> flag</dfn>. If the <var>async</var> flag is set to
568: <code>false</code>, then the method <em class="ct">must not</em> return
569: until the request has completed. Otherwise, it <em class="ct">must</em>
570: return immediately. (See: <code>open()</code>.)</p>
1.21 avankest 571:
1.25 avankest 572: <p class="note">Even when <var>async</var> is set to <code>false</code> the
573: <code>readystatechange</code> event will still be dispatched.</p>
1.27 avankest 574:
1.20 avankest 575: <p class="note">The <span><code>send()</code> flag</span> is only relevant
1.25 avankest 576: when the state is <span title="open state">open</span>.</p>
1.12 avankest 577:
578: <p>If <var>data</var> is passed to the <code>send()</code> method it
1.27 avankest 579: <em class="ct">must</em> be used for the <dfn id="dfn-entity-body">entity
580: body</dfn> as defined by section 7.2.1 of
581: [<cite><a href="#RFC2616">RFC2616</a></cite>]). The following rules
582: apply:</p>
583:
584: <dl>
585: <dt><var>data</var> is a <code>DOMString</code></dt>
1.12 avankest 586:
1.27 avankest 587: <dd><var>data</var> <em class="ct">must</em> be encoded as UTF-8 for
588: transmission.</dd>
589:
590: <dt><var>data</var> is a <code>Document</code>
1.24 avankest 591:
1.27 avankest 592: <dd><var>data</var> <em class="ct">must</em> be serialized into a namespace
593: well-formed XML document and encoded using the encoding given by
594: <code><var>data</var>.xmlEncoding</code> (the XML declaration), if
595: specified, or UTF-8 otherwise. The serialization <em class="ct">must</em>
596: include an XML declaration when the final encoding is not UTF-8 or
597: UTF-16.</dd>
598:
599: <dt><var>data</var> is not a <code>DOMString</code> or
600: <code>Document</code></dt>
601:
602: <dd>The stringification mechanisms of the host language
603: <em class="ct">must</em> be used on <var>data</var> and the result
604: <em class="ct">must</em> be treated as if <var>data</var> is a
605: <code>DOMString</code>.</dd>
606: </dl>
1.12 avankest 607:
1.16 avankest 608: <p>Invoking <code>send()</code> without the <var>data</var> argument
1.22 avankest 609: <em class="ct">must</em> give the same result as if it was invoked with
610: <code>null</code> as argument.</p>
1.12 avankest 611:
612: <p>Authors <em class="ct">should</em> specify the <code>Content-Type</code>
1.22 avankest 613: header via <code>setRequestHeader</code> before invoking
614: <code>send()</code> with an argument. If the argument to
615: <code>send()</code> is a <code>Document</code> and no
616: <code>Content-Type</code> header has been set user agents
617: <em class="ct">must</em> set it to <code>application/xml</code> for XML
618: documents and to the most appropriate media type for other documents (using
619: intrinsic knowledge about the document).</p>
1.12 avankest 620:
1.14 avankest 621: <p>If the response is an HTTP redirect (status code <code>301</code>,
1.22 avankest 622: <code>302</code>, <code>303</code> or <code>307</code>), then it
623: <em class="ct">must</em> be transparently followed (unless it violates
624: security, infinite loop precautions or the scheme isn't supported). Note
625: that HTTP ([<cite><a href="#RFC2616">RFC2616</a></cite>]) places
626: requirements on user agents regarding the preservation of the request
627: method during redirects, and also requires users to be notified of certain
628: kinds of automatic redirections.</p>
1.12 avankest 629:
1.25 avankest 630: <p>Once the request has been successfully acknowledged the state
631: <em class="ct">must</em> be set to <span title="sent state">sent</span>.
632: Immediately before receiving the message body (if any), the state
633: <em class="ct">must</em> be set to to
634: <span title="receiving state">receiving</span>. When the request has
635: completed loading, the state <em class="ct">must</em> be set to
636: <span title="loaded state">loaded</span>.</p>
1.27 avankest 637:
1.25 avankest 638: <p class="note">This means that in case of a <code>HEAD</code> request the
639: state is set to <span title="loaded state">loaded</span> immediately after
640: having being set to <span title="receiving state">receiving</span>.</p>
641:
642: <p>If something goes wrong (infinite loop, network errors) the state
643: <em class="ct">must</em> be set to <span title="loaded state">loaded</span>
1.27 avankest 644: and all members (excluding <code>readyState</code>) of the object
1.31 avankest 645: <em class="ct">must</em> be set to their initial value. Also, if
1.33 avankest 646: <code>async</code> is set to <code>false</code>, a
647: <code>NETWORK_ERR</code> exception <em class="ct">must</em> be raised. In
648: addition, all registered event listeners <em class="ct">must</em> be
649: removed.</p>
1.16 avankest 650:
1.15 avankest 651: <p class="note">In future versions of this specification user agents will be
1.22 avankest 652: required to dispatch an <code>error</code> event if the above occurs.</p>
1.14 avankest 653:
1.8 avankest 654: <p>If the user agent allows the specification of a proxy it
1.22 avankest 655: <em class="ct">should</em> modify the request appropriately;
656: <abbr title="in other words">i.e.</abbr>, connect to the proxy host instead
657: of the origin server, modify the <code>Request-Line</code> and send
658: <code>Proxy-Authorization</code> headers as specified.</p>
1.12 avankest 659:
1.14 avankest 660: <p>If the user agent supports <cite>HTTP Authentication</cite>
1.22 avankest 661: ([<cite><a href="#ref-rfc2617">RFC2617</a></cite>]) it
662: <em class="ct">should</em> consider requests originating from this object
663: to be part of the protection space that includes the accessed URIs and send
664: <code>Authorization</code> headers and handle <code>401 Unauthorised</code>
665: requests appropriately. if authentication fails, user agents
666: <em class="ct">should</em> prompt the users for credentials.</p>
1.12 avankest 667:
1.14 avankest 668: <p>If the user agent supports <cite>HTTP State Mangement</cite>
1.22 avankest 669: ([<cite><a href="#ref-rfc2109">RFC2109</a></cite>],
670: [<cite><a href="#ref-rfc2965">RFC2965</a></cite>]) it
671: <em class="ct">should</em> persist, discard and send cookies (as received in
672: the <code>Set-Cookie</code> and <code>Set-Cookie2</code> response headers,
673: and sent in the <code>Cookie</code> header) as applicable.</p>
1.12 avankest 674:
1.8 avankest 675: <p>If the user agent implements a HTTP cache
1.22 avankest 676: ([<cite><a href="#RFC2616">RFC2616</a></cite>]) it
677: <em class="ct">should</em> respect <code>Cache-Control</code> request
678: headers set by the author (<abbr title="for example">e.g.</abbr>,
679: <code>Cache-Control: no-cache</code> bypasses the cache). It
680: <em class="ct">must not</em> send <code>Cache-Control</code> or
681: <code>Pragma</code> request headers automatically unless the user explicitly
682: requests such behaviour (e.g., by (force-)reloading the page). <code>304 Not
683: Modified</code> responses that are a result of a user agent generated
684: conditional request <em class="ct">must</em> be presented as <code>200
685: OK</code> responses with the appropriate content. Such user agents
686: <em class="ct">must</em> allow authors to override automatic cache
687: validation by setting request headers (e.g., <code>If-None-Match</code>,
688: <code>If-Modified-Since</code>), in which case <code>304 Not Modified</code>
689: responses <em class="ct">must</em> be passed through.</p>
1.12 avankest 690:
1.8 avankest 691: <p>If the user agent implements server-driven content-negotiation
1.22 avankest 692: ([<cite><a href="#RFC2616">RFC2616</a></cite>]) it
693: <em class="ct">should</em> set <code>Accept-Language</code>,
694: <code>Accept-Encoding</code> and <code>Accept-Charset</code> headers as
695: appropriate; it <em class="ct">must not</em> automatically set the
696: <code>Accept</code> header. Responses to such requests
697: <em class="ct">must</em> have content-codings automatically removed.</p>
1.14 avankest 698:
699: <p>If the user agent supports Expect/Continue for request bodies
1.22 avankest 700: ([<cite><a href="#RFC2616">RFC2616</a></cite>]) it
701: <em class="ct">should</em> insert <code>Expect</code> headers and handle
702: <code>100 Continue</code> responses appropriately.</p>
1.8 avankest 703: </dd>
1.12 avankest 704:
1.14 avankest 705: <dt><dfn id="dfn-abort"><code>abort()</code></dfn>, method</dt>
1.12 avankest 706:
1.5 avankest 707: <dd>
708: <p>When invoked, this method <em class="ct">must</em> cancel any network
1.22 avankest 709: activity for which the object is responsible and set all the members of the
1.27 avankest 710: object to their initial values as well as removing all event listeners.</p>
1.24 avankest 711:
712: <p class="note">This means that the object <em>can</em> be used for another
713: request in which case this method will work again to cancel it.</p>
1.5 avankest 714: </dd>
1.12 avankest 715:
1.14 avankest 716: <dt><dfn id="dfn-getallresponseheaders"><code>getAllResponseHeaders()</code></dfn>,
1.22 avankest 717: method</dt>
1.12 avankest 718:
1.5 avankest 719: <dd>
1.25 avankest 720: <p>If the state is not <span title="receiving state">receiving</span> or
721: <span title="loaded state">loaded</span>, user agents
722: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code> exception.
723: Otherwise, it <em class="ct">must</em> return all the HTTP headers, as a
724: single string, with each header line separated by a CR (U+000D) LF (U+000A)
725: pair. The status line <em class="ct">must not</em> be included.</p>
1.24 avankest 726:
1.5 avankest 727: <div class="example">
728: <pre>// The following script:
729: var client = new XMLHttpRequest();
1.14 avankest 730: client.open("GET", "test.txt", true);
1.5 avankest 731: client.send();
1.12 avankest 732: client.onreadystatechange = function() {
1.13 avankest 733: if(this.readyState == 3) {
1.12 avankest 734: print(this.getAllResponseHeaders());
735: }
736: }
1.5 avankest 737:
738: // ...should output something similar to the following text:
739: Date: 2004年10月24日 04:58:38 GMT
740: Server: Apache/1.3.31 (Unix)
741: Keep-Alive: timeout=15, max=99
742: Connection: Keep-Alive
743: Transfer-Encoding: chunked
744: Content-Type: text/plain; charset=utf-8</pre>
745: </div>
746: </dd>
1.12 avankest 747:
1.18 avankest 748: <dt><dfn id="dfn-getresponseheader" title="getresponseheader"><code>getResponseHeader(<var>header</var>)</code></dfn>,
1.22 avankest 749: method</dt>
1.12 avankest 750:
1.1 avankest 751: <dd>
1.13 avankest 752: <p>If the <var>header</var> argument doesn't match the
1.22 avankest 753: <span><code>field-name</code> production</span> a <code>SYNTAX_ERR</code>
754: <em class="ct">must</em> be raised. Otherwise this method works as described
755: below.</p>
1.14 avankest 756:
1.25 avankest 757: <p>If the state is not <span title="receiving state">receiving</span> or
758: <span title="loaded state">loaded</span>, the user agent
759: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code> exception.
760: Otherwise, it <em class="ct">must</em> represent the value of the given HTTP
761: header (<var>header</var>) in the data received so far for the last request
762: sent, as a single string. If more than one header of the given name was
763: received, then the values <em class="ct">must</em> be concatenated,
764: separated from each other by an U+002C COMMA followed by an U+0020 SPACE. If
765: no headers of that name were received, then it <em class="ct">must</em>
766: return <code>null</code>. Header names <em class="ct">must</em> be compared
1.22 avankest 767: case-insensitively to the method its argument (<var>header</var>).</p>
1.12 avankest 768:
1.1 avankest 769: <div class="example">
770: <pre>// The following script:
771: var client = new XMLHttpRequest();
1.14 avankest 772: client.open("GET", "test.txt", true);
1.5 avankest 773: client.send();
1.12 avankest 774: client.onreadystatechange = function() {
1.13 avankest 775: if(this.readyState == 3) {
1.14 avankest 776: print(client.getResponseHeader("Content-Type"));
1.12 avankest 777: }
778: }
1.1 avankest 779:
1.5 avankest 780: // ...should output something similar to the following text:
781: Content-Type: text/plain; charset=utf-8</pre>
1.1 avankest 782: </div>
1.5 avankest 783: </dd>
1.12 avankest 784:
1.5 avankest 785: <dt><dfn id="dfn-responsetext"><code>responseText</code></dfn> of type
1.22 avankest 786: <code>DOMString</code>, readonly</dt>
1.12 avankest 787:
1.5 avankest 788: <dd>
1.25 avankest 789: <p>If the state is not <span title="receiving state">receiving</span> or
790: <span title="loaded state">loaded</span>, the user agent
791: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code> exception.
792: Otherwise, it <em class="ct">must</em> be the fragment of the <span>entity
793: body</span> received so far (when the state is
794: <span title="receiving state">receiving</span>) or the complete <span>entity
795: body</span> (when the state is <span title="loaded state">loaded</span>),
796: interpreted as a stream of characters.</p>
1.12 avankest 797:
798: <p>If the response includes a <code>Content-Type</code> understood by the
1.22 avankest 799: user agent the characters are encoded following the relevant media type
800: specification, with the exception that the rule in the final paragraph of
801: section 3.7.1 of [<cite><a href="#RFC2616">RFC2616</a></cite>], and the
802: rules in section 4.1.2 of [<cite><a href="#ref-rfc2046">RFC2046</a></cite>]
803: <em class="ct">must</em> be treated as if they specified the default
804: character encoding as being UTF-8. Invalid bytes <em class="ct">must</em> be
805: converted to U+FFFD REPLACEMENT CHARACTER. If the user agent can't derive a
806: character stream in accord with the media type specification,
807: <code>reponseText</code> <em class="ct">must</em> be <code>null</code>.</p>
1.12 avankest 808:
809: <p>Its initial value <em class="ct">must</em> be the <code>null</code>.</p>
1.21 avankest 810:
1.24 avankest 811: <p class="note">For <code>HEAD</code> requests this attribute will always
812: be <code>null</code> (it remains unchanged). Similar to the
1.22 avankest 813: <code>responseXML</code> attribute.</p>
1.5 avankest 814: </dd>
1.12 avankest 815:
1.5 avankest 816: <dt><dfn id="dfn-responsexml"><code>responseXML</code></dfn> of type
1.22 avankest 817: <code>Document</code>, readonly</dt>
1.12 avankest 818:
1.8 avankest 819: <dd>
1.25 avankest 820: <p>If the state is not <span title="loaded state">loaded</span>, user agents
821: <em class="ct">must</em> raise an <code>INVALID_STATE_ERR</code> exception.
822: Otherwise, if the <code>Content-Type</code> header contains a media type
823: (ignoring any parameters) that is either <code>text/xml</code>,
1.22 avankest 824: <code>application/xml</code>, or ends in <code>+xml</code>, it
825: <em class="ct">must</em> be an object that implements the
826: <code>Document</code> interface representing the parsed document. If
827: <code>Content-Type</code> did not contain such a media type, or if the
828: document could not be parsed (due to an XML well-formedness error or
829: unsupported character encoding, for instance), it <em class="ct">must</em>
830: be <code>null</code>.</p>
1.12 avankest 831:
1.8 avankest 832: <p>Its initial value <em class="ct">must</em> be <code>null</code>.</p>
1.5 avankest 833: </dd>
1.12 avankest 834:
1.22 avankest 835: <dt><dfn id="dfn-status"><code>status</code></dfn> of type <code>unsigned
836: short</code>, readonly</dt>
1.12 avankest 837:
1.5 avankest 838: <dd>
839: <p>If the <code>status</code> attribute is not available an
1.22 avankest 840: <code>INVALID_STATE_ERR</code> exception <em class="ct">must</em> be raised.
1.25 avankest 841: It <em class="ct">must</em> be available when the state is
842: <span title="receiving state">receiving</span> or
843: <span title="loaded state">loaded</span>. When available, it
844: <em class="ct">must</em> represent the HTTP status code (typically
845: <code>200</code> for a successful connection).</p>
1.27 avankest 846:
1.8 avankest 847: <p>Its initial value <em class="ct">must</em> be <code>0</code>.</p>
1.12 avankest 848: </dd>
849:
1.5 avankest 850: <dt><dfn id="dfn-statustext"><code>statusText</code></dfn> of type
1.22 avankest 851: <code>DOMString</code>, readonly</dt>
1.12 avankest 852:
1.5 avankest 853: <dd>
854: <p>If the <code>statusText</code> attribute is not available an
1.22 avankest 855: <code>INVALID_STATE_ERR</code> exception <em class="ct">must</em> be raised.
1.25 avankest 856: It <em class="ct">must</em> be available when the state is
857: <span title="receiving state">receiving</span> or
858: <span title="loaded state">loaded</span>). When available, it
859: <em class="ct">must</em> represent the HTTP status text sent by the server
860: (appears after the status code).</p>
1.21 avankest 861:
1.8 avankest 862: <p>Its initial value <em class="ct">must</em> be the empty string.</p>
1.1 avankest 863: </dd>
864: </dl>
1.12 avankest 865:
1.1 avankest 866: <p>HTTP requests sent from multiple different <code>XMLHttpRequest</code>
1.22 avankest 867: objects in succession <em class="ct">should</em> be pipelined into shared HTTP
868: connections.</p>
1.12 avankest 869:
1.31 avankest 870: <h3 id="events">Events for the <code title="">XMLHttpRequest</code>
871: Object</h3>
1.12 avankest 872:
1.1 avankest 873: <p>These sections describe the various events that can be dispatched on the
1.22 avankest 874: object implementing the <code>XMLHttpRequest</code> interface. For this
875: version of the specification only one event is defined.</p>
1.12 avankest 876:
1.1 avankest 877: <dl>
878: <dt><dfn id="dfn-readystatechange"><code>readystatechange</code></dfn></dt>
1.24 avankest 879:
1.1 avankest 880: <dd>The <code>readystatechange</code> event <em class="ct">must</em> be
1.22 avankest 881: dispatched when <code>readyState</code> changes value. It <em class="ct">must
882: not</em> bubble, <em class="ct">must not</em> be cancelable and
883: <em class="ct">must</em> implement the <code>Event</code> interface
884: [<cite><a href="#DOM3EV">DOM3Events</a></cite>]. The event has no namespace
885: (<code>Event.namespaceURI</code> is <code>null</code>).</dd>
1.1 avankest 886: </dl>
1.32 avankest 887:
1.31 avankest 888: <h3 id="exceptions">Exceptions for the <code title="">XMLHttpRequest</code>
889: Object</h3>
890:
1.32 avankest 891: <pre class="idl">exception <dfn>XMLHttpRequestException</dfn> {
1.31 avankest 892: unsigned short code;
893: };
894: const unsigned short <span>NETWORK_ERR</span> = 101;</pre>
895:
1.33 avankest 896: <p>The <dfn id="network-err"><code>NETWORK_ERR</code></dfn> exception is
897: thrown when a network error occurs in synchronous requests. See the section
898: on <code>send()</code> for more details.</p>
1.31 avankest 899: <!-- Other specifications should probably be able to reuse this... -->
1.11 avankest 900:
1.29 avankest 901: <h2 class="no-num" id="notcovered">Not in this Specification</h2>
902:
903: <p><em>This section is non normative.</em></p>
904:
905: <p>This specification does not include the following features that may or may
906: not be implemented by user agents:</p>
907:
908: <ul>
909: <li><code>load</code> event and <code>onload</code> attribute;</li>
910: <li><code>error</code> event and <code>onerror</code> attribute;</li>
911: <li><code>progress</code> event and <code>onprogress</code> attribute;</li>
912: <li><code title="">abort</code> event and <code>onabort</code> attribute;</li>
913: <li>Timers have been suggested, perhaps an <code>ontimeout</code>
914: attribute;</li>
915: <li>Property to disable following redirects;</li>
1.30 avankest 916: <li><code title="">responseXML</code> for <code>text/html</code>
917: documents;</li>
918: <li>Cross-site <code title="">XMLHttpRequest</code>.</li>
1.29 avankest 919: </ul>
920:
1.1 avankest 921: <h2 class="no-num" id="bibref">References</h2>
1.11 avankest 922:
1.6 avankest 923: <dl>
1.11 avankest 924: <dt id="DOM3">[DOM3Core]</dt>
1.24 avankest 925:
1.11 avankest 926: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-3-Core">Document Object
927: Model (DOM) Level 3 Core Specification</a></cite>, A. Le Hors, P. Le
928: Hégaret, L. Wood, G. Nicol, J. Robie, M. Champion, S. Byrne, editors.
929: World Wide Web Consortium, April 2004.</dd>
930:
931: <dt id="DOM3EV">[DOM3Events]</dt>
1.24 avankest 932:
1.1 avankest 933: <dd><cite><a href="http://www.w3.org/TR/DOM-Level-3-Events/">Document Object
1.11 avankest 934: Model (DOM) Level 3 Events Specification</a></cite>, Björn Höhrmann, editor.
935: World Wide Web Consortium, April 2006.</dd>
936:
1.14 avankest 937: <dt id="ref-ecmascript">[ECMAScript]</dt>
1.24 avankest 938:
1.14 avankest 939: <dd><cite><a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript
940: Language Specification</a></cite>, Third Edition. ECMA, December 1999.</dd>
941:
942: <dt id="ref-rfc2046">[RFC2046]</dt>
1.24 avankest 943:
1.19 avankest 944: <dd><cite><a href="http://ietf.org/rfc/rfc2046">Multipurpose Internet Mail
945: Extensions (MIME) Part Two: Media Types</a></cite>, N. Freed, N. Borenstein,
946: editors. IETF, November 1996.</dd>
1.14 avankest 947:
1.11 avankest 948: <dt id="ref-rfc2109">[RFC2109]</dt>
1.24 avankest 949:
1.11 avankest 950: <dd><cite><a href="http://ietf.org/rfc/rfc2109">HTTP State Management
951: Mechanism</a></cite>, D. Kristol, L. Montulli, editors. IETF, February
952: 1997.</dd>
953:
954: <dt id="RFC2119">[RFC2119]</dt>
1.24 avankest 955:
1.11 avankest 956: <dd><cite><a href="http://ietf.org/rfc/rfc2119">RFC 2119: Key words
957: for use in RFCs to Indicate Requirement Levels</a></cite>, S. Bradner.
958: IETF, March 1997.</dd>
1.12 avankest 959:
1.11 avankest 960: <dt id="RFC2616">[RFC2616]</dt>
1.24 avankest 961:
1.11 avankest 962: <dd><cite><a href="http://ietf.org/rfc/rfc2616">Hypertext Transfer Protocol
963: -- HTTP/1.1</a></cite>, R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L.
964: Masinter, P. Leach, T. Berners-Lee, editors. IETF, June 1999</dd>
1.12 avankest 965:
1.11 avankest 966: <dt id="ref-rfc2617">[RFC2617]</dt>
1.24 avankest 967:
1.11 avankest 968: <dd><cite><a href="http://ietf.org/rfc/rfc2617">HTTP Authentication: Basic
1.14 avankest 969: and Digest Access Authentication</a></cite>, ...</dd>
1.12 avankest 970:
1.11 avankest 971: <dt id="ref-rfc2965">[RFC2965]</dt>
1.24 avankest 972:
1.19 avankest 973: <dd><cite><a href="http://ietf.org/rfc/rfc2965">HTTP State Management
974: Mechanism</a></cite>, D. Kristol, L. Montulli, editors. IETF, October
975: 2000.</dd>
976:
1.11 avankest 977: <dt id="ref-rfc3986">[RFC3986]</dt>
1.24 avankest 978:
1.11 avankest 979: <dd><cite><a href="http://ietf.org/rfc/rfc3986">Uniform Resource Identifier
980: (URI): Generic Syntax</a></cite>, T. Berners-Lee, R. Fielding, L. Masinter,
981: editors. IETF, January 2005.</dd>
1.28 avankest 982:
983: <dt id="ref-window">[Window]</dt>
984:
985: <dd><cite><a href="http://www.w3.org/TR/Window/">Window Object
986: 1.0</a></cite>, I. Davis, M. Stachowiak, editors. W3C, April 2006.</dd>
1.1 avankest 987: </dl>
1.11 avankest 988:
1.1 avankest 989: <h2 class="no-num" id="acknowledgements">Acknowledgements</h2>
1.11 avankest 990:
1.1 avankest 991: <p><em>This section is non-normative</em></p>
1.12 avankest 992:
1.7 avankest 993: <p>The editor would like to thank to the following people who have contributed
1.33 avankest 994: to this specification (ordered by first name):</p>
1.12 avankest 995:
1.1 avankest 996: <ul>
1.22 avankest 997: <li>Alex Hopmann</li>
1.7 avankest 998: <li>Alex Vincent</li>
1.15 avankest 999: <li>Alexey Proskuryakov</li>
1.1 avankest 1000: <li>Asbjørn Ulsberg</li>
1001: <li>Boris Zbarsky</li>
1002: <li>Björn Höhrmann</li>
1003: <li>Cameron McCormack</li>
1004: <li>Christophe Jolif</li>
1005: <li>Charles McCathieNevile</li>
1006: <li>Dean Jackson</li>
1007: <li>Doug Schepers</li>
1008: <li>Douglas Livingstone</li>
1009: <li>Gorm Haug Eriksen</li>
1010: <li>Hallvord R. M. Steen</li>
1011: <li>Håkon Wium Lie</li>
1012: <li>Ian Davis</li>
1013: <li>Ian Hickson</li>
1014: <li>Ivan Herman</li>
1015: <li>Jens Lindström</li>
1016: <li>Jim Deegan</li>
1017: <li>Jim Ley</li>
1018: <li>Jonas Sicking</li>
1019: <li>Julian Reschke</li>
1020: <li>Karl Dubost</li>
1021: <li>Maciej Stachowiak</li>
1.7 avankest 1022: <li>Magnus Kristiansen</li>
1.1 avankest 1023: <li>Marc Hadley</li>
1024: <li>Mark Nottingham</li>
1025: <li>Pawel Glowacki</li>
1.24 avankest 1026: <li>Q42</li>
1.1 avankest 1027: <li>Robin Berjon</li>
1028: <li>Ruud Steltenpool</li>
1.33 avankest 1029: <li>Simon Pieters</li>
1.1 avankest 1030: </ul>
1.12 avankest 1031:
1.1 avankest 1032: <p>Special thanks to the Microsoft employees who first implemented the
1.22 avankest 1033: <code>XMLHttpRequest</code> interface, which was first widely deployed by the
1034: Windows Internet Explorer browser.</p>
1.12 avankest 1035:
1.1 avankest 1036: <p>Special thanks also to the WHATWG for drafing a first version of this
1.22 avankest 1037: specification in their Web Applications 1.0 document.</p>
1.12 avankest 1038:
1.1 avankest 1039: <p>Thanks also to all those who have helped to improve this specification by
1.22 avankest 1040: sending suggestions and corrections. (Please, keep bugging us with your
1041: issues!)</p>
1.29 avankest 1042:
1.1 avankest 1043: </body>
1044: </html>
Webmaster