From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- .../webextensions/api/alarms/alarm/index.html | 46 +++++++++ .../webextensions/api/alarms/clear/index.html | 64 +++++++++++++ .../webextensions/api/alarms/clearall/index.html | 57 +++++++++++ .../webextensions/api/alarms/create/index.html | 105 +++++++++++++++++++++ .../webextensions/api/alarms/get/index.html | 62 ++++++++++++ .../webextensions/api/alarms/getall/index.html | 63 +++++++++++++ .../add-ons/webextensions/api/alarms/index.html | 60 ++++++++++++ .../webextensions/api/alarms/onalarm/index.html | 88 +++++++++++++++++ 8 files changed, 545 insertions(+) create mode 100644 files/fr/mozilla/add-ons/webextensions/api/alarms/alarm/index.html create mode 100644 files/fr/mozilla/add-ons/webextensions/api/alarms/clear/index.html create mode 100644 files/fr/mozilla/add-ons/webextensions/api/alarms/clearall/index.html create mode 100644 files/fr/mozilla/add-ons/webextensions/api/alarms/create/index.html create mode 100644 files/fr/mozilla/add-ons/webextensions/api/alarms/get/index.html create mode 100644 files/fr/mozilla/add-ons/webextensions/api/alarms/getall/index.html create mode 100644 files/fr/mozilla/add-ons/webextensions/api/alarms/index.html create mode 100644 files/fr/mozilla/add-ons/webextensions/api/alarms/onalarm/index.html (limited to 'files/fr/mozilla/add-ons/webextensions/api/alarms') diff --git a/files/fr/mozilla/add-ons/webextensions/api/alarms/alarm/index.html b/files/fr/mozilla/add-ons/webextensions/api/alarms/alarm/index.html new file mode 100644 index 0000000000..a5500ca765 --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/alarms/alarm/index.html @@ -0,0 +1,46 @@ +--- +title: alarms.Alarm +slug: Mozilla/Add-ons/WebExtensions/API/alarms/Alarm +tags: + - API + - Add-ons + - Extensions + - Non-standard + - Reference + - Type + - WebExtensions + - alarm + - alarms +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/Alarm +--- +
{{AddonSidebar}}
+ +

Cette interface fournit des informations sur une alarme donnée. Cet objet est retourné à partir de {{WebExtAPIRef('alarms.get()')}} et {{WebExtAPIRef('alarms.getAll()')}} et est passé au gestionnaire d'évènement {{WebExtAPIRef('alarms.onAlarm')}}.

+ +

Type

+ +

Les valeurs de ce type sont des objets contenant les propriétés suivantes :

+ +
+
name
+
string Une chaîne de caractères contenant le nom de l'alarme. Ce nom provient de celui qui a été fourni à la méthode {{WebExtAPIRef('alarms.create()')}} lors de la création de l'alarme.
+
scheduledTime
+
double Un nombre qui représente l'heure à laquelle l'alarme doit être déclenchée, exprimée en nombre de millisecondes depuis epoch.
+
periodInMinutes{{optional_inline}}
+
double Un nombre qui, s'il n'est pas null, indique que l'alarme est périodique et fournit la période.
+
+ +

Compatibilité des navigateur

+ + + +

{{Compat("webextensions.api.alarms.Alarm")}}

+ +

{{WebExtExamples}}

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

+
diff --git a/files/fr/mozilla/add-ons/webextensions/api/alarms/clear/index.html b/files/fr/mozilla/add-ons/webextensions/api/alarms/clear/index.html new file mode 100644 index 0000000000..505237ce9d --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/alarms/clear/index.html @@ -0,0 +1,64 @@ +--- +title: alarms.clear() +slug: Mozilla/Add-ons/WebExtensions/API/alarms/clear +tags: + - API + - Add-ons + - Extensions + - Méthode + - Non-standard + - Reference + - WebExtensions + - alarms + - clear +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/clear +--- +
{{AddonSidebar}}
+ +

Cette méthode supprime une alarme à partir du nom passé en argument. Il s'agit d'une fonction asynchrone qui renvoie une {{jsxref("Promise")}}.

+ +

Syntaxe

+ +
var clearAlarm = browser.alarms.clear(
+  name // string
+);
+
+ +

Paramètres

+ +
+
name{{optional_inline}}
+
string. Le nom de l'alarme à supprimer. Si le paramètre n'est pas fourni, c'est la chaîne vide "" qui sera utilisée.
+
+ +

Valeur de retour

+ +

Une promesse ({{jsxref("Promise")}}) qui sera tenue avec un booléen. Ce booléen vaudra true si l'alarme a bien été effacée et false sinon.

+ +

Exemples

+ +
function onCleared(wasCleared) {
+  console.log(wasCleared);  // true/false
+}
+
+var clearAlarm = browser.alarms.clear("my-periodic-alarm");
+clearAlarm.then(onCleared);
+ +

{{WebExtExamples}}

+ +

 

+ +

Compatibilité des navigateurs

+ + + +

{{Compat("webextensions.api.alarms.clear")}}

+ +

 

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

+
diff --git a/files/fr/mozilla/add-ons/webextensions/api/alarms/clearall/index.html b/files/fr/mozilla/add-ons/webextensions/api/alarms/clearall/index.html new file mode 100644 index 0000000000..f183256ffb --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/alarms/clearall/index.html @@ -0,0 +1,57 @@ +--- +title: alarms.clearAll() +slug: Mozilla/Add-ons/WebExtensions/API/alarms/clearAll +tags: + - API + - Add-ons + - Extensions + - Méthode + - Non-standard + - Reference + - WebExtensions + - alarms + - clearAll +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/clearAll +--- +
{{AddonSidebar}}
+ +

Cette méthode supprime toutes les alarmes actives. C'est une fonction asynchrone qui renvoie une promesse {{jsxref("Promise")}}.

+ +

Syntaxe

+ +
var clearAlarms = browser.alarms.clearAll()
+
+ +

Paramètres

+ +

Aucun.

+ +

Valeur de retour

+ +

Une promesse ({{jsxref("Promise")}}) qui sera tenue avec une valeur booléenne. Ce dernier vaudra true si certaines alarmes ont bien été effacées et false sinon. On notera que Chrome renvoie toujours true.

+ +

Exemples

+ +
function onClearedAll(wasCleared) {
+  console.log(wasCleared);  // true/false
+}
+
+var clearAlarms = browser.alarms.clearAll();
+clearAlarms.then(onClearedAll);
+ +

{{WebExtExamples}}

+ +

 

+ +

Compatibilité des navigateurs

+ + + +

{{Compat("webextensions.api.alarms.clearAll")}}

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

+
diff --git a/files/fr/mozilla/add-ons/webextensions/api/alarms/create/index.html b/files/fr/mozilla/add-ons/webextensions/api/alarms/create/index.html new file mode 100644 index 0000000000..97b8a189af --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/alarms/create/index.html @@ -0,0 +1,105 @@ +--- +title: alarms.create() +slug: Mozilla/Add-ons/WebExtensions/API/alarms/create +tags: + - API + - Add-ons + - Créations + - Extensions + - Méthode + - Non-standard + - Reference + - WebExtensions + - alarms +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/create +--- +
{{AddonSidebar()}}
+ +

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{{optional_inline}}
+
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éthodes {{WebExtAPIRef('alarms.get()')}} et {{WebExtAPIRef('alarms.clear()')}}. Il sera également disponible pour {{WebExtAPIRef('alarms.onAlarm')}} sous la forme de la propriété name de l'objet {{WebExtAPIRef('alarms.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{{optional_inline}}
+
+

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 champ periodInMinutes.

