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 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 29 enum XMLHttpRequestResponseType { 30 "", 31 "arraybuffer", 32 "blob", 33 "document", 34 "json", 35 "text", 36 "stream" 37 }; 38 39 [ 40 WillBeGarbageCollected, 41 ActiveDOMObject, 42 CustomConstructor(optional XMLHttpRequestOptions options), 43 Exposed=Window&Worker 44 ] interface XMLHttpRequest : XMLHttpRequestEventTarget { 45 // event handler attributes 46 attribute EventHandler 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 [RaisesException=Setter] attribute unsigned long timeout; 56 readonly attribute unsigned short readyState; 57 58 [RaisesException=Setter] attribute boolean withCredentials; 59 60 [Custom, LogActivity, LogAllWorlds, RaisesException] void open(DOMString method, DOMString url, optional boolean async, optional DOMString user, optional DOMString password); 61 62 [LogActivity, LogAllWorlds, RaisesException] void setRequestHeader(DOMString header, DOMString value); 63 64 [Custom, RaisesException] void send(); 65 66 void abort(); 67 68 readonly attribute XMLHttpRequestUpload upload; 69 70 // response 71 [TreatReturnedNullStringAs=Undefined] DOMString getAllResponseHeaders(); 72 [TreatReturnedNullStringAs=Null] DOMString getResponseHeader(DOMString header); 73 [Custom=Getter, RaisesException=Getter] readonly attribute DOMString responseText; // The custom getter implements TreatReturnedNullStringAs=Null 74 [RaisesException=Getter] readonly attribute Document responseXML; 75 76 [RaisesException=Setter] attribute XMLHttpRequestResponseType responseType; 77 [Custom=Getter, RaisesException=Getter] readonly attribute object response; 78 readonly attribute DOMString responseURL; 79 80 readonly attribute unsigned short status; 81 readonly attribute DOMString statusText; 82 83 // Extension 84 void overrideMimeType(DOMString override); 85 }; 86
