code.vuplus.com Git - vuplus_webkit/blob - 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 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 module xml {
  30
  31     interface [
  32         ActiveDOMObject,
  33         CanBeConstructed,
  34         CustomConstructFunction,
  35         V8CustomConstructor,
  36         CustomMarkFunction,
  37         EventTarget,
  38         NoStaticTables
  39     ] XMLHttpRequest {
  40         // From XMLHttpRequestEventTarget
  41         // event handler attributes
  42         attribute EventListener onabort;
  43         attribute EventListener onerror;
  44         attribute EventListener onload;
  45         attribute EventListener onloadstart;
  46         attribute EventListener onprogress;
  47
  48         // event handler attributes
  49         attribute EventListener onreadystatechange;
  50
  51         // state
  52         const unsigned short UNSENT = 0;
  53         const unsigned short OPENED = 1;
  54         const unsigned short HEADERS_RECEIVED = 2;
  55         const unsigned short LOADING = 3;
  56         const unsigned short DONE = 4;
  57
  58         readonly attribute unsigned short readyState;
  59
  60         // request
  61         attribute [Conditional=XHR_RESPONSE_BLOB, EnabledAtRuntime] boolean asBlob
  62             setter raises(DOMException);
  63
  64         attribute boolean withCredentials
  65             setter raises(DOMException);
  66         // void open(in DOMString method, in DOMString url);
  67         // void open(in DOMString method, in DOMString url, in boolean async);
  68         // void open(in DOMString method, in DOMString url, in boolean async, in DOMString user);
  69         [Custom] void open(in DOMString method, in DOMString url, in boolean async, in DOMString user, in DOMString password)
  70             raises(DOMException);
  71
  72         void setRequestHeader(in DOMString header, in DOMString value)
  73             raises(DOMException);
  74
  75         // void send();
  76         // void send(in DOMString data);
  77         [Custom] void send(in Document data)
  78             raises(DOMException);
  79
  80         void abort();
  81
  82         readonly attribute XMLHttpRequestUpload upload;
  83
  84         // response
  85         [ConvertNullStringTo=Undefined] DOMString getAllResponseHeaders()
  86             raises(DOMException);
  87         [ConvertNullStringTo=Null] DOMString getResponseHeader(in DOMString header)
  88             raises(DOMException);
  89         readonly attribute [CustomGetter] DOMString responseText // The custom getter implements ConvertNullStringTo=Null
  90             getter raises(DOMException);
  91         readonly attribute Document responseXML
  92             getter raises(DOMException);
  93         readonly attribute [Conditional=XHR_RESPONSE_BLOB, EnabledAtRuntime] Blob responseBlob
  94             getter raises(DOMException);
  95
  96         attribute DOMString responseType
  97             setter raises(DOMException);
  98         readonly attribute [CustomGetter] Object response
  99             getter raises(DOMException);
 100
 101         readonly attribute unsigned short status
 102             getter raises(DOMException);
 103         readonly attribute DOMString statusText
 104             getter raises(DOMException);
 105
 106         // Extension
 107         void overrideMimeType(in DOMString override);
 108
 109         // EventTarget interface
 110         void addEventListener(in DOMString type,
 111                               in EventListener listener,
 112                               in [Optional] boolean useCapture);
 113         void removeEventListener(in DOMString type,
 114                                  in EventListener listener,
 115                                  in [Optional] boolean useCapture);
 116         boolean dispatchEvent(in Event evt)
 117             raises(EventException);
 118     };
 119
 120 }