runtime.onUpdateAvailable

Wird ausgelöst, wenn ein Update für die Erweiterung verfügbar ist. Dieses Ereignis ermöglicht es einer Erweiterung, ein Update zu verzögern, zum Beispiel, weil sie sich mitten in einem Vorgang befindet, der nicht unterbrochen werden sollte.

Wenn die Erweiterung nicht auf dieses Ereignis hört, wenn ein Update verfügbar wird, wird die Erweiterung sofort neu geladen und das Update angewendet. Wenn die Erweiterung zuhört, wird das Update beim nächsten Neuladen der Erweiterung angewendet. Dies geschieht, wenn:

der Browser neu gestartet wird
die Erweiterung deaktiviert und wieder aktiviert wird
die Erweiterung sich selbst explizit neu lädt, indem sie runtime.reload() aufruft.

Syntax

browser.runtime.onUpdateAvailable.addListener()
browser.runtime.onUpdateAvailable.removeListener(listener)
browser.runtime.onUpdateAvailable.hasListener(listener)

Ereignisse haben drei Funktionen:

addListener(listener): Fügt diesem Ereignis einen Listener hinzu.
removeListener(listener): Hört auf, diesem Ereignis zuzuhören. Das Argument listener ist der zu entfernende Listener.
hasListener(listener): Überprüft, ob ein listener für dieses Ereignis registriert ist. Gibt true zurück, wenn er zuhört, andernfalls false.

addListener-Syntax

Parameter

listener

Die Funktion, die aufgerufen wird, wenn dieses Ereignis eintritt. Der Funktion wird folgendes Argument übergeben:

details: object. Enthält eine einzelne Eigenschaft, einen String namens version, der die Versionsnummer des Updates darstellt.

Browser-Kompatibilität

Beispiele

Lauschen auf UpdateAvailable-Ereignisse:

function handleUpdateAvailable(details) {
  console.log(details.version);
  // Proceed to upgrade the add-on
  browser.runtime.reload();
}

browser.runtime.onUpdateAvailable.addListener(handleUpdateAvailable);

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