Interface nsIURIClassifierType

The URI classifier service checks a URI against lists of phishing and malware sites.

Hierarchy

Methods

AddRef QueryInterface Release asyncClassifyLocalWithFeatures classify createFeatureWithTables getFeatureByName sendThreatHitReport

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

asyncClassifyLocalWithFeatures

  • Asynchronously classify a URI with list of features. This does not make network requests.

    Parameters

    • aURI: nsIURI
    • aFeatures: invalid
    • aListType: nsIUrlClassifierFeature_listType
    • aCallback: nsIUrlClassifierFeatureCallback

    Returns void

classify

  • Classify a Principal using its URI.

    Returns

    false if classification is not necessary. The callback will not be called. true if classification will be performed. The callback will be called.

    Parameters

    • aPrincipal: nsIPrincipal

      The principal that should be checked by the URI classifier.

    • aCallback: nsIURIClassifierCallback

      The URI classifier will call this callback when the URI has been classified.

    Returns boolean

createFeatureWithTables

  • Create a new feature with a list of tables. This method is just for testing! Don't use it elsewhere.

    Parameters

    • aName: string
    • aBlocklistTables: invalid
    • aEntitylistTables: invalid

    Returns nsIUrlClassifierFeature

getFeatureByName

  • Returns a feature named aFeatureName.

    Parameters

    • aFeatureName: string

    Returns nsIUrlClassifierFeature

sendThreatHitReport

  • Report to the provider that a Safe Browsing warning was shown.

    Parameters

    • aChannel: nsIChannel

      Channel for which the URL matched something on the threat list.

    • aProvider: string

      Provider to notify.

    • aList: string

      List where the full hash was found.

    • aFullHash: string

      Full URL hash that triggered the warning.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc