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.

Syntax

chrome.webNavigation.getFrame(
  details,                // object
  function(details) {...} // function
)

This API is also available as browser.webNavigation.getFrame() in a version that returns a promise.

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.

callback

function. The function is passed the following arguments:

detailsOptional

object. Information about the requested frame. If the specified frame ID and/or tab ID are invalid, this is null.

Additional objects

details

Information about the requested frame. If the specified frame ID and/or tab ID are invalid, this is null.

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.

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

function logFrameInfo(frameInfo) {
  console.log(frameInfo.url);
}

var frameReference = {
  tabId: myTabId,
  frameId: myFrameId,
  processId: myProcessId
}

chrome.webNavigation.getFrame(frameReference, logFrameInfo);

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