dom/xhr/XMLHttpRequest.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_XMLHttpRequest_h
   8 #define mozilla_dom_XMLHttpRequest_h
   9
  10 #include "mozilla/Attributes.h"
  11 #include "mozilla/ErrorResult.h"
  12 #include "mozilla/dom/XMLHttpRequestEventTarget.h"
  13 #include "mozilla/dom/XMLHttpRequestBinding.h"
  14
  15 class nsIInputStream;
  16
  17 namespace mozilla {
  18 namespace dom {
  19
  20 class Blob;
  21 class DOMString;
  22 class FormData;
  23 class URLSearchParams;
  24 class XMLHttpRequestUpload;
  25
  26 class XMLHttpRequest : public XMLHttpRequestEventTarget {
  27  public:
  28   static already_AddRefed<XMLHttpRequest> Constructor(
  29       const GlobalObject& aGlobal, const MozXMLHttpRequestParameters& aParams,
  30       ErrorResult& aRv);
  31
  32   static already_AddRefed<XMLHttpRequest> Constructor(
  33       const GlobalObject& aGlobal, const nsAString& ignored, ErrorResult& aRv) {
  34     // Pretend like someone passed null, so we can pick up the default values
  35     MozXMLHttpRequestParameters params;
  36     if (!params.Init(aGlobal.Context(), JS::NullHandleValue)) {
  37       aRv.Throw(NS_ERROR_UNEXPECTED);
  38       return nullptr;
  39     }
  40
  41     return Constructor(aGlobal, params, aRv);
  42   }
  43
  44   IMPL_EVENT_HANDLER(readystatechange)
  45
  46   virtual uint16_t ReadyState() const = 0;
  47
  48   virtual void Open(const nsACString& aMethod, const nsAString& aUrl,
  49                     ErrorResult& aRv) = 0;
  50
  51   virtual void Open(const nsACString& aMethod, const nsAString& aUrl,
  52                     bool aAsync, const nsAString& aUser,
  53                     const nsAString& aPassword, ErrorResult& aRv) = 0;
  54
  55   virtual void SetRequestHeader(const nsACString& aHeader,
  56                                 const nsACString& aValue, ErrorResult& aRv) = 0;
  57
  58   virtual uint32_t Timeout() const = 0;
  59
  60   virtual void SetTimeout(uint32_t aTimeout, ErrorResult& aRv) = 0;
  61
  62   virtual bool WithCredentials() const = 0;
  63
  64   virtual void SetWithCredentials(bool aWithCredentials, ErrorResult& aRv) = 0;
  65
  66   virtual XMLHttpRequestUpload* GetUpload(ErrorResult& aRv) = 0;
  67
  68   virtual void Send(
  69       const Nullable<
  70           DocumentOrBlobOrArrayBufferViewOrArrayBufferOrFormDataOrURLSearchParamsOrUSVString>&
  71           aData,
  72       ErrorResult& aRv) = 0;
  73
  74   virtual void SendInputStream(nsIInputStream* aInputStream,
  75                                ErrorResult& aRv) = 0;
  76
  77   virtual void Abort(ErrorResult& aRv) = 0;
  78
  79   virtual void GetResponseURL(nsAString& aUrl) = 0;
  80
  81   virtual uint32_t GetStatus(ErrorResult& aRv) = 0;
  82
  83   virtual void GetStatusText(nsACString& aStatusText, ErrorResult& aRv) = 0;
  84
  85   virtual void GetResponseHeader(const nsACString& aHeader, nsACString& aResult,
  86                                  ErrorResult& aRv) = 0;
  87
  88   virtual void GetAllResponseHeaders(nsACString& aResponseHeaders,
  89                                      ErrorResult& aRv) = 0;
  90
  91   virtual void OverrideMimeType(const nsAString& aMimeType,
  92                                 ErrorResult& aRv) = 0;
  93
  94   virtual XMLHttpRequestResponseType ResponseType() const = 0;
  95
  96   virtual void SetResponseType(XMLHttpRequestResponseType aType,
  97                                ErrorResult& aRv) = 0;
  98
  99   virtual void GetResponse(JSContext* aCx,
 100                            JS::MutableHandle<JS::Value> aResponse,
 101                            ErrorResult& aRv) = 0;
 102
 103   virtual void GetResponseText(DOMString& aResponseText, ErrorResult& aRv) = 0;
 104
 105   virtual Document* GetResponseXML(ErrorResult& aRv) = 0;
 106
 107   virtual bool MozBackgroundRequest() const = 0;
 108
 109   virtual void SetMozBackgroundRequest(bool aMozBackgroundRequest,
 110                                        ErrorResult& aRv) = 0;
 111
 112   virtual nsIChannel* GetChannel() const = 0;
 113
 114   // We need a GetInterface callable from JS for chrome JS
 115   virtual void GetInterface(JSContext* aCx, JS::Handle<JS::Value> aIID,
 116                             JS::MutableHandle<JS::Value> aRetval,
 117                             ErrorResult& aRv) = 0;
 118
 119   virtual void SetOriginAttributes(
 120       const mozilla::dom::OriginAttributesDictionary& aAttrs) = 0;
 121
 122   virtual uint16_t ErrorCode() const = 0;
 123
 124   virtual bool MozAnon() const = 0;
 125
 126   virtual bool MozSystem() const = 0;
 127
 128   virtual JSObject* WrapObject(JSContext* aCx,
 129                                JS::Handle<JSObject*> aGivenProto) override {
 130     return mozilla::dom::XMLHttpRequest_Binding::Wrap(aCx, this, aGivenProto);
 131   }
 132
 133  protected:
 134   explicit XMLHttpRequest(nsIGlobalObject* aGlobalObject)
 135       : XMLHttpRequestEventTarget(aGlobalObject) {}
 136 };
 137
 138 }  // namespace dom
 139 }  // namespace mozilla
 140
 141 #endif  // mozilla_dom_XMLHttpRequest_h