+ +

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éfinir periodInMinutes 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{{optional_inline}}
+
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 utiliser {{jsxref("Date.now")}}. Si cette valeur est utilisée, il ne faut pas fournir delayInMinutes.
+
delayInMinutes{{optional_inline}}
+
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 fournir when.
+
periodInMinutes{{optional_inline}}
+
double. Si cette valeur est indiquée, l'alarme sera répétée périodiquement (toutes les periodInMinutes minutes) après le premier déclenchement. Si cette valeur est indiquée, il n'est pas obligatoire de fournir when ou delayInMinutes : l'alarme se déclenchera au bout de periodInMinutes. Si periodInMinutes 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é du navigateur

+ + + +

{{Compat("webextensions.api.alarms.create")}}

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

+
diff --git a/files/fr/mozilla/add-ons/webextensions/api/alarms/get/index.html b/files/fr/mozilla/add-ons/webextensions/api/alarms/get/index.html new file mode 100644 index 0000000000..95b27d40b2 --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/alarms/get/index.html @@ -0,0 +1,62 @@ +--- +title: alarms.get() +slug: Mozilla/Add-ons/WebExtensions/API/alarms/get +tags: + - API + - Add-ons + - Extensions + - Méthode + - Non-standard + - Reference + - WebExtensions + - alarms + - get +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/get +--- +
{{AddonSidebar}}
+ +

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

+ +

Syntaxe

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

Paramètres

