Interface nsIDBusHandlerAppType

nsIDBusHandlerApp represents local applications launched by DBus a message invoking a method taking a single string argument descibing a URI

Hierarchy

Properties

dBusInterface detailedDescription method name objectPath service

Methods

AddRef QueryInterface Release equals launchWithURI

Properties

dBusInterface

dBusInterface: string

DBusInterface defines the interface of the dbus service that should handle this protocol. If its not set, NS_ERROR_FAILURE will be returned by LaunchWithURI

detailedDescription

detailedDescription: string

Detailed description for this handler. Suitable for a tooltip or short informative sentence.

method

method: string

Method defines the dbus method that should be invoked to handle this protocol. If its not set, NS_ERROR_FAILURE will be returned by LaunchWithURI

name

name: string

Human readable name for the handler

objectPath

objectPath: string

Objpath defines the object path of the dbus service that should handle this protocol. If its not set, NS_ERROR_FAILURE will be returned by LaunchWithURI

service

service: string

Service defines the dbus service that should handle this protocol. If its not set, NS_ERROR_FAILURE will be returned by LaunchWithURI

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

equals

  • Whether or not the given handler app is logically equivalent to the invokant (i.e. they represent the same app).

    Two apps are the same if they are both either local or web handlers and their executables/URI templates and command line parameters are the same.

    Returns

    true if the two are logically equivalent, false otherwise

    Parameters

    • aHandlerApp: nsIHandlerApp

      the handler app to compare to the invokant

    Returns boolean

launchWithURI

  • Launches the application with the specified URI.

    Parameters

    • aURI: nsIURI

      The URI to launch this application with

    • aBrowsingContext: BrowsingContext

      This represents the docshell to load the handler in and is passed through to nsIURILoader.openURI. If this parameter is null or not present, the web handler app implementation will attempt to find/create a place to load the handler and do so. As of this writing, it tries to load the web handler in a new window using nsIBrowserDOMWindow.openURI. In the future, it may attempt to have a more comprehensive strategy which could include handing off to the system default browser (bug 394479).

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc