Home | History | Annotate | Download | only in xml 
      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     "legacystream",
     37     "stream"
     38 };
     39 
     40 [
     41     WillBeGarbageCollected,
     42     ActiveDOMObject,
     43     CustomConstructor(optional XMLHttpRequestOptions options),
     44     Exposed=(Window,DedicatedWorker,SharedWorker)
     45 ] interface XMLHttpRequest : XMLHttpRequestEventTarget {
     46     // event handler attributes
     47     attribute EventHandler onreadystatechange;
     48 
     49     // state
     50     const unsigned short UNSENT = 0;
     51     const unsigned short OPENED = 1;
     52     const unsigned short HEADERS_RECEIVED = 2;
     53     const unsigned short LOADING = 3;
     54     const unsigned short DONE = 4;
     55 
     56     [RaisesException=Setter] attribute unsigned long timeout;
     57     readonly attribute unsigned short readyState;
     58 
     59     [RaisesException=Setter] attribute boolean withCredentials;
     60 
     61     [Custom, RaisesException] void open(DOMString method, DOMString url, optional boolean async, optional DOMString user, optional DOMString password);
     62 
     63     [RaisesException] void setRequestHeader(DOMString header, DOMString value);
     64 
     65     [Custom, RaisesException] void send();
     66 
     67     void abort();
     68 
     69     readonly attribute XMLHttpRequestUpload upload;
     70 
     71     // response
     72     [TreatReturnedNullStringAs=Undefined] DOMString getAllResponseHeaders();
     73     DOMString? getResponseHeader(DOMString header);
     74     [Custom=Getter, RaisesException=Getter] readonly attribute DOMString? responseText;
     75     [RaisesException=Getter] readonly attribute Document responseXML;
     76 
     77     [RaisesException=Setter] attribute XMLHttpRequestResponseType responseType;
     78     [Custom=Getter, RaisesException=Getter] readonly attribute object response;
     79     readonly attribute DOMString responseURL;
     80 
     81     readonly attribute unsigned short status;
     82     readonly attribute DOMString statusText;
     83 
     84     // Extension
     85     [RaisesException] void overrideMimeType(DOMString override);
     86 };
     87