netwerk/cookie/public/nsICookie2.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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  * Daniel Witte.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Daniel Witte (dwitte@stanford.edu)
  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
  39 #include "nsICookie.idl"
  40
  41 /**
  42  * Main cookie object interface for use by consumers:
  43  * extends nsICookie, a frozen interface for external
  44  * access of cookie objects
  45  */
  46
  47 [scriptable, uuid(8587f4e0-870c-11dd-ad8b-0800200c9a66)]
  48
  49 interface nsICookie2 : nsICookie
  50 {
  51
  52     /**
  53      * the host (possibly fully qualified) of the cookie,
  54      * without a leading dot to represent if it is a
  55      * domain cookie.
  56      */
  57     readonly attribute AUTF8String rawHost;
  58
  59     /**
  60      * true if the cookie is a session cookie.
  61      * note that expiry time will also be honored
  62      * for session cookies (see below); thus, whichever is
  63      * the more restrictive of the two will take effect.
  64      */
  65     readonly attribute boolean isSession;
  66
  67     /**
  68      * the actual expiry time of the cookie, in seconds
  69      * since midnight (00:00:00), January 1, 1970 UTC.
  70      *
  71      * this is distinct from nsICookie::expires, which
  72      * has different and obsolete semantics.
  73      */
  74     readonly attribute PRInt64 expiry;
  75
  76     /**
  77      * true if the cookie is an http only cookie
  78      */
  79     readonly attribute boolean isHttpOnly;
  80
  81     /**
  82      * the creation time of the cookie, in microseconds
  83      * since midnight (00:00:00), January 1, 1970 UTC.
  84      */
  85     readonly attribute PRInt64 creationTime;
  86
  87
  88 };