Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIExternalProtocolService Interface Reference

The external protocol service is used for finding and launching platform specific applications for particular protocols. More...

import "nsIExternalProtocolService.idl";

Inheritance diagram for nsIExternalProtocolService:
Inheritance graph
[legend]
Collaboration diagram for nsIExternalProtocolService:
Collaboration graph
[legend]

List of all members.

Public Member Functions

boolean externalProtocolHandlerExists (in string aProtocolScheme)
 Check whether a handler for a specific protocol exists.
boolean isExposedProtocol (in string aProtocolScheme)
 Check whether a handler for a specific protocol is "exposed" as a visible feature of the current application.
void loadUrl (in nsIURI aURL)
 Used to load a url via an external protocol handler (if one exists)
void loadURI (in nsIURI aURI, in nsIPrompt aPrompt)
 Used to load a URI via an external application.
AString getApplicationDescription (in AUTF8String aScheme)
 Gets a human-readable description for the application responsible for handling a specific protocol.

Detailed Description

The external protocol service is used for finding and launching platform specific applications for particular protocols.

You can ask the external protocol service if it has an external handler for a given protocol scheme. And you can ask it to load the url using the default handler.

Definition at line 55 of file nsIExternalProtocolService.idl.


Member Function Documentation

Check whether a handler for a specific protocol exists.

Parameters:
aProtocolSchemeThe scheme from a url: http, ftp, mailto, etc.
Returns:
true if we have a handler and false otherwise.

Gets a human-readable description for the application responsible for handling a specific protocol.

Parameters:
aSchemeThe scheme to look up. For example, "mms".
Exceptions:
NS_ERROR_NOT_IMPLEMENTEDIf getting descriptions for protocol helpers is not supported
NS_ERROR_NOT_AVAILABLEIf no protocol helper exists for this scheme, or if it is not possible to get a description for it.

Check whether a handler for a specific protocol is "exposed" as a visible feature of the current application.

An exposed protocol handler is one that can be used in all contexts. A non-exposed protocol handler is one that can only be used internally by the application. For example, a non-exposed protocol would not be loaded by the application in response to a link click or a X-remote openURL command. Instead, it would be deferred to the system's external protocol handler.

Used to load a URI via an external application.

Might prompt the user for permission to load the external application. Replaces loadUrl()

Parameters:
aURIThe URI to load
aPromptIf null we grab one from windowwatcher if we need it

Used to load a url via an external protocol handler (if one exists)

Parameters:
aURLThe url to load

The documentation for this interface was generated from the following file: