runtime.getBackgroundPage()

Ruft das Window-Objekt für die Hintergrundseite ab, die innerhalb der aktuellen Erweiterung läuft. Wenn die Hintergrundseite nicht persistent ist (eine Ereignisseite) und nicht läuft, wird die Hintergrundseite gestartet.

Dies bietet eine bequeme Möglichkeit für andere privilegierte Erweiterungsskripte, direkten Zugang zum Gültigkeitsbereich des Hintergrundskripts zu erhalten. Dies ermöglicht ihnen den Zugriff auf Variablen oder das Aufrufen von Funktionen, die in diesem Bereich definiert sind. "Privilegiertes Skript" umfasst hierbei Skripte, die in Optionsseiten laufen, oder Skripte, die in Browser-Action- oder Page-Action-Popups laufen, jedoch nicht Inhaltsskripte.

Beachten Sie, dass Variablen, die mit const oder let deklariert wurden, nicht im Window-Objekt erscheinen, das von dieser Funktion zurückgegeben wird.

Beachten Sie auch, dass diese Methode nicht in einem privaten Fenster in Firefox verwendet werden kann—sie gibt immer null zurück. Weitere Informationen finden Sie im verwandten Bug bei Bugzilla.

Wenn die Hintergrundseite eine Ereignisseite ist, stellt das System sicher, dass sie geladen ist, bevor das Versprechen aufgelöst wird.

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

Hinweis: In Firefox kann diese Methode im privaten Modus nicht verwendet werden — sie gibt immer null zurück. Weitere Informationen finden Sie im Firefox-Bug 1329304.

In Chrome ist diese Methode nur mit persistenten Hintergrundseiten verfügbar, die in Manifest V3 nicht verfügbar sind, daher sollten Sie in Betracht ziehen, Manifest V2 zu verwenden. Details finden Sie unter Migration zu einem Service-Worker.

Erwägen Sie die Verwendung von runtime.sendMessage() oder runtime.connect(), die in beiden oben genannten Szenarien korrekt funktionieren.

Syntax

js
let gettingPage = browser.runtime.getBackgroundPage()

Parameter

Keine.

Rückgabewert

Ein Promise, das mit dem Window-Objekt für die Hintergrundseite erfüllt wird, wenn es eine gibt. Wenn die Erweiterung keine Hintergrundseite enthält, wird das Promise mit einer Fehlermeldung abgelehnt.

Browser-Kompatibilität

Beispiele

Angenommen, ein Hintergrundskript definiert eine Funktion foo():

js
// background.js

function foo() {
  console.log("I'm defined in background.js");
}

Ein Skript, das in einem Popup läuft, kann diese Funktion direkt so aufrufen:

js
// popup.js

function onGot(page) {
  page.foo();
}

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

let getting = browser.runtime.getBackgroundPage();
getting.then(onGot, onError);

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