Interface nsIURLQueryStrippingListServiceType

A service that monitors updates to the query stripping list from sources such as a local pref and remote settings updates.

Hierarchy

Methods

AddRef QueryInterface Release clearLists registerAndRunObserver testWaitForInit unregisterObserver

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

clearLists

  • Clear all Lists.

    Note that this is for testing purpose.

    Returns void

registerAndRunObserver

  • Register a new observer to query stripping 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 partitioning updates.

    Parameters

    • aObserver: nsIURLQueryStrippingListObserver

      An nsIURLQueryStrippingListObserver object or function that will receive updates to the strip list and the allow list. Will be called immediately with the current list value.

    Returns void

testWaitForInit

  • Test-only method used to wait for the list service to initialize fully. Resolves once the service has reached a fully disabled (false) or fully enabled state (true). May also be called when the service is already fully initialized or disabled, in this case it will resolve immediately.

    Returns any

unregisterObserver

  • Unregister an observer.

    Parameters

    • aObserver: nsIURLQueryStrippingListObserver

      The nsIURLQueryStrippingListObserver object to unregister.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc