Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.
This API is available on Firefox OS for privileged or certified applications only.
The download() method of the HTMLIFrameElement interface downloads a specified URL, storing it at /sdcard/download.
Syntax
var instanceOfDOMRequest = instanceOfHTMLIframeElement.download(url, options);
Returns
A DOMRequest for handling the download request. Its request.onsuccess handler handles the success case, and its request.onerror handler handles the failure case.
Parameters
url- The URL of the file to be downloaded.
- options Optional
- An options object allowing optional settings to be specified for the download. The available options are:
filename: The filename to save the downloaded file as. If this is not specified, the filename used will be the original filename, as specified in theurl.referrer: Specifies a referrer for the downloaded file. If this is not specified there will be no referrer.
Examples
var browser = document.querySelector('iframe'); var request = browser.download(fooURL, { filename: 'foo.bin' }); request.onsuccess = function() { console.log("File downladed"); } request.onerror = function() { console.log("Download error"); }
Specification
Not part of any specification.
Browser compatibility
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
|---|---|---|---|---|---|
| Basic support | Not supported | Not supported | Not supported | Not supported | Not supported |
| Feature | Android | Firefox Mobile (Gecko) | Firefox OS (Gecko) | IE Phone | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | Not supported | Not supported | 1.0.1 | Not supported | Not supported | Not supported |
Note: Use of the Browser API requires a privileged app, and browser and/or embed-apps permissions, depending on what you want to do. See Using the Browser API for more details.