WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsICookieManager2

IID:5047cab4-9cb2-4927-a4ab-77422bc3bc67
Inherits From:nsICookieManager

Additions to the frozen nsICookieManager

This interface is intended to be used as a service. To create an object implementing this interface: 

var obj = Components.classes["@mozilla.org/cookiemanager;1"].
            getService(Components.interfaces.nsICookieManager2);

This interface is implemented by the following components:

Methods

void add ( AUTF8String domain , AUTF8String path , ACString name , ACString value , PRBool isSecure , PRBool isHttpOnly , PRBool isSession , PRInt64 expiry ) PRBool cookieExists ( nsICookie2 cookie ) PRUint32 countCookiesFromHost ( ACString host ) void importCookies ( nsIFile cookieFile )

void add ( AUTF8String domain , AUTF8String path , ACString name , ACString value , PRBool isSecure , PRBool isHttpOnly , PRBool isSession , PRInt64 expiry )

Add a cookie. nsICookieService is the normal way to do this. This method is something of a backdoor.

Arguments:
domain: the host or domain for which the cookie is set. presence of a leading dot indicates a domain cookie; otherwise, the cookie is treated as a non-domain cookie. see RFC2109.
path: path within the domain for which the cookie is valid
name: cookie name
value: cookie data
isSecure: true if the cookie should only be sent over a secure connection.
isHttpOnly: true if the cookie should only be sent to, and can only be modified by, an http connection.
isSession: true if the cookie should exist for the current session only. see expiry.
expiry: expiration date, in seconds since midnight (00:00:00), January 1, 1970 UTC. note that expiry time will also be honored for session cookies; in this way, the more restrictive of the two will take effect.

PRBool cookieExists ( nsICookie2 cookie )

Find whether a given cookie already exists.

Arguments:
cookie: the cookie to look for
Returns:
true if a cookie was found which matches the host, path, and name fields of aCookie

PRUint32 countCookiesFromHost ( ACString host )

Count how many cookies would be returned to a given host, ignoring the cookie flags isDomain, isSecure, and isHttpOnly. Thus, for a host "weather.yahoo.com", host or domain cookies for "weather.yahoo.com" and "yahoo.com" would be counted, while a cookie for "my.weather.yahoo.com" would not.

Arguments:
host: the host string to look for, e.g. "google.com". this should consist of only the host portion of a URI, and should not contain a leading dot, a port, etc.
Returns:
the number of cookies found.

void importCookies ( nsIFile cookieFile )

Import an old-style cookie file. Imported cookies will be added to the existing database. If the database contains any cookies the same as those being imported (i.e. domain, name, and path match), they will be replaced.

Arguments:
cookieFile: the file to import, usually cookies.txt

Reference documentation is generated from Mozilla's source.