netwerk/cookie/nsICookie.idl@fc2d59ddac77 (annotated)
netwerk/cookie/nsICookie.idl
Wed, 31 Dec 2014 07:22:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:22:50 +0100
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
- permissions
- -rw-r--r--
Correct previous dual key logic pending first delivery installment.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- |
| michael@0 | 2 | * |
| michael@0 | 3 | * This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 4 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 5 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 6 | |
| michael@0 | 7 | #include "nsISupports.idl" |
| michael@0 | 8 | |
| michael@0 | 9 | /** |
| michael@0 | 10 | * An optional interface for accessing the HTTP or |
| michael@0 | 11 | * javascript cookie object |
| michael@0 | 12 | */ |
| michael@0 | 13 | |
| michael@0 | 14 | typedef long nsCookieStatus; |
| michael@0 | 15 | typedef long nsCookiePolicy; |
| michael@0 | 16 | |
| michael@0 | 17 | [scriptable, uuid(8684966b-1877-4f0f-8155-be4490b96bf7)] |
| michael@0 | 18 | |
| michael@0 | 19 | interface nsICookie : nsISupports { |
| michael@0 | 20 | |
| michael@0 | 21 | /** |
| michael@0 | 22 | * the name of the cookie |
| michael@0 | 23 | */ |
| michael@0 | 24 | readonly attribute ACString name; |
| michael@0 | 25 | |
| michael@0 | 26 | /** |
| michael@0 | 27 | * the cookie value |
| michael@0 | 28 | */ |
| michael@0 | 29 | readonly attribute AUTF8String value; |
| michael@0 | 30 | |
| michael@0 | 31 | /** |
| michael@0 | 32 | * true if the cookie is a domain cookie, false otherwise |
| michael@0 | 33 | */ |
| michael@0 | 34 | readonly attribute boolean isDomain; |
| michael@0 | 35 | |
| michael@0 | 36 | /** |
| michael@0 | 37 | * the host (possibly fully qualified) of the cookie |
| michael@0 | 38 | */ |
| michael@0 | 39 | readonly attribute AUTF8String host; |
| michael@0 | 40 | |
| michael@0 | 41 | /** |
| michael@0 | 42 | * the path pertaining to the cookie |
| michael@0 | 43 | */ |
| michael@0 | 44 | readonly attribute AUTF8String path; |
| michael@0 | 45 | |
| michael@0 | 46 | /** |
| michael@0 | 47 | * true if the cookie was transmitted over ssl, false otherwise |
| michael@0 | 48 | */ |
| michael@0 | 49 | readonly attribute boolean isSecure; |
| michael@0 | 50 | |
| michael@0 | 51 | /** |
| michael@0 | 52 | * @DEPRECATED use nsICookie2.expiry and nsICookie2.isSession instead. |
| michael@0 | 53 | * |
| michael@0 | 54 | * expiration time in seconds since midnight (00:00:00), January 1, 1970 UTC. |
| michael@0 | 55 | * expires = 0 represents a session cookie. |
| michael@0 | 56 | * expires = 1 represents an expiration time earlier than Jan 1, 1970. |
| michael@0 | 57 | */ |
| michael@0 | 58 | readonly attribute uint64_t expires; |
| michael@0 | 59 | |
| michael@0 | 60 | /** |
| michael@0 | 61 | * @DEPRECATED status implementation will return STATUS_UNKNOWN in all cases. |
| michael@0 | 62 | */ |
| michael@0 | 63 | const nsCookieStatus STATUS_UNKNOWN=0; |
| michael@0 | 64 | const nsCookieStatus STATUS_ACCEPTED=1; |
| michael@0 | 65 | const nsCookieStatus STATUS_DOWNGRADED=2; |
| michael@0 | 66 | const nsCookieStatus STATUS_FLAGGED=3; |
| michael@0 | 67 | const nsCookieStatus STATUS_REJECTED=4; |
| michael@0 | 68 | readonly attribute nsCookieStatus status; |
| michael@0 | 69 | |
| michael@0 | 70 | /** |
| michael@0 | 71 | * @DEPRECATED policy implementation will return POLICY_UNKNOWN in all cases. |
| michael@0 | 72 | */ |
| michael@0 | 73 | const nsCookiePolicy POLICY_UNKNOWN=0; |
| michael@0 | 74 | const nsCookiePolicy POLICY_NONE=1; |
| michael@0 | 75 | const nsCookiePolicy POLICY_NO_CONSENT=2; |
| michael@0 | 76 | const nsCookiePolicy POLICY_IMPLICIT_CONSENT=3; |
| michael@0 | 77 | const nsCookiePolicy POLICY_EXPLICIT_CONSENT=4; |
| michael@0 | 78 | const nsCookiePolicy POLICY_NO_II=5; |
| michael@0 | 79 | readonly attribute nsCookiePolicy policy; |
| michael@0 | 80 | |
| michael@0 | 81 | }; |