+ +
+
name{{optional_inline}}
+
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 ({{jsxref("Promise")}}) qui sera tenue avec un objet {{WebExtAPIRef('alarms.Alarm', "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.

+ +

Exemples

+ +
function gotAlarm(alarm) {
+  if (alarm) {
+    console.log(alarm.name);
+  }
+}
+
+var getAlarm = browser.alarms.get("my-periodic-alarm");
+getAlarm.then(gotAlarm);
+ +

{{WebExtExamples}}

+ +

Compatibilité du navigateur

+ + + +

{{Compat("webextensions.api.alarms.get")}}

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

+
diff --git a/files/fr/mozilla/add-ons/webextensions/api/alarms/getall/index.html b/files/fr/mozilla/add-ons/webextensions/api/alarms/getall/index.html new file mode 100644 index 0000000000..eef00b26c2 --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/alarms/getall/index.html @@ -0,0 +1,63 @@ +--- +title: alarms.getAll() +slug: Mozilla/Add-ons/WebExtensions/API/alarms/getAll +tags: + - API + - Add-ons + - Extensions + - Méthode + - Non-standard + - Reference + - WebExtensions + - alarms + - getAll +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/getAll +--- +
{{AddonSidebar}}
+ +

Obtient toutes les alarmes actives pour le poste.

+ +

C'est une fonction asynchrone qui renvoie une Promise.

+ +

Syntaxe

+ +
var getAlarms = browser.alarms.getAll()
+
+ +

Paramètres

+ +

Aucun

+ +

Valeur de retour

+ +

Une Promise dont la valeur de résolution sera un tableau d'objets Alarm. Chaque élément de ce tableau représente une alarme active de l'extension. Si aucune alarme n'est active, le tableau sera vide.

+ +

Exemples

+ +
function gotAll(alarms) {
+  for (var alarm of alarms) {
+    console.log(alarm.name);
+  }
+}
+
+var getAlarms = browser.alarms.getAll();
+getAlarms.then(gotAll);
+ +

{{WebExtExamples}}

+ +

 

+ +

Compatibilité des navigateurs

+ + + +

{{Compat("webextensions.api.alarms.getAll")}}

+ +

 

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

+
diff --git a/files/fr/mozilla/add-ons/webextensions/api/alarms/index.html b/files/fr/mozilla/add-ons/webextensions/api/alarms/index.html new file mode 100644 index 0000000000..bb5388ccaa --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/alarms/index.html @@ -0,0 +1,60 @@ +--- +title: alarms +slug: Mozilla/Add-ons/WebExtensions/API/alarms +tags: + - API + - Besoins Privilèges + - Extensions + - Interface + - Reference + - WebExtensions + - alarms +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms +--- +
{{AddonSidebar}}
+ +

Programmer le code pour qu'il soit exécuté à un moment précis dans le futur. C'est comme setTimeout() and setInterval() sauf que ces fonctions ne fonctionnent pas avec les pages d'arrière-plan qui sont chargées à la demande. Les alarmes ne persistent pas d'une session à l'autre du navigateur

+ +

Pour pouvoir utiliser cette API, vous devez disposer de la permission "alarms".

+ +

Types

+ +
+
{{WebExtAPIRef("alarms.Alarm")}}
+
Ce type permet d'obtenir des informations à propos d'une alarme donnée.
+
+ +

Méthodes

+ +
+
{{WebExtAPIRef("alarms.create()")}}
+
Cette fonction permet de créer une nouvelle alarme.
+
{{WebExtAPIRef("alarms.get()")}}
+
Cette fonction permet de récupérer une alarme donnée en fonction de son nom.
+
{{WebExtAPIRef("alarms.getAll()")}}
+
Cette fonction permet de récupérer l'ensemble des alarmes qui sont planifiées.
+
{{WebExtAPIRef("alarms.clear()")}}
+
Cette fonction permet de supprimer une alarme donnée en fonction de son nom.
+
{{WebExtAPIRef("alarms.clearAll()")}}
+
Cette fonction permet de supprimer l'ensemble des alarmes qui sont planifiées.
+
+ +

Évènements

+ +
+
{{WebExtAPIRef("alarms.onAlarm")}}
+
Cet évènement est déclenché lorsque l'alarme s'éteint.
+
+ +

{{WebExtExamples("h2")}}

+ +

Compatibilité des navigateurs

+ +

{{Compat("webextensions.api.alarms")}}

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

+
diff --git a/files/fr/mozilla/add-ons/webextensions/api/alarms/onalarm/index.html b/files/fr/mozilla/add-ons/webextensions/api/alarms/onalarm/index.html new file mode 100644 index 0000000000..654714b328 --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/alarms/onalarm/index.html @@ -0,0 +1,88 @@ +--- +title: alarms.onAlarm +slug: Mozilla/Add-ons/WebExtensions/API/alarms/onAlarm +tags: + - API + - Add-ons + - Event + - Extensions + - Non-standard + - Reference + - WebExtensions + - alarms + - onAlarm +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/onAlarm +--- +
{{AddonSidebar}}
+ +

Cet évènement est déclenché lorsque l'alarme se déclenche.

+ +

Syntaxe

+ +
browser.alarms.onAlarm.addListener(listener)
+browser.alarms.onAlarm.removeListener(listener)
+browser.alarms.onAlarm.hasListener(listener)
+
+ +

Cet évènement possède trois méthodes :

+ +
+
addListener(listener)
+
Cette méthode ajoute un gestionnaire à l'évènement.
+
removeListener(listener)
+
Cette méthode retire le gestionnaire d'évènement passé en argument.
+
hasListener(listener)
+
Cette méthode permet de vérifier si le gestionnaire d'évènement passé en argument est enregistré : elle renvoie true s'il est déjà présent et false sinon.
+
+ +

Syntaxe addListener

+ +

Paramètres

+ +
+
listener
+
+

La fonction qui sera appelée lorsque l'événement se produira. La fonction recevra les arguments suivants :

+ +
+
alarm
+
{{WebExtAPIRef('alarms.Alarm')}}. L'alarme qui s'est déclenchée. La propriété Alarm.name pourra être utilisée afin de déterminer l'alarme qui s'est déclenchée.
+
+
+
+ +

Exemples

+ +

Voici un exemple illustrant ce qui se produit quand l'alarme se déclenche

+ +
function handleAlarm(alarmInfo) {
+  console.log("L'alarme " + alarmInfo.name + " s'est déclenchée");
+}
+
+browser.alarms.onAlarm.addListener(handleAlarm);
+ +

{{WebExtExamples}}

+ +

 

+ +
+
+
+
+
+
+ +

Compatibilité des navigateurs

+ + + +

{{Compat("webextensions.api.alarms.onAlarm")}}

+ +

 

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

+
-- cgit v1.2.3-54-g00ecf