Back to index
An interface to test for cookie permissions. More...
|void||setAccess (in nsIURI aURI, in nsCookieAccess aAccess)|
|nsCookieAccess||canAccess (in nsIURI aURI, in nsIURI aFirstURI, in nsIChannel aChannel)|
|boolean||canSetCookie (in nsIURI aURI, in nsIChannel aChannel, in nsICookie2 aCookie, inout boolean aIsSession, inout PRInt64 aExpiry)|
|const nsCookieAccess||ACCESS_DEFAULT = 0|
|nsCookieAccess values |
|const nsCookieAccess||ACCESS_ALLOW = 1|
|const nsCookieAccess||ACCESS_DENY = 2|
|const nsCookieAccess||ACCESS_SESSION = 8|
|additional values for nsCookieAccess, which are not directly used by any methods on this interface, but are nevertheless convenient to define here. |
|nsCookieAccess nsICookiePermission::canAccess||(||in nsIURI||aURI,|
this method is called to test whether or not the given URI/channel may access the cookie database, either to set or get cookies.
|aURI||the URI trying to access cookies|
|aFirstURI||the URI initiated by the user that resulted in aURI being loaded|
|aChannel||the channel corresponding to aURI|
|boolean nsICookiePermission::canSetCookie||(||in nsIURI||aURI,|
this method is called to test whether or not the given URI/channel may set a specific cookie. this method is always preceded by a call to canAccess. it may modify the isSession and expiry attributes of the cookie via the aIsSession and aExpiry parameters, in order to limit or extend the lifetime of the cookie. this is useful, for instance, to downgrade a cookie to session-only if it fails to meet certain criteria.
|aURI||the URI trying to set the cookie|
|aChannel||the corresponding to aURI|
|aCookie||the cookie being added to the cookie database|
|aIsSession||when canSetCookie is invoked, this is the current isSession attribute of the cookie. canSetCookie may leave this value unchanged to preserve this attribute of the cookie.|
|aExpiry||when canSetCookie is invoked, this is the current expiry time of the cookie. canSetCookie may leave this value unchanged to preserve this attribute of the cookie.|
this method is called to block cookie access for the given URI. this may result in other URIs being blocked as well (e.g., URIs which share the same host name).
|aURI||the URI to block|
|aAccess||the new cookie access for the URI.|