Interface nsIUrlClassifierFeatureType

A single URLClassifier feature.

Hierarchy

Properties

exceptionHostList name

Methods

AddRef QueryInterface Release getTables getURIByListType hasHostInPreferences hasTable processChannel

Properties

Readonly exceptionHostList

exceptionHostList: string

Returns a comma-separated list of hosts to be ignored.

Readonly name

name: string

The feature name

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

getTables

  • Returns the tables for one of the possible lists.

    Parameters

    • aListType: nsIUrlClassifierFeature_listType

    Returns StringArrayRef

getURIByListType

  • Features can work with different URLs from a channel (channel url, or top-level, or something else). This method returns what we need to use for the current list. If the returned URI is created by CreatePairwiseEntityListURI(), the URIType is pairwiseEntitylistURI. Otherwise, it depends on the listType.

    Parameters

    • channel: nsIChannel
    • listType: nsIUrlClassifierFeature_listType
    • URIType: nsIUrlClassifierFeature_URIType

    Returns nsIURI

hasHostInPreferences

  • Returns true if |aHost| is contained in the preference of |aListType| type. |aPrefTableName| will be set to the table name to use.

    Parameters

    • aHost: string
    • aListType: nsIUrlClassifierFeature_listType
    • aPrefTableName: string

    Returns boolean

hasTable

  • Returns true if |aTable| is part of the tables of |aListType| type.

    Parameters

    • aTable: string
    • aListType: nsIUrlClassifierFeature_listType

    Returns boolean

processChannel

  • When this feature matches the channel, this method is executed to do 'something' on the channel. For instance, a tracking-annotation feature would mark the channel as tracker, a tracking-protection feature would cancel the channel. Returns if we should process other feature results or not. For instance, tracking-protection cancel the channel, and after that we should stop processing other features.

    Parameters

    • aChannel: nsIChannel
    • aList: ConstStringArrayRef
    • aHashes: ConstStringArrayRef

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc