HTMLIFrameElement.purgeHistory()

Warning: Removed in Firefox 65.

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.

Examples

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

Supported since Firefox 47, in chrome code only. Removed completely in Firefox 65.

Unlikely ever to be supported in other browsers.