aboutsummaryrefslogtreecommitdiff
path: root/files/fr/mozilla/add-ons/webextensions/api/alarms/onalarm/index.md
blob: 6a1f2af6c528787a171b9aa9ea33cd5557578800 (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
---
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

```js
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

```js
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")}}

> **Note :**
>
> Cette API est basée sur l'API Chromium [`chrome.alarms`](https://developer.chrome.com/extensions/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.