Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsICookieManager2 Interface Reference

Additions to the frozen nsICookieManager. More...

import "nsICookieManager2.idl";

Inheritance diagram for nsICookieManager2:
Inheritance graph
[legend]
Collaboration diagram for nsICookieManager2:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void add (in AUTF8String aDomain, in AUTF8String aPath, in ACString aName, in ACString aValue, in boolean aSecure, in boolean aIsSession, in PRInt64 aExpiry)
 Add a cookie.
boolean findMatchingCookie (in nsICookie2 aCookie, out unsigned long aCountFromHost)
 Find whether a matching cookie already exists, and how many cookies a given host has already set.
void removeAll ()
 Called to remove all cookies from the cookie list.
void remove (in AUTF8String aDomain, in ACString aName, in AUTF8String aPath, in boolean aBlocked)
 Called to remove an individual cookie from the cookie list.

Public Attributes

readonly attribute
nsISimpleEnumerator 
enumerator
 Called to enumerate through each cookie in the cookie list.

Detailed Description

Additions to the frozen nsICookieManager.

Definition at line 47 of file nsICookieManager2.idl.


Member Function Documentation

void nsICookieManager2::add ( in AUTF8String  aDomain,
in AUTF8String  aPath,
in ACString  aName,
in ACString  aValue,
in boolean  aSecure,
in boolean  aIsSession,
in PRInt64  aExpiry 
)

Add a cookie.

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

Parameters:
aDomainthe 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.
aPathpath within the domain for which the cookie is valid
aNamecookie name
aValuecookie data
aSecuretrue if the cookie should only be sent over a secure connection.
aIsSessiontrue if the cookie should exist for the current session only.
aExpiryexpiration date, in seconds since the epoch. only relevant if aIsSession is false.
boolean nsICookieManager2::findMatchingCookie ( in nsICookie2  aCookie,
out unsigned long  aCountFromHost 
)

Find whether a matching cookie already exists, and how many cookies a given host has already set.

This is useful when e.g. prompting the user whether to accept a given cookie.

Parameters:
aCookiethe cookie to look for
aCountFromHostthe number of cookies found whose hosts are the same as, or subdomains of, the host field of aCookie
Returns:
true if a cookie was found which matches the host, path, and name fields of aCookie
void nsICookieManager::remove ( in AUTF8String  aDomain,
in ACString  aName,
in AUTF8String  aPath,
in boolean  aBlocked 
) [inherited]

Called to remove an individual cookie from the cookie list.

Parameters:
aDomainThe host or domain for which the cookie was set
aNameThe name specified in the cookie
aBlockedIndicates if cookies from this host should be permanently blocked

Called to remove all cookies from the cookie list.


Member Data Documentation

Called to enumerate through each cookie in the cookie list.

The objects enumerated over are of type nsICookie

Definition at line 62 of file nsICookieManager.idl.


The documentation for this interface was generated from the following file: