HTMLIFrameElement.purgeHistory()

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

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 No support 47 (47)[1] No support No support No support
Feature Android Android Webview Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support No support No support No support No support No support No support

[1] Supported in chrome code only.

See also

Document Tags and Contributors

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