URLDispatcher
Differences between revisions 1 and 11 (spanning 10 versions)
|
Size: 2011
Comment:
|
Size: 864
Comment: Link to developer.ubuntu.com with the appropriate docs
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| == Introduction == | == User Documentation == |
| Line 3: | Line 3: |
| The URL Dispatcher is a small service that can allow applications that are confined to launch other applications that are identified with a particular URL. Perhaps the most common case would be sending an http:// URL to the web browser, but other applications like music or just starting an application that is in a different sandbox is also supported. For most applications this is a useful way to get out of their application to another piece of content or user request. | Documentation on using URL Dispatcher as an application developer is now available on the developer website: |
| Line 5: | Line 5: |
| For Qt/QML applications access to the URL Dispatcher is provided through the Qt desktop plugin so the openURL() function is valid to use and the backend is transparent. For other applications they can use the Platform API or liburl-dispatcher directly depending on their needs. | [[https://developer.ubuntu.com/en/start/platform/guides/url-dispatcher-guide/]] |
| Line 7: | Line 7: |
| == Supported URLs == | == Upstream == |
| Line 9: | Line 9: |
| === Base URLS === | The URL dispatcher project is hosted in [[https://launchpad.net/url-dispatcher|Launchpad]]. |
| Line 11: | Line 11: |
| There are a few URLs that are supported internally in the URL dispatcher. | == Unsupported URLs == |
| Line 13: | Line 13: |
| || '''URL''' || '''Description''' || || application:///$(app_id).desktop || The application URL can be used to start an application with a known Application ID. For applications that install their desktop file in /usr/share/applications the application ID should just be the name of the desktop file. || |
(bug Bug:1370008) |
| Line 16: | Line 15: |
| === Application URLs === | {{attachment:unrecognized-address.png}} |
| Line 18: | Line 17: |
| Applications will be able to request URLs in the future, but that isn't supported yet. === Temporarily Hardcoded URLs === Because the above feature isn't there, we've hardcoded in some URLs that will be useful in the short term. || '''URL''' || '''App ID''' || '''Description''' || || tel://$(number) || dialer-app || Requests a phone number to be brought up in the dialer. || || music://* file:///home/*/Music/* || music-app || Opens music in the Music player || || http://* https://* || webbrowser-app ||Opens a URL in the webbrowser || || video:// file:///home/*/Videos/* || mediaplayer-app || Opens video content in the media player || || settings://system/$(plugin) || ubuntu-system-settings || Open a specific settings panel in the settings app. || |
Whenever the URL dispatcher is called on to open an address of a protocol that it does not understand (`url-dispatcher-bad-url`), it should open an alert with the title “Unrecognized Address”, text of the form ‘Ubuntu can’t open addresses of type “{protocol:}”.’, and an “OK” button. To prevent denial of UI service, however, the alert should not open if it has already opened more than three times in the past minute. |
User Documentation
Documentation on using URL Dispatcher as an application developer is now available on the developer website:
https://developer.ubuntu.com/en/start/platform/guides/url-dispatcher-guide/
Upstream
The URL dispatcher project is hosted in Launchpad.
Unsupported URLs
(bug 1370008)
Whenever the URL dispatcher is called on to open an address of a protocol that it does not understand (url-dispatcher-bad-url), it should open an alert with the title “Unrecognized Address”, text of the form ‘Ubuntu can’t open addresses of type “{protocol:}”.’, and an “OK” button. To prevent denial of UI service, however, the alert should not open if it has already opened more than three times in the past minute.
URLDispatcher (last edited 2015-08-04 15:15:51 by mpt)