Interface nsIHandlerInfoType

nsIHandlerInfo gives access to the information about how a given protocol scheme or MIME-type is handled.

Hierarchy

Properties

alwaysAskBeforeHandling: boolean

alwaysAskBeforeHandling: if true, we should always give the user a dialog asking how to dispose of this content.

defaultDescription: string

A pretty name description of the associated default application. Only usable if hasDefaultHandler is true.

description: string

A human readable description of the handler type

hasDefaultHandler: boolean

Indicates whether a default application handler exists, i.e. whether launchWithFile with action = useSystemDefault is possible and defaultDescription will contain usable information.

possibleApplicationHandlers: nsIMutableArray

Applications that can handle this content type.

The list will include the preferred handler, if any. Elements of this array are nsIHandlerApp objects, and this attribute will always reference an array, whether or not there are any possible handlers. If there are no possible handlers, the array will contain no elements, so just check its length (nsIArray::length) to see if there are any possible handlers.

preferredAction: nsHandlerInfoAction

preferredAction is how the user specified they would like to handle this content type: save to disk, use specified helper app, use OS default handler or handle using navigator; possible value constants listed below

preferredApplicationHandler: nsIHandlerApp

The application the user has said they want associated with this content type. This is not always guaranteed to be set!!

type: string

The type of this handler info. For MIME handlers, this is the MIME type. For protocol handlers, it's the scheme.

Returns

String representing the type.

Methods

  • 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

  • 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

  • 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

  • Launches the application with the specified URI, in a way that depends on the value of preferredAction. preferredAction must be useHelperApp or useSystemDefault.

    Note

    Only the URI scheme is used to determine how to launch. This is essentially a pass-by-value operation. This means that in the case of a file: URI, the handler that is registered for file: will be launched and our code will not make any decision based on the content-type or extension, though the invoked file: handler is free to do so.

    Throw

    NS_ERROR_INVALID_ARG if preferredAction is not valid for this call. Other exceptions may be thrown.

    Parameters

    • aURI: nsIURI

      The URI to launch this application with

    • aBrowsingContext: BrowsingContext

      The window to parent the dialog against, and, if a web handler is chosen, it is loaded in this window as well. See nsIHandlerApp.launchWithURI for more details.

    Returns void

Generated using TypeDoc