webNavigation.getAllFrames()

Gibt für eine angegebene Tab-ID Informationen über alle Frames zurück, die dieser enthält.

Dies ist eine asynchrone Funktion, die ein Promise zurückgibt.

Syntax

js
let gettingFrames = browser.webNavigation.getAllFrames(
  details                // object
)

Parameter

details

object. Informationen über den Tab, aus dem alle Frames abgerufen werden sollen.

tabId

integer. Die ID des Tabs.

Rückgabewert

Ein Promise, das mit einem Array von Objekten erfüllt wird, von denen jedes die folgenden Eigenschaften hat:

errorOccurred

boolean. True, wenn die letzte Navigation in diesem Frame durch einen Fehler unterbrochen wurde, d.h. das onErrorOccurred Ereignis ausgelöst wurde.

processId Optional Veraltet

integer. Dieser Wert wird in modernen Browsern nicht gesetzt. Wenn er gesetzt war, stellte er die ID des Prozesses dar, der den Renderer für diesen Tab ausführt.

frameId

integer. Die ID des Frames. Ist dies der Hauptframe, dann ist frameId null.

parentFrameId

integer. ID des übergeordneten Frames. Dies ist -1, wenn es keinen übergeordneten Frame gibt: das heißt, wenn dieser Frame der oberste Browsing-Kontext im Tab ist.

url

string. Die URL, die derzeit mit diesem Frame verknüpft ist.

Wenn der Tab verworfen wird, wird das Promise stattdessen mit einem null-Wert erfüllt. Kann der angegebene Tab nicht gefunden werden oder tritt ein anderer Fehler auf, wird das Promise mit einer Fehlermeldung abgelehnt.

Beispiele

Dieser Code protokolliert die URLs aller Frames im aktiven Tab, wenn der Benutzer auf eine Browser-Aktion klickt:

js
function logFrameInfo(framesInfo) {
  for (const frameInfo of framesInfo) {
    console.log(frameInfo);
  }
}

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

function logAllFrames(tabs) {
  browser.webNavigation
    .getAllFrames({
      tabId: tabs[0].id,
    })
    .then(logFrameInfo, onError);
}

browser.browserAction.onClicked.addListener(() => {
  browser.tabs
    .query({
      currentWindow: true,
      active: true,
    })
    .then(logAllFrames, onError);
});

Browser-Kompatibilität

Hinweis: Diese API basiert auf Chromiums chrome.webNavigation API. Diese Dokumentation ist abgeleitet von web_navigation.json im Chromium-Code.