gears/httprequest/ie/httprequest.idl

   1 // Copyright 2007, Google Inc.
   2 //
   3 // Redistribution and use in source and binary forms, with or without
   4 // modification, are permitted provided that the following conditions are met:
   5 //
   6 //  1. Redistributions of source code must retain the above copyright notice,
   7 //     this list of conditions and the following disclaimer.
   8 //  2. Redistributions in binary form must reproduce the above copyright notice,
   9 //     this list of conditions and the following disclaimer in the documentation
  10 //     and/or other materials provided with the distribution.
  11 //  3. Neither the name of Google Inc. nor the names of its contributors may be
  12 //     used to endorse or promote products derived from this software without
  13 //     specific prior written permission.
  14 //
  15 // THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  16 // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  17 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
  18 // EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  21 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  22 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  23 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  24 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25
  26 import "oaidl.idl";
  27 import "ocidl.idl";
  28
  29 //------------------------------------------------------------------------------
  30 // GearsHttpRequest
  31 //------------------------------------------------------------------------------
  32 [
  33   object,
  34   uuid(28652DBF-5165-46bf-9E5E-78ACEA260237),
  35   dual,
  36   nonextensible,
  37   pointer_default(unique)
  38 ]
  39 interface GearsHttpRequestInterface : IDispatch {
  40   // event handler
  41   [propput] HRESULT onreadystatechange([in] VARIANT *handler);
  42   [propget] HRESULT onreadystatechange([out, retval] VARIANT *handler);
  43
  44   // state
  45   [propget] HRESULT readyState([out, retval] int *state);
  46
  47   // request
  48   HRESULT open([in] const BSTR method,
  49                [in] const BSTR url,
  50                [in, optional] const VARIANT *async);
  51   HRESULT setRequestHeader([in] const BSTR header,
  52                            [in] const BSTR value);
  53   HRESULT send([in, optional] const VARIANT *data);
  54   HRESULT abort();
  55
  56   // response
  57   HRESULT getAllResponseHeaders([out, retval] BSTR *headers);
  58   HRESULT getResponseHeader([in] const BSTR headerName,
  59                             [out, retval] BSTR *headerValues);
  60   [propget] HRESULT responseText([out, retval] BSTR *body);
  61
  62 #ifdef OFFICIAL_BUILD
  63   // Blob support is not ready for prime time yet
  64 #else
  65   [propget] HRESULT responseBlob([out, retval] IUnknown **body);
  66 #endif
  67
  68   [propget] HRESULT status([out, retval] int *statusCode);
  69   [propget] HRESULT statusText([out, retval] BSTR *statusText);
  70 };