modules/plugin/base/public/nsICookieStorage.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39 #include "nspluginroot.idl"
  40
  41 /**
  42  * nsICookieStorage
  43  */
  44 %{C++
  45 // {c8c05101-cfdb-11d2-bab8-b088e084e5bc}
  46 #define NS_COOKIESTORAGE_CID \
  47 { 0xc8c05101, 0xcfdb, 0x11d2, { 0xba, 0xb8, 0xb0, 0x88, 0xe0, 0x84, 0xe5, 0xbc } }
  48 %}
  49
  50 [uuid(c8c05100-cfdb-11d2-bab8-b088e084e5bc)]
  51 interface nsICookieStorage : nsISupports
  52 {
  53     /**
  54      * Retrieves a cookie from the browser's persistent cookie store.
  55          * @param aCookieURL    - URL string to look up cookie with.
  56          * @param aCookieBuffer - buffer large enough to accomodate cookie data.
  57          * @param aCookieSize   - on input, size of the cookie buffer, on output cookie's size.
  58      */
  59   void getCookie(in string aCookieURL, in voidPtr aCookieBuffer, in PRUint32Ref aCookieSize);
  60
  61     /**
  62      * Stores a cookie in the browser's persistent cookie store.
  63    * @param aCookieURL    - URL string store cookie with.
  64    * @param aCookieBuffer - buffer containing cookie data.
  65    * @param aCookieSize   - specifies  size of cookie data.
  66      */
  67   void setCookie(in string aCookieURL, in constVoidPtr aCookieBuffer, in unsigned long aCookieSize);
  68 };