runtime.onUpdateAvailable

Déclenché quand une mise à jour de l'extension est disponible. Cet événement permet à une extension de retarder une mise à jour : par exemple, car elle est au milieu d'une opération qui ne doit pas être interrompue.

Si l'extension n'écoute pas cet événement lorsqu'une mise à jour est disponible, l'extension est rechargée immédiatement et la mise à jour est appliquée. Si l'extension est à l'écoute, la mise à jour sera appliquée la prochaine fois que l'extension sera rechargée. Cela arrive si :

  • Le navigateur est redémarré
  • L'extension est désactivée et réactivée
  • L'extension se recharge explicitement en appelant runtime.reload().

Syntaxe

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

Les événements ont trois fonctions :

addListener(callback)

Ajouter un écouteur à cet événement.

removeListener(listener)

Arrêtez d'écouter cet événement. L'argument listener est un écouteur à supprimer.

hasListener(listener)

Vérifie que l'écouteur est enregistré pour cet événement. Retourne true s'il écoute, sinon false.

Syntaxe addListener

Paramètres

callback

Fonction qui sera appelée quand cet événement se produit. La fonction recevra les arguments suivants :

details

object. Contient une seule propriété, une chaîne nommée version, qui représente le numéro de version de la mise à jour.

Compatibilité des navigateurs

BCD tables only load in the browser

Exemples

Ecoutez les événements UpdateAvailable:

js
function handleUpdateAvailable(details) {
  console.log(details.version);
}

browser.runtime.onUpdateAvailable.addListener(handleUpdateAvailable);

Note :

Cette API est basée sur l'API Chromium chrome.runtime. Cette documentation est dérivée de runtime.json dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.