Interface nsIReferrerInfoType

Hierarchy

Properties

computedReferrerSpec originalReferrer referrerPolicy sendReferrer

Methods

AddRef GetComputedReferrer QueryInterface Release binaryReferrerPolicy equals getReferrerPolicyString init initWithDocument initWithElement read write

Properties

Readonly computedReferrerSpec

computedReferrerSpec: string

Indicates if the referrer should not be sent or not even when it's available.

Readonly originalReferrer

originalReferrer: nsIURI

The original referrer URI which indicates the full referrer before applying referrer policy

Readonly referrerPolicy

referrerPolicy: nsIReferrerInfo_ReferrerPolicyIDL

Referrer policy which is applied to the referrer

Readonly sendReferrer

sendReferrer: boolean

Indicates if the referrer should not be sent or not even when it's available.

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

GetComputedReferrer

  • Get the computed referrer, if one has been set. The computed referrer is the original referrer manipulated by the referrer-policy. Use the result of this function as the actual referrer value for the channel.

    Returns URIRef

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

binaryReferrerPolicy

  • C++ friendly version of referrerPolicy getter

    Returns ReferrerPolicy

equals

  • Returns whether the other referrerInfo is equivalent to this referrerInfo.

    Parameters

    • other: nsIReferrerInfo

    Returns boolean

getReferrerPolicyString

  • Get referrer policy as string

    Returns string

init

  • Initialize method to create ReferrerInfo object from JS

    Parameters

    • aReferrerPolicy: nsIReferrerInfo_ReferrerPolicyIDL

      referrer policy of the created object

    • aSendReferrer: boolean

      sendReferrer of the created object, defaults to false

    • aOriginalReferrer: nsIURI

      the original referrer, defaults to null.

    Returns void

initWithDocument

  • Initialize with a given document.

    Parameters

    • aDocument: Document

      the document to init referrerInfo object

    Returns void

initWithElement