Interface nsICookieJarSettingsType

Cookie jar settings for top-level documents. Please see CookieJarSettings.h for more details.

Hierarchy

Properties

blockingAllContexts blockingAllThirdPartyContexts cookieBehavior isFirstPartyIsolated isOnContentBlockingAllowList limitForeignContexts partitionForeign partitionKey rejectThirdPartyContexts shouldResistFingerprinting

Methods

AddRef QueryInterface Release cookiePermission initWithURI read write

Properties

Readonly blockingAllContexts

blockingAllContexts: boolean

Readonly blockingAllThirdPartyContexts

blockingAllThirdPartyContexts: boolean

Readonly cookieBehavior

cookieBehavior: number

CookieBehavior at the loading of the document. Any other loadInfo inherits it from its document's loadInfo. If there is not a document involved, cookieBehavior is reject.

Readonly isFirstPartyIsolated

isFirstPartyIsolated: boolean

First-Party Isolation state at the loading of the document.

Readonly isOnContentBlockingAllowList

isOnContentBlockingAllowList: boolean

Whether the top-level document is on the content blocking allow list.

Readonly limitForeignContexts

limitForeignContexts: boolean

partitionForeign

partitionForeign: boolean

Whether our cookie behavior mandates partitioning third-party content.

Readonly partitionKey

partitionKey: string

The key used for partitioning.

Readonly rejectThirdPartyContexts

rejectThirdPartyContexts: boolean

Whether our cookie behavior mandates rejecting third-party contexts.

Readonly shouldResistFingerprinting

shouldResistFingerprinting: boolean

Resist Fingerprinting state at the loading of the document.

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

cookiePermission

  • CookiePermission at the loading of the document for a particular principal. It returns the same cookiePermission also in case it changes during the life-time of the top document.

    Parameters

    • aPrincipal: nsIPrincipal

    Returns number

initWithURI

  • Initiate the cookieJarSettings with a URI. The aURI will be used to build the partition key for this cookieJarSettings. This function is added for js code to be able to set the partitionKey from a first-party URI.

    The aIsPrivate indicates if this cookieJarSettings is initiated for the private browsing mode or not. If aIsPrivate was true, it will get cookieBehavior from the pref "network.cookie.cookieBehavior" which is for the regular browsing mode. Otherwise, it will get from the pref "network.cookie.cookieBehavior.pbmode" for the private browsing mode.

    Parameters

    • aURI: nsIURI
    • aIsPrivate: boolean

    Returns void

read

  • Initialize the object implementing nsISerializable, which must have been freshly constructed via CreateInstance. All data members that can't be set to default values must have been serialized by write, and should be read from aInputStream in the same order by this method.

    Parameters

    • aInputStream: nsIObjectInputStream

    Returns void

write

  • Serialize the object implementing nsISerializable to aOutputStream, by writing each data member that must be recovered later to reconstitute a working replica of this object, in a canonical member and byte order, to aOutputStream.

    NB: a class that implements nsISerializable must also implement nsIClassInfo, in particular nsIClassInfo::GetClassID.

    Parameters

    • aOutputStream: nsIObjectOutputStream

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc