Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

HTMLIFrameElement.purgeHistory()

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 purgeHistory() method of the HTMLIFrameElement interface is used to clear the browsing history associated with the browser <iframe>. It only deletes history, not cookies or other stored information.

Note: To delete cookies for a Firefox OS app, you could call clearBrowserData() on the actual app itself.

Syntax

There is a DOMRequest version and a Promise version:

var myDOMRequest = instanceOfHTMLIframeElement.purgeHistory();
instanceOfHTMLIframeElement.purgeHistory().then(function() { ... });

Returns

Either

  • A DOMRequest object that returns an onsuccess handler if the history is deleted, or an onerror handler if not.
  • A Promise that resolves, with no parameters, if the history is deleted, or rejects if not.

Parameters

None.

Example

DOMRequest:

var browser = document.querySelector('iframe');
var request = browser.purgeHistory();

request.onsuccess = function() {
  console.log('History deleted!');
}

request.onerror = function() {
  console.error(this.error.name);
}

Promise:

var browser = document.querySelector('iframe');

browser.purgeHistory().then(function() {
  console.log('History deleted!');
},
function(error) {
  console.error(this.error.name);
});

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.

See also

Document Tags and Contributors

 Contributors to this page: wbamberg, chrisdavidmills, teoli, pablobm, ajaybhat, kscarfone, Jeremie
 Last updated by: wbamberg,