|
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
|
2 /* This Source Code Form is subject to the terms of the Mozilla Public |
|
3 * License, v. 2.0. If a copy of the MPL was not distributed with this |
|
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
|
5 |
|
6 #include "nsISupports.idl" |
|
7 |
|
8 interface nsISimpleEnumerator; |
|
9 |
|
10 /** |
|
11 * An optional interface for accessing or removing the cookies |
|
12 * that are in the cookie list |
|
13 */ |
|
14 |
|
15 [scriptable, uuid(AAAB6710-0F2C-11d5-A53B-0010A401EB10)] |
|
16 interface nsICookieManager : nsISupports |
|
17 { |
|
18 |
|
19 /** |
|
20 * Called to remove all cookies from the cookie list |
|
21 */ |
|
22 void removeAll(); |
|
23 |
|
24 /** |
|
25 * Called to enumerate through each cookie in the cookie list. |
|
26 * The objects enumerated over are of type nsICookie |
|
27 */ |
|
28 readonly attribute nsISimpleEnumerator enumerator; |
|
29 |
|
30 /** |
|
31 * Called to remove an individual cookie from the cookie list, specified |
|
32 * by host, name, and path. If the cookie cannot be found, no exception |
|
33 * is thrown. Typically, the arguments to this method will be obtained |
|
34 * directly from the desired nsICookie object. |
|
35 * |
|
36 * @param aHost The host or domain for which the cookie was set. @see |
|
37 * nsICookieManager2::add for a description of acceptable host |
|
38 * strings. If the target cookie is a domain cookie, a leading |
|
39 * dot must be present. |
|
40 * @param aName The name specified in the cookie |
|
41 * @param aPath The path for which the cookie was set |
|
42 * @param aBlocked Indicates if cookies from this host should be permanently blocked |
|
43 * |
|
44 */ |
|
45 void remove(in AUTF8String aHost, |
|
46 in ACString aName, |
|
47 in AUTF8String aPath, |
|
48 in boolean aBlocked); |
|
49 }; |