Interface nsIWebProtocolHandlerRegistrarType

nsIWebProtocolHandlerRegistrar

Applications wishing to use web protocol handlers need to implement this interface. Typically they will prompt the user to confirm adding an entry to the local list.

The component must have the contract id defined below so that the Navigator implementation can invoke it.

Hierarchy

Methods

AddRef QueryInterface Release registerProtocolHandler removeProtocolHandler

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

registerProtocolHandler

  • See documentation in Navigator.webidl The additional contentWindow param for this method represents the dom content window from which the method has been called, or its browser window.

    Parameters

    • protocol: string
    • uri: nsIURI
    • title: string
    • documentURI: nsIURI
    • windowOrBrowser: nsISupports

    Returns void

removeProtocolHandler

  • Removes a registered protocol handler

    While registerProtocolHandler is exposed on Navigator, unregistering is exposed through the UI code.

    Parameters

    • protocol: string

      The protocol scheme to remove a service handler for

    • uri: string

      The uri of the service handler to remove

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc