Interface nsIUrlClassifierExceptionListServiceType

A service that monitors updates to the exception list of url-classifier feature from sources such as a local pref and remote settings updates.

Hierarchy

Methods

AddRef QueryInterface Release clear registerAndRunExceptionListObserver unregisterExceptionListObserver

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

clear

  • Clear all data in the service. This API is for testing only.

    Returns void

registerAndRunExceptionListObserver

  • Register a new observer to exception list updates. When the observer is registered it is called immediately once. Afterwards it will be called whenever the specified pref changes or when remote settings for url-classifier features updates.

    Parameters

    • aFeature: string

      The feature for which to observe the exception list.

    • aPrefName: string

      (Optional) A pref name to monitor. The pref must be of string type and contain a comma-separated list of URL patterns.

    • aObserver: nsIUrlClassifierExceptionListObserver

      An nsIUrlClassifierExceptionListObserver object or function that will receive updates to the exception list as a comma-separated string. Will be called immediately with the current exception list value.

    Returns void

unregisterExceptionListObserver

  • Unregister an observer.

    Parameters

    • aFeature: string

      The feature for which to stop observing.

    • aObserver: nsIUrlClassifierExceptionListObserver

      The nsIUrlClassifierExceptionListObserver object to unregister.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc