Interface nsICookieRuleType

Rule which specifies a cookie to be set in order to handle a cookie banner.

Hierarchy

Properties

cookie expiryRelative unsetValue

Methods

AddRef QueryInterface Release copyForDomain

Properties

Readonly cookie

cookie: nsICookie

The cookie to set. When calling this getter creation, expiry and last accessed time are computed.

Readonly expiryRelative

expiryRelative: int64_t

Expiry time of the cookie in seconds relative to the injection time. If you want a cookie to expire in 1 month after it has been set, set this to 2592000. Defaults to 'cookiebanners.cookieInjector.defaultExpiryRelative'.

Readonly unsetValue

unsetValue: string

If an existing cookie sets this value it may be overwritten. This is used for sites which set an explicit cookie state, even if a cookie banner is still pending.

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

copyForDomain

  • Create a copy of this rule for a domain. If the cookie host is unset it is set to ".". Non-empty host fields will be preserved.

    Parameters

    • aDomain: string

    Returns nsICookieRule

Settings

Member Visibility

Theme

Generated using TypeDoc