Crée une nouvelle alarme.

Syntaxe

browser.alarms.create(
  name,              // optional string
  alarmInfo          // optional object
)

Paramètres

nameFacultatif
string. Un nom pour l'alarme. Par défaut, la chaîne est vide
Cela peut être utilisé pour désigner une alarme particulièrement dans  alarms.get() et alarms.clear(). Il sera également disponible dans alarms.onAlarm comme une propriété de nom de l'objet alarms.Alarm passé dans la fonction d'écoute.
Les noms d'alarmes sont toujours unique (dans le cadre d'une seule extension). Si le nom donné ici correspond au nom d'une alarme existante créé par cet extension, l'alarme existante est supprimée et ne se déclenchera pas.
alarmInfoFacultatif

object. Vous pouvez l'utilliser pour spécifier lorsque l'alarme déclanchera d'abord, en tant que valeur absolue (when), ou en retard à partir du moment où l'alarme est réglée (delayInMinutes). Pour que l'alarme se reproduise, spécifiez periodInMinutes.

Sur Chrome, à moins que l'extension ne soit chargée, les alarmes créées ne sont pas autorisées à déclencher plus d'une fois par minute. Si une extension tente de définirt delayInMinutes à une valeur < 1, ou à une valeur < 1 minute dans le futur, l'alarme se déclenchera 1 minute après. Si une extension essaie de définir  periodInMinutes à une valeur < 1, alors l'alarme se déclenchera chaque minute.

L'objet alarmInfo peut contenir les propriétés suivantes :

whenFacultatif
double. Le moment où l'alarme se déclenchera en premier, donnée en  millisecondes depuis l'époque. Pour obtenir le nombre de millisecondes entre l'époque et l'heure actuelle, utilisez Date.now(). Si vous spécifiez quand, ne spécifiez pas delayInMinutes.
delayInMinutesFacultatif
double. Le moment où l'alarme se déclenchera en premier, donnée en minutes à partir du moment où l'alarme est réglée. Si vous spécifiez  delayInMinutes, alors ne spécifiez pas when.
periodInMinutesFacultatif
double. Si c'est spécifié, l'alarme retournera à chaque periodInMinutes après son tir initial. Si vous spécifiez cette valeur, vous pouvez omettre à la fois  when et delayInMinutes, et l'alarme s'allume ensuite après periodInMinutes. Si periodInMinutes n'est pas spécifié, l'alarme ne s'allume qu'une seule fois.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
Support simple (Oui) Non4548 (Oui)

Exemples

Créer une alarme en décalée avec '' pour le nom :

const delayInMinutes = 5;

browser.alarms.create({
  delayInMinutes
});

Créer une alarme périodique basée sur le délai appelé "my-periodic-alarm":

const delayInMinutes = 5;
const periodInMinutes = 2;

browser.alarms.create("my-periodic-alarm", {
  delayInMinutes,
  periodInMinutes
});

Créé une alarme périodique nommée "my-periodic-alarm":

const when = 1545696000;
const periodInMinutes = 2;

browser.alarms.create("my-periodic-alarm", {
  when,
  periodInMinutes
});
Remerciements :

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.

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : hellosct1
 Dernière mise à jour par : hellosct1,