Interface nsICookieBannerRuleType

A rule containing instructions on how to handle a cookie banner for a specific domain.

Hierarchy

Properties

clickRule id

Methods

AddRef QueryInterface Release addClickRule addCookie clearClickRule clearCookies

Properties

Readonly clickRule

clickRule: nsIClickRule

id

id: string

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

addClickRule

  • Add a click rule to the rule.

    aPresence - The CSS selector for detecting the presence of the cookie banner aSkipPresenceVisibilityCheck - Whether to skip checking if the banner is visible before clicking it. aHide - The CSS selector for hiding the cookie banner aOptOut - The CSS selector for selecting the opt-out banner button aOptIn - The CSS selector for selecting the opt-in banner button

    Parameters

    • aPresence: string
    • aSkipPresenceVisibilityCheck: bool
    • aRunContext: nsIClickRule_RunContext
    • aHide: string
    • aOptOut: string
    • aOptIn: string

    Returns void

addCookie

  • Add an opt-in or opt-out cookie to the rule. aIsOptOut - Whether this is an opt-out cookie (true) or opt-in cookie (false). aExpiryRelative - See nsICookieRule. aUnsetValue - See nsICookieRule. For a description of the other fields see nsICookieManager#addNative.

    Parameters

    • aIsOptOut: boolean
    • aName: string
    • aValue: string
    • aHost: string
    • aPath: string
    • aExpiryRelative: int64_t
    • aUnsetValue: string
    • aIsSecure: boolean
    • aIsHttpOnly: boolean
    • aIsSession: boolean
    • aSameSite: int32_t
    • aSchemeMap: nsICookie_schemeType

    Returns void

clearClickRule

  • Clear the click rule.

    Returns void

clearCookies

  • Clear both lists of opt-in and opt-out cookies.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc