Interface nsIExternalHelperAppServiceType

The external helper app service is used for finding and launching platform specific external applications for a given mime content type.

Hierarchy

Methods

AddRef QueryInterface Release applyDecodingForExtension createListener doContent

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

applyDecodingForExtension

  • Returns true if data from a URL with this extension combination is to be decoded from aEncodingType prior to saving or passing off to helper apps, false otherwise.

    Parameters

    • aExtension: string
    • aEncodingType: string

    Returns boolean

createListener

  • Binds an external helper application to a stream listener. The caller should pump data into the returned stream listener. When the OnStopRequest is issued, the stream listener implementation will launch the helper app with this data. Replaces doContent for native code, and uses BrowsingContext.

    Returns

    A nsIStreamListener which the caller should pump the data into.

    Parameters

    • aMimeContentType: string

      The content type of the incoming data

    • aRequest: nsIRequest

      The request corresponding to the incoming data

    • aContentContext: BrowsingContext

      The BrowsingContext that the request was initiated by. Used for closing the window if we opened one specifically for this download.

    • aForceSave: boolean

      True to always save this content to disk, regardless of nsIMIMEInfo and other such influences.

    • aWindowContext: nsIInterfaceRequestor

      Used in parenting helper app dialogs, usually points to the parent browser window. This parameter may be null, in which case dialogs will be parented to aContentContext.

    Returns nsIStreamListener

doContent

  • Binds an external helper application to a stream listener. The caller should pump data into the returned stream listener. When the OnStopRequest is issued, the stream listener implementation will launch the helper app with this data.

    Returns

    A nsIStreamListener which the caller should pump the data into.

    Parameters

    • aMimeContentType: string

      The content type of the incoming data

    • aRequest: nsIRequest

      The request corresponding to the incoming data

    • aContentContext: nsIInterfaceRequestor

      Used in processing content document refresh headers after target content is downloaded.

    • aForceSave: boolean

      True to always save this content to disk, regardless of nsIMIMEInfo and other such influences.

    • aWindowContext: nsIInterfaceRequestor

      Used in parenting helper app dialogs, usually points to the parent browser window. This parameter may be null, in which case dialogs will be parented to aContentContext.

    Returns nsIStreamListener

Settings

Member Visibility

Theme

Generated using TypeDoc