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

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

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);

});

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.