blob: 6147be44b0ef16bc7752aae26e34265cd1f54101 [file] [log] [blame]
/*
* Copyright (C) 2008, 2011 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
enum XMLHttpRequestResponseType {
"",
"arraybuffer",
"blob",
"document",
"json",
"text",
"legacystream"
};
[
WillBeGarbageCollected,
ActiveDOMObject,
CustomConstructor(optional XMLHttpRequestOptions options),
Exposed=(Window,DedicatedWorker,SharedWorker)
] interface XMLHttpRequest : XMLHttpRequestEventTarget {
// event handler attributes
attribute EventHandler onreadystatechange;
// state
const unsigned short UNSENT = 0;
const unsigned short OPENED = 1;
const unsigned short HEADERS_RECEIVED = 2;
const unsigned short LOADING = 3;
const unsigned short DONE = 4;
[RaisesException=Setter] attribute unsigned long timeout;
readonly attribute unsigned short readyState;
[RaisesException=Setter] attribute boolean withCredentials;
[Custom, RaisesException] void open(DOMString method, DOMString url, optional boolean async, optional DOMString user, optional DOMString password);
[RaisesException] void setRequestHeader(DOMString header, DOMString value);
[Custom, RaisesException] void send();
// FIXMEDART: send(ArrayBuffer data) should be eventually deprecated.
[DartCustom=New] void send(ArrayBuffer data);
[DartCustom=New] void send(ArrayBufferView data);
[DartCustom=New] void send(Blob data);
[DartCustom=New] void send(Document data);
[DartCustom=New] void send(DOMString data);
[DartCustom=New] void send(FormData data);
void abort();
readonly attribute XMLHttpRequestUpload upload;
// response
[TreatReturnedNullStringAs=Undefined] DOMString getAllResponseHeaders();
DOMString? getResponseHeader(DOMString header);
[Custom=Getter, RaisesException=Getter] readonly attribute DOMString? responseText;
[RaisesException=Getter] readonly attribute Document responseXML;
[RaisesException=Setter] attribute XMLHttpRequestResponseType responseType;
[Custom=Getter, RaisesException=Getter] readonly attribute object response;
readonly attribute DOMString responseURL;
readonly attribute unsigned short status;
readonly attribute DOMString statusText;
// Extension
void overrideMimeType(DOMString override);
};