Public Member Functions | Public Attributes

nsICookieManager Interface Reference

An optional interface for accessing or removing the cookies that are in the cookie list. More...

import "nsICookieManager.idl";

Inheritance diagram for nsICookieManager:
Collaboration diagram for nsICookieManager:

List of all members.

Public Member Functions

void removeAll ()
 Called to remove all cookies from the cookie list.
void remove (in AUTF8String aHost, in ACString aName, in AUTF8String aPath, in boolean aBlocked)
 Called to remove an individual cookie from the cookie list, specified by host, name, and path.

Public Attributes

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

Detailed Description

An optional interface for accessing or removing the cookies that are in the cookie list.

Status:
FROZEN

Member Function Documentation

void nsICookieManager::remove ( in AUTF8String  aHost,
in ACString  aName,
in AUTF8String  aPath,
in boolean  aBlocked 
)

Called to remove an individual cookie from the cookie list, specified by host, name, and path.

If the cookie cannot be found, no exception is thrown. Typically, the arguments to this method will be obtained directly from the desired nsICookie object.

Parameters:
aHost The host or domain for which the cookie was set.
See also:
nsICookieManager2::add for a description of acceptable host strings. If the target cookie is a domain cookie, a leading dot must be present.
Parameters:
aName The name specified in the cookie
aPath The path for which the cookie was set
aBlocked Indicates if cookies from this host should be permanently blocked
void nsICookieManager::removeAll (  ) 

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


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