1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/netwerk/cookie/nsICookieManager.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,49 @@
1.4 +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
1.5 +/* This Source Code Form is subject to the terms of the Mozilla Public
1.6 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.7 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.8 +
1.9 +#include "nsISupports.idl"
1.10 +
1.11 +interface nsISimpleEnumerator;
1.12 +
1.13 +/**
1.14 + * An optional interface for accessing or removing the cookies
1.15 + * that are in the cookie list
1.16 + */
1.17 +
1.18 +[scriptable, uuid(AAAB6710-0F2C-11d5-A53B-0010A401EB10)]
1.19 +interface nsICookieManager : nsISupports
1.20 +{
1.21 +
1.22 + /**
1.23 + * Called to remove all cookies from the cookie list
1.24 + */
1.25 + void removeAll();
1.26 +
1.27 + /**
1.28 + * Called to enumerate through each cookie in the cookie list.
1.29 + * The objects enumerated over are of type nsICookie
1.30 + */
1.31 + readonly attribute nsISimpleEnumerator enumerator;
1.32 +
1.33 + /**
1.34 + * Called to remove an individual cookie from the cookie list, specified
1.35 + * by host, name, and path. If the cookie cannot be found, no exception
1.36 + * is thrown. Typically, the arguments to this method will be obtained
1.37 + * directly from the desired nsICookie object.
1.38 + *
1.39 + * @param aHost The host or domain for which the cookie was set. @see
1.40 + * nsICookieManager2::add for a description of acceptable host
1.41 + * strings. If the target cookie is a domain cookie, a leading
1.42 + * dot must be present.
1.43 + * @param aName The name specified in the cookie
1.44 + * @param aPath The path for which the cookie was set
1.45 + * @param aBlocked Indicates if cookies from this host should be permanently blocked
1.46 + *
1.47 + */
1.48 + void remove(in AUTF8String aHost,
1.49 + in ACString aName,
1.50 + in AUTF8String aPath,
1.51 + in boolean aBlocked);
1.52 +};
