webNavigation.onErrorOccurred

Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation.

Syntax

chrome.webNavigation.onErrorOccurred.addListener(
  function(details) {...}     // function
  filter                      // optional object 
)
chrome.webNavigation.onErrorOccurred.removeListener(listener)
chrome.webNavigation.onErrorOccurred.hasListener(listener)

This API is also available as browser.webNavigation.onErrorOccurred.*.

Events have three functions:

addListener(callback)
Adds a listener to this event.
removeListener(listener)
Stop listening to this event. The listener argument is the listener to remove.
hasListener(listener)
Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

callback

Function that will be called when this event occurs. The function will be passed the following arguments:

details
object. Details about the navigation event.
filterOptional

object. An object containing a single property url, which is an Array of events.UrlFilter objects. If you include this parameter, then the event will fire only for transitions to URLs which match at least one UrlFilter in the array. If you omit this parameter, the event will fire for all transitions. Note that filter is not supported in Firefox.

Additional objects

details

tabId
integer. The ID of the tab in which the navigation was happening.
url
string. The URL to which the given frame was navigating.
processId
integer. The ID of the process in which this tab is being rendered.
frameId
integer. Frame in which the navigation was happening. 0 indicates that navigation happened in the tab's top-level browsing context, not in a nested iframe. A positive value indicates that navigation happened in a nested iframe. Frame IDs are unique for a given tab and process.
timeStamp
number. The time at which the error occurred, in milliseconds since the epoch.
error
string. The error code. This is an internal error code, and is not guaranteed to stay the same or be consistent from one browser to another.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 48.0 33

Compatibility notes

Edge

  • Filtering is not supported

Firefox

  • Filtering is supported from version 50.
  • 'error' is not supported.

Firefox for Android

  • Filtering is supported from version 50.
  • 'error' is not supported.

Examples

Logs the target URLs for onErrorOccurred, if the target URL's hostname contains "example.com" or starts with "developer".

var filter = {
  url:
  [
    {hostContains: "example.com"},
    {hostPrefix: "developer"}
  ]
}

function logOnErrorOccurred(details) {
  console.log("onErrorOccurred: " + details.url);
  console.log(details.error);
}

chrome.webNavigation.onErrorOccurred.addListener(logOnErrorOccurred, filter);

Acknowledgements

This API is based on Chromium's chrome.webNavigation API. This documentation is derived from web_navigation.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: Makyen, wbamberg
 Last updated by: Makyen,