navigator.registerProtocolHandler Redirect 1

Summary

Allows web sites to register themselves as possible handlers for particular protocols.

Note: Web sites may only register protocol handlers for themselves. For security reasons, it's not possible for an extension or web site to register protocol handlers targeting other sites.

Syntax

window.navigator.registerProtocolHandler(protocol, uri, title);
  • protocol is the protocol the site wishes to handle, specified as a string.
  • uri is the URI to the handler as a string. You can include "%s" to indicate where to insert the escaped URI of the document to be handled.
  • title is the title of the handler presented to the user as a string.

Example

If your web application is located at http://www.example.com, you can register a protocol handler for it to handle "mailto" like this:

navigator.registerProtocolHandler("mailto",
                                  "https://www.example.com/?uri=%s",
                                  "Example Mail");


This creates a handler that allows mailto links to direct the user to your web application, inserting the email address specified in the link into the URL.

Specification

Specified by the WHATWG's Web Applications 1.0 working draft (HTML5).

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support

13

Protocol whitelist includes mailto, mms, nntp, rtsp, and webcal. Custom protocols must be prefixed with "web+".

3.0 (1.9) ? Opera 11.60 ?
Feature Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support ? 3.0 (3.5) ? ? ?

See also

Document Tags and Contributors

Contributors to this page: Sheppy
Last updated by: Sheppy,