webNavigation.getAllFrames()

Syntax

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

Parameter

details

object. Informationen über den Tab, von 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. Wahr, wenn die letzte Navigation in diesem Frame durch einen Fehler unterbrochen wurde, d.h. das onErrorOccurred-Ereignis ausgelöst wurde.

url

string. Die URL, die mit diesem Frame assoziiert ist.

frameId

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

frameType

string. Der Typ des Frames. Gibt die Werte "outermost_frame", "fenced_frame" oder "sub_frame" zurück.

parentFrameId

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

documentId

string. Eine UUID des Dokuments des Frames.

parentDocumentId

string. Eine UUID des übergeordneten Dokuments, dem der Frame gehört. Wird nicht gesetzt, wenn es kein übergeordnetes Dokument gibt.

documentLifecycle

string. Der Lebenszyklus, in dem sich das Dokument befindet. Gibt die Werte "prerender", "active", "cached" oder "pending_deletion" zurück.

processId Optional Veraltet

integer. Dieser Wert wird in modernen Browsern nicht gesetzt. Als er gesetzt war, repräsentierte er die ID des Prozesses, der den Renderer für diesen Tab ausführte.

Wenn der Tab verworfen wurde, wird das Promise stattdessen mit einem null-Wert aufgelöst. Wenn der angegebene Tab nicht gefunden werden konnte oder ein anderer Fehler auftritt, 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:

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