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