alarms.get()

Cette méthode permet d'obtenir une alarme en fonction de son nom. Cette fonction est une fonction asynchrone qui renvoie une promesse (Promise).

Syntaxe

var getAlarm = browser.alarms.get(
  name  // optional string
)

Paramètres

nameFacultatif

string. Le nom de l'alarme qu'on souhaite récupérer. La valeur par défaut, utilisée si aucun argument n'est fournie, sera la chaîne vide ("").

Valeur de retour

Une promesse (Promise) qui sera tenue avec un objet Alarm. Cette valeur correspond à l'alarme dont le nom correspond au paramètre name. Si aucune alarme ne correspond, la valeur renvoyée sera undefined.

Compatibilité du navigateur

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Exemples

function gotAlarm(alarm) {
  if (alarm) {
    console.log(alarm.name);
  }
}

var getAlarm = browser.alarms.get("my-periodic-alarm");
getAlarm.then(gotAlarm);