dom/webidl/XMLHttpRequest.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * www.w3.org/TR/2012/WD-XMLHttpRequest-20120117/
   8  *
   9  * Copyright © 2012 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
  10  * liability, trademark and document use rules apply.
  11  */
  12
  13 interface Blob;
  14 interface InputStream;
  15 interface MozChannel;
  16 interface IID;
  17
  18 enum XMLHttpRequestResponseType {
  19   "",
  20   "arraybuffer",
  21   "blob",
  22   "document",
  23   "json",
  24   "text",
  25
  26   // Mozilla-specific stuff
  27   "moz-chunked-text",
  28   "moz-chunked-arraybuffer",
  29   "moz-blob"
  30 };
  31
  32 /**
  33  * Parameters for instantiating an XMLHttpRequest. They are passed as an
  34  * optional argument to the constructor:
  35  *
  36  *  new XMLHttpRequest({anon: true, system: true});
  37  */
  38 dictionary MozXMLHttpRequestParameters
  39 {
  40   /**
  41    * If true, the request will be sent without cookie and authentication
  42    * headers.
  43    */
  44   boolean mozAnon = false;
  45
  46   /**
  47    * If true, the same origin policy will not be enforced on the request.
  48    */
  49   boolean mozSystem = false;
  50 };
  51
  52 [Constructor(optional MozXMLHttpRequestParameters params),
  53  // There are apparently callers, specifically CoffeeScript, who do
  54  // things like this:
  55  //   c = new(window.ActiveXObject || XMLHttpRequest)("Microsoft.XMLHTTP")
  56  // To handle that, we need a constructor that takes a string.
  57  Constructor(DOMString ignored),
  58  Exposed=(Window,Worker)]
  59 interface XMLHttpRequest : XMLHttpRequestEventTarget {
  60   // event handler
  61   attribute EventHandler onreadystatechange;
  62
  63   // states
  64   const unsigned short UNSENT = 0;
  65   const unsigned short OPENED = 1;
  66   const unsigned short HEADERS_RECEIVED = 2;
  67   const unsigned short LOADING = 3;
  68   const unsigned short DONE = 4;
  69
  70   readonly attribute unsigned short readyState;
  71
  72   // request
  73   [Throws]
  74   void open(ByteString method, DOMString url);
  75   [Throws]
  76   void open(ByteString method, DOMString url, boolean async,
  77             optional DOMString? user, optional DOMString? password);
  78   [Throws]
  79   void setRequestHeader(ByteString header, ByteString value);
  80
  81   [SetterThrows]
  82   attribute unsigned long timeout;
  83
  84   [SetterThrows]
  85   attribute boolean withCredentials;
  86
  87   [Throws=Workers]
  88   readonly attribute XMLHttpRequestUpload upload;
  89
  90   [Throws]
  91   void send();
  92   [Throws]
  93   void send(ArrayBuffer data);
  94   [Throws]
  95   void send(ArrayBufferView data);
  96   [Throws]
  97   void send(Blob data);
  98   [Throws]
  99   void send(Document data);
 100   [Throws]
 101   void send(DOMString? data);
 102   [Throws]
 103   void send(FormData data);
 104   [Throws]
 105   void send(InputStream data);
 106
 107   [Throws=Workers]
 108   void abort();
 109
 110   // response
 111   readonly attribute DOMString responseURL;
 112
 113   [Throws=Workers]
 114   readonly attribute unsigned short status;
 115
 116   readonly attribute ByteString statusText;
 117   [Throws]
 118   ByteString? getResponseHeader(ByteString header);
 119
 120   [Throws=Workers]
 121   ByteString getAllResponseHeaders();
 122
 123   [Throws=Workers]
 124   void overrideMimeType(DOMString mime);
 125
 126   [SetterThrows]
 127   attribute XMLHttpRequestResponseType responseType;
 128   [Throws]
 129   readonly attribute any response;
 130   [Throws]
 131   readonly attribute DOMString? responseText;
 132
 133   [Throws, Exposed=Window]
 134   readonly attribute Document? responseXML;
 135
 136   // Mozilla-specific stuff
 137
 138   [ChromeOnly, SetterThrows=Workers]
 139   attribute boolean mozBackgroundRequest;
 140
 141   [ChromeOnly, Exposed=Window]
 142   readonly attribute MozChannel? channel;
 143
 144   [Throws]
 145   void sendAsBinary(DOMString body);
 146   [Throws, ChromeOnly]
 147   any getInterface(IID iid);
 148
 149   readonly attribute boolean mozAnon;
 150   readonly attribute boolean mozSystem;
 151 };