webNavigation.getFrame()

Retrieves information about a particular frame. A frame may be the top-level frame in a tab or a nested <iframe>, and is uniquely identified by a tab ID and a frame ID.

This is an asynchronous function that returns a Promise.

Syntax

js
let gettingFrame = browser.webNavigation.getFrame(
  details                // object
)

Parameters

details

object. Information about the frame to retrieve information about.

tabId

integer. The ID of the tab in which the frame is.

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.

frameId

integer. The ID of the frame in the given tab.

Return value

A Promise that will be fulfilled with an object containing 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 currently associated with this frame, if the frame identified by frameId existed at one point in the tab identified by tabId. The fact that a URL is associated with a given frameId does not imply that the corresponding frame still exists.

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.

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

Browser compatibility

BCD tables only load in the browser

Examples

js
function onGot(frameInfo) {
  console.log(frameInfo);
}

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

let gettingFrame = browser.webNavigation.getFrame({
  tabId: 19,
  frameId: 1537,
});

// Edge specific - processId is required not optional, must be integer not null
//let gettingFrame = browser.webNavigation.getFrame({ tabId: 19, processId: 0, frameId: 1537 });

gettingFrame.then(onGot, onError);

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