runtime.onUpdateAvailable

Wird ausgelöst, wenn ein Update für die Erweiterung verfügbar ist. Dieses Ereignis ermöglicht einer Erweiterung, ein Update zu verzögern: Zum Beispiel, weil sie sich mitten in einer Operation befindet, die 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 wird angewendet. Falls die Erweiterung zuhört, wird das Update angewendet, wenn die Erweiterung das nächste Mal neu geladen wird. Dies geschieht, wenn:

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

Syntax

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

Ereignisse haben drei Funktionen:

addListener(listener)

Fügt einen Listener zu diesem Ereignis 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, false ansonsten.

addListener-Syntax

Parameter

listener

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

details

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

Browser-Kompatibilität

BCD tables only load in the browser

Beispiele

Auf UpdateAvailable-Ereignisse hören:

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