• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (C) 2008 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29module xml {
30
31    interface [
32        CustomConstructor,
33        CustomMarkFunction,
34        EventTarget,
35        NoStaticTables
36    ] XMLHttpRequest {
37        // From XMLHttpRequestEventTarget
38        // event handler attributes
39        attribute EventListener onabort;
40        attribute EventListener onerror;
41        attribute EventListener onload;
42        attribute EventListener onloadstart;
43        attribute EventListener onprogress;
44
45        // event handler attributes
46        attribute EventListener onreadystatechange;
47
48        // state
49        const unsigned short UNSENT = 0;
50        const unsigned short OPENED = 1;
51        const unsigned short HEADERS_RECEIVED = 2;
52        const unsigned short LOADING = 3;
53        const unsigned short DONE = 4;
54
55        readonly attribute unsigned short readyState;
56
57        // request
58        attribute boolean withCredentials
59            setter raises(DOMException);
60        // void open(in DOMString method, in DOMString url);
61        // void open(in DOMString method, in DOMString url, in boolean async);
62        // void open(in DOMString method, in DOMString url, in boolean async, in DOMString user);
63        [Custom] void open(in DOMString method, in DOMString url, in boolean async, in DOMString user, in DOMString password)
64            raises(DOMException);
65
66        [Custom] void setRequestHeader(in DOMString header, in DOMString value)
67            raises(DOMException);
68
69        // void send();
70        // void send(in DOMString data);
71        [Custom] void send(in Document data)
72            raises(DOMException);
73
74        void abort();
75
76        readonly attribute XMLHttpRequestUpload upload;
77
78        // response
79        [ConvertNullStringTo=Undefined] DOMString getAllResponseHeaders()
80            raises(DOMException);
81        [Custom, ConvertNullStringTo=Null] DOMString getResponseHeader(in DOMString header)
82            raises(DOMException);
83        readonly attribute [CustomGetter] DOMString responseText; // The custom getter implements ConvertNullStringTo=Null
84        readonly attribute Document responseXML;
85        readonly attribute unsigned short status
86            getter raises(DOMException);
87        readonly attribute DOMString statusText
88            getter raises(DOMException);
89
90        // Extension
91        [Custom] void overrideMimeType(in DOMString override);
92
93        // EventTarget interface
94        [Custom] void addEventListener(in DOMString type,
95                                      in EventListener listener,
96                                      in boolean useCapture);
97        [Custom] void removeEventListener(in DOMString type,
98                                          in EventListener listener,
99                                          in boolean useCapture);
100        boolean dispatchEvent(in Event evt)
101            raises(EventException);
102    };
103
104}
105