aboutsummaryrefslogtreecommitdiff
path: root/files/fr/mozilla/add-ons/webextensions/api/alarms/onalarm/index.html
blob: 46742021b902bcdacb5d0cb6e4682b02280597d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
---
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
---
<div>{{AddonSidebar}}</div>

<p>Cet évènement est déclenché lorsque l'alarme se déclenche.</p>

<h2 id="Syntaxe">Syntaxe</h2>

<pre class="brush: js">browser.alarms.onAlarm.addListener(listener)
browser.alarms.onAlarm.removeListener(listener)
browser.alarms.onAlarm.hasListener(listener)
</pre>

<p>Cet évènement possède trois méthodes :</p>

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

<h2 id="Syntaxe_addListener">Syntaxe addListener</h2>

<h3 id="Paramètres">Paramètres</h3>

<dl>
 <dt><code>listener</code></dt>
 <dd>
 <p>La fonction qui sera appelée lorsque l'événement se produira. La fonction recevra les arguments suivants :</p>

 <dl>
  <dt><code>alarm</code></dt>
  <dd>{{WebExtAPIRef('alarms.Alarm')}}. L'alarme qui s'est déclenchée. La propriété <code>Alarm.name</code> pourra être utilisée afin de déterminer l'alarme qui s'est déclenchée.</dd>
 </dl>
 </dd>
</dl>

<h2 id="Exemples">Exemples</h2>

<p>Voici un exemple illustrant ce qui se produit quand l'alarme se déclenche</p>

<pre class="brush: js">function handleAlarm(alarmInfo) {
  console.log("L'alarme " + alarmInfo.name + " s'est déclenchée");
}

browser.alarms.onAlarm.addListener(handleAlarm);</pre>

<p>{{WebExtExamples}}</p>



<h2 id="Compatibilité_des_navigateurs">Compatibilité des navigateurs</h2>

<p>{{Compat("webextensions.api.alarms.onAlarm")}}</p>

<div class="note"><p><strong>Note :</strong></p>

<p>Cette API est basée sur l'API Chromium <a href="https://developer.chrome.com/extensions/alarms"><code>chrome.alarms</code></a>.</p>

<p>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.</p>
</div>