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
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. theonErrorOccurred
event fired.url
string
. The URL currently associated with this frame, if the frame identified byframeId
existed at one point in the tab identified bytabId
. The fact that an URL is associated with a givenframeId
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
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
getFrame | ChromeFull supportYes | EdgeFull support14 | FirefoxFull support47 | OperaFull support17 | SafariFull support14 | Firefox for AndroidFull support48 |
Legend
- Full support
- Full support
Examples
function onGot(frameInfo) {
console.log(frameInfo);
}
function onError(error) {
console.log(`Error: ${error}`);
}
var gettingFrame = browser.webNavigation.getFrame({
tabId: 19,
frameId: 1537
});
// Edge specific - processId is required not optional, must be integer not null
//var gettingFrame = browser.webNavigation.getFrame({ tabId: 19, processId: 0, frameId: 1537 });
gettingFrame.then(onGot, onError);
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.