PageRenderTime 38ms CodeModel.GetById 13ms RepoModel.GetById 0ms app.codeStats 0ms

/gecko_sdk/idl/nsICookie.idl

http://firefox-mac-pdf.googlecode.com/
IDL | 115 lines | 26 code | 15 blank | 74 comment | 0 complexity | 48062e27fa428c104f04b3969960fb80 MD5 | raw file
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  2. *
  3. * ***** BEGIN LICENSE BLOCK *****
  4. * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5. *
  6. * The contents of this file are subject to the Mozilla Public License Version
  7. * 1.1 (the "License"); you may not use this file except in compliance with
  8. * the License. You may obtain a copy of the License at
  9. * http://www.mozilla.org/MPL/
  10. *
  11. * Software distributed under the License is distributed on an "AS IS" basis,
  12. * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13. * for the specific language governing rights and limitations under the
  14. * License.
  15. *
  16. * The Original Code is mozilla.org code.
  17. *
  18. * The Initial Developer of the Original Code is
  19. * Netscape Communications, Inc.
  20. * Portions created by the Initial Developer are Copyright (C) 2001
  21. * the Initial Developer. All Rights Reserved.
  22. *
  23. * Contributor(s):
  24. *
  25. * Alternatively, the contents of this file may be used under the terms of
  26. * either the GNU General Public License Version 2 or later (the "GPL"), or
  27. * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28. * in which case the provisions of the GPL or the LGPL are applicable instead
  29. * of those above. If you wish to allow use of your version of this file only
  30. * under the terms of either the GPL or the LGPL, and not to allow others to
  31. * use your version of this file under the terms of the MPL, indicate your
  32. * decision by deleting the provisions above and replace them with the notice
  33. * and other provisions required by the GPL or the LGPL. If you do not delete
  34. * the provisions above, a recipient may use your version of this file under
  35. * the terms of any one of the MPL, the GPL or the LGPL.
  36. *
  37. * ***** END LICENSE BLOCK ***** */
  38. #include "nsISupports.idl"
  39. /**
  40. * An optional interface for accessing the HTTP or
  41. * javascript cookie object
  42. *
  43. * @status FROZEN
  44. */
  45. typedef long nsCookieStatus;
  46. typedef long nsCookiePolicy;
  47. [scriptable, uuid(E9FCB9A4-D376-458f-B720-E65E7DF593BC)]
  48. interface nsICookie : nsISupports {
  49. /**
  50. * the name of the cookie
  51. */
  52. readonly attribute ACString name;
  53. /**
  54. * the cookie value
  55. */
  56. readonly attribute ACString value;
  57. /**
  58. * true if the cookie is a domain cookie, false otherwise
  59. */
  60. readonly attribute boolean isDomain;
  61. /**
  62. * the host (possibly fully qualified) of the cookie
  63. */
  64. readonly attribute AUTF8String host;
  65. /**
  66. * the path pertaining to the cookie
  67. */
  68. readonly attribute AUTF8String path;
  69. /**
  70. * true if the cookie was transmitted over ssl, false otherwise
  71. */
  72. readonly attribute boolean isSecure;
  73. /**
  74. * @DEPRECATED use nsICookie2.expiry and nsICookie2.isSession instead.
  75. *
  76. * expiration time in seconds since midnight (00:00:00), January 1, 1970 UTC.
  77. * expires = 0 represents a session cookie.
  78. * expires = 1 represents an expiration time earlier than Jan 1, 1970.
  79. */
  80. readonly attribute PRUint64 expires;
  81. /**
  82. * @DEPRECATED status implementation will return STATUS_UNKNOWN in all cases.
  83. */
  84. const nsCookieStatus STATUS_UNKNOWN=0;
  85. const nsCookieStatus STATUS_ACCEPTED=1;
  86. const nsCookieStatus STATUS_DOWNGRADED=2;
  87. const nsCookieStatus STATUS_FLAGGED=3;
  88. const nsCookieStatus STATUS_REJECTED=4;
  89. readonly attribute nsCookieStatus status;
  90. /**
  91. * @DEPRECATED policy implementation will return POLICY_UNKNOWN in all cases.
  92. */
  93. const nsCookiePolicy POLICY_UNKNOWN=0;
  94. const nsCookiePolicy POLICY_NONE=1;
  95. const nsCookiePolicy POLICY_NO_CONSENT=2;
  96. const nsCookiePolicy POLICY_IMPLICIT_CONSENT=3;
  97. const nsCookiePolicy POLICY_EXPLICIT_CONSENT=4;
  98. const nsCookiePolicy POLICY_NO_II=5;
  99. readonly attribute nsCookiePolicy policy;
  100. };