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

var 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
integer. 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 an 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 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

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

Examples

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

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

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

gettingFrame.then(onGot, 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,