webNavigation.getAllFrames()

Given a tab ID, retrieves information about all the frames it contains.

This is an asynchronous function that returns a Promise.

Syntax

var gettingFrames = browser.webNavigation.getAllFrames(
  details                // object
)

Parameters

details
object. Information about the tab to retrieve all frames from.
tabId
integer. The ID of the tab.

Return value

A Promise that will be fulfilled with an array of objects, each of which has the following properties:

errorOccurred
boolean. True if the last navigation in this frame was interrupted by an error, i.e. the onErrorOccurred event fired.
processId
integer. The ID of the process running the renderer for this tab.
frameId
integer. The ID of the frame. If this is the main frame, then frameId is zero.
parentFrameId
integer. ID of this frame's parent. This is -1 if there is no parent frame: that is, if this frame is the top-level browsing context in the tab.
url
string. The URL currently associated with this frame.

If the specified tab could not be found, or some other error occurs, the promise will be rejected with an error message.

Browser compatibility

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

Examples

This code logs the URLs of all frames in the active tab, when the user clicks a browser action:

function logFrameInfo(framesInfo) {
  for (frameInfo of framesInfo) {
    console.log(frameInfo);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

function logAllFrames(tabs) {
  var gettingAllFrames = browser.webNavigation.getAllFrames({tabId: tabs[0].id});
  gettingAllFrames.then(logFrameInfo, onError);
}

browser.browserAction.onClicked.addListener(function() {

  var querying = browser.tabs.query({
    currentWindow: true,
    active: true
  });

  querying.then(logAllFrames, onError);

});

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: wbamberg, Makyen
 Last updated by: wbamberg,