alarms.create()
Cette méthode permet de créer une nouvelle alarme pour la session de navigation en cours. Une alarme peut se déclencher une ou plusieurs fois. Une alarme est effacée après qu'elle se soit déclenchée pour la dernière fois.
Syntaxe
browser.alarms.create(
name, // une valeur string optionnelle
alarmInfo, // une valeur object optionnelle
);
Paramètres
name
Facultatif-
string
. Le nom utilisé pour l'alarme. Par défaut, la chaîne utilisée sera la chaîne vide. Cette valeur pourra être utilisée pour indiquer une alarme donnée avec les méthodesalarms.get()
etalarms.clear()
. Il sera également disponible pouralarms.onAlarm
sous la forme de la propriéténame
de l'objetalarms.Alarm
passé au gestionnaire d'évènement. Pour une extension donnée, les noms d'alarmes sont toujours uniques (dans le cadre d'une seule extension). Si le nom donné ici correspond à une alarme existante pour cette extension, l'alarme existante sera supprimée et ne se déclenchera pas. alarmInfo
Facultatif-
object
. Un objet de configuration qui indique le moment du premier déclenchement comme valeur absolue (when
) ou relative (delayInMinutes
). Pour que l'alarme se repète, on utilisera le champperiodInMinutes
.Sur Chrome, à moins que l'extension ne soit chargée, les alarmes créées ne sont pas autorisées à se déclencher plus d'une fois par minute. Si une extension tente de définir
delayInMinutes
avec une valeur strictement inférieure à 1 ou avec une valeur strictement inférieure à 1 dans le futur, l'alarme se déclenchera 1 minute après ce délai. Si une extension essaie de définirperiodInMinutes
avec une valeur strictement inférieure à 1, l'alarme se déclenchera alors chaque minute.L'objet
alarmInfo
peut contenir les propriétés suivantes :when
Facultatif-
double
. Le moment où l'alarme se déclenchera en premier. L'instant est indiquée comme une valeur absolue, exprimée en millisecondes depuis epoch. Pour obtenir le nombre de millisecondes entre l'époque et l'heure actuelle, on pourra utiliserDate.now
. Si cette valeur est utilisée, il ne faut pas fournirdelayInMinutes
. delayInMinutes
Facultatif-
double
. Le moment où l'alarme se déclenchera en premier exprimée de façon relative au moment où l'alarme est créée. Si cette option est utilisée, il ne faut pas fournirwhen
. periodInMinutes
Facultatif-
double
. Si cette valeur est indiquée, l'alarme sera répétée périodiquement (toutes lesperiodInMinutes
minutes) après le premier déclenchement. Si cette valeur est indiquée, il n'est pas obligatoire de fournirwhen
oudelayInMinutes
: l'alarme se déclenchera au bout deperiodInMinutes
. SiperiodInMinutes
n'est pas indiquée, l'alarme ne se déclenchera qu'une seule fois.
Exemples
Alarme vide
const delayInMinutes = 5;
browser.alarms.create({
delayInMinutes,
});
Alarme relative périodique
const delayInMinutes = 5;
const periodInMinutes = 2;
browser.alarms.create("my-periodic-alarm", {
delayInMinutes,
periodInMinutes,
});
Alarme périodique absolue
const when = 1545696000;
const periodInMinutes = 2;
browser.alarms.create("my-periodic-alarm", {
when,
periodInMinutes,
});
Compatibilité des navigateurs
BCD tables only load in the browser
Note :
Cette API est basée sur l'API Chromium chrome.alarms
.
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.