nsICookieManager.idl 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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. #include "nsISupports.idl"
  38. #include "nsISimpleEnumerator.idl"
  39. /**
  40. * An optional interface for accessing or removing the cookies
  41. * that are in the cookie list
  42. *
  43. * @status FROZEN
  44. */
  45. [scriptable, uuid(AAAB6710-0F2C-11d5-A53B-0010A401EB10)]
  46. interface nsICookieManager : nsISupports
  47. {
  48. /**
  49. * Called to remove all cookies from the cookie list
  50. */
  51. void removeAll();
  52. /**
  53. * Called to enumerate through each cookie in the cookie list.
  54. * The objects enumerated over are of type nsICookie
  55. */
  56. readonly attribute nsISimpleEnumerator enumerator;
  57. /**
  58. * Called to remove an individual cookie from the cookie list
  59. *
  60. * @param aDomain The host or domain for which the cookie was set
  61. * @param aName The name specified in the cookie
  62. * @param aBlocked Indicates if cookies from this host should be permanently blocked
  63. *
  64. */
  65. void remove(in AUTF8String aDomain, in ACString aName, in AUTF8String aPath, in boolean aBlocked);
  66. };