Back to index

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

An interface to test for cookie permissions. More...

import "nsICookiePermission.idl";

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

List of all members.

Public Member Functions

void setAccess (in nsIURI aURI, in nsCookieAccess aAccess)
 setAccess
nsCookieAccess canAccess (in nsIURI aURI, in nsIURI aFirstURI, in nsIChannel aChannel)
 canAccess
boolean canSetCookie (in nsIURI aURI, in nsIChannel aChannel, in nsICookie2 aCookie, inout boolean aIsSession, inout PRInt64 aExpiry)
 canSetCookie

Public Attributes

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.

Detailed Description

An interface to test for cookie permissions.

Definition at line 49 of file nsICookiePermission.idl.


Member Function Documentation

canAccess

this method is called to test whether or not the given URI/channel may access the cookie database, either to set or get cookies.

Parameters:
aURIthe URI trying to access cookies
aFirstURIthe URI initiated by the user that resulted in aURI being loaded
aChannelthe channel corresponding to aURI
Returns:
one of the following nsCookieAccess values: ACCESS_DEFAULT, ACCESS_ALLOW, or ACCESS_DENY
boolean nsICookiePermission::canSetCookie ( in nsIURI  aURI,
in nsIChannel  aChannel,
in nsICookie2  aCookie,
inout boolean  aIsSession,
inout PRInt64  aExpiry 
)

canSetCookie

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.

Parameters:
aURIthe URI trying to set the cookie
aChannelthe corresponding to aURI
aCookiethe cookie being added to the cookie database
aIsSessionwhen 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.
aExpirywhen 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.
Returns:
true if the cookie can be set.

setAccess

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).

Parameters:
aURIthe URI to block
aAccessthe new cookie access for the URI.

Member Data Documentation

Definition at line 55 of file nsICookiePermission.idl.

nsCookieAccess values

Definition at line 54 of file nsICookiePermission.idl.

Definition at line 56 of file nsICookiePermission.idl.

additional values for nsCookieAccess, which are not directly used by any methods on this interface, but are nevertheless convenient to define here.

these may be relocated somewhere else if we ever consider freezing this interface.

Definition at line 64 of file nsICookiePermission.idl.


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