fa89466f2bce949bda6deda6414ce394bffb8a0a
[WebKit-https.git] / Source / WebCore / xml / XMLHttpRequest.idl
1 /*
2  * Copyright (C) 2008, 2011 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 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
29 enum XMLHttpRequestResponseType {
30     "",
31     "arraybuffer",
32     "blob",
33     "document",
34     "json",
35     "text"
36 };
37
38 [
39     Exposed=(Window,Worker),
40     ActiveDOMObject,
41     Constructor,
42     ConstructorCallWith=ScriptExecutionContext,
43     JSCustomMarkFunction,
44     JSGenerateToNativeObject,
45     JSGenerateToJSObject,
46     ExportMacro=WEBCORE_EXPORT,
47 ] interface XMLHttpRequest : XMLHttpRequestEventTarget {
48     attribute EventHandler onreadystatechange;
49
50     // state
51     const unsigned short UNSENT = 0;
52     const unsigned short OPENED = 1;
53     const unsigned short HEADERS_RECEIVED = 2;
54     const unsigned short LOADING = 3;
55     const unsigned short DONE = 4;
56
57     [SetterRaisesException] attribute unsigned long timeout;
58     readonly attribute unsigned short readyState;
59
60     [SetterRaisesException] attribute boolean withCredentials;
61
62     [Custom, RaisesException] void open(DOMString method, DOMString url, optional boolean async, optional DOMString user, optional DOMString password);
63
64     [RaisesException] void setRequestHeader(DOMString header, DOMString value);
65
66     [Custom, RaisesException] void send();
67
68     void abort();
69
70     readonly attribute XMLHttpRequestUpload upload;
71
72     // response
73     DOMString getAllResponseHeaders();
74     DOMString? getResponseHeader(DOMString header);
75     [GetterRaisesException, CustomGetter] readonly attribute DOMString? responseText;
76     [GetterRaisesException] readonly attribute Document responseXML;
77
78     [SetterRaisesException] attribute XMLHttpRequestResponseType responseType;
79     [GetterRaisesException, CachedAttribute, CustomGetter] readonly attribute Object response;
80
81     readonly attribute unsigned short status;
82     readonly attribute DOMString statusText;
83     readonly attribute DOMString responseURL;
84
85     // Extension
86     [RaisesException] void overrideMimeType(DOMString override);
87 };