webNavigation.getAllFrames()

Syntax

let 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.

url

string. The URL associated with this frame.

frameId

integer. The ID of the frame. If this is the main frame, then frameId is zero.

frameType

string. The type of frame. Returns the values "outermost_frame", "fenced_frame", or "sub_frame" .

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.

documentId

string. A UUID of the frame's document.

parentDocumentId

string. A UUID of the parent document owning the frame. Not set if there is no parent.

documentLifecycle

string. The lifecycle the document is in. Returns the values "prerender", "active", "cached", or "pending_deletion".

processId Optional

integer. This value is not set in modern browsers. When it was set, it represented the ID of the process running the renderer for this tab.

If the tab is discarded, the promise will instead resolve with a null value. If the specified tab could not be found, or some other error occurs, the promise will be rejected with an error message.

Examples

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

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

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

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

browser.browserAction.onClicked.addListener(() => {
  browser.tabs
    .query({
      currentWindow: true,
      active: true,
    })
    .then(logAllFrames, onError);
});

Browser compatibility