/
index.md
46 lines (31 loc) · 1.43 KB
/
index.md
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
---
title: alarms.onAlarm
slug: Mozilla/Add-ons/WebExtensions/API/alarms/onAlarm
---
{{AddonSidebar}}
アドオンによってアラームが動作した際に発火します。
## 構文
```js
browser.alarms.onAlarm.addListener(function(
alarm // Alarm
) {...})
browser.alarms.onAlarm.removeListener(listener)
browser.alarms.onAlarm.hasListener(listener)
```
このイベントには 3 つのメソッドが用意されています。
- `addListener(callback)`
- : イベントリスナを追加します。
- `removeListener(listener)`
- : イベントリスナを削除します。引数 `listener` には削除したいリスナを指定します。
- `hasListener(listener)`
- : `listener` がイベントリスナとして登録されているか確認します。登録されていれば `true` を、それ以外の場合は `false` を返します。
## addListener の構文
### 引数
- `callback`
- : このイベントが発火した際に呼び出される関数を指定します。この関数には以下の引数が渡ります。
- `alarm`
- : 発火するアラーム {{WebExtAPIRef('alarms.Alarm')}} が入ります。発火したアラームを判別するには `Alarm.name` が利用できます。
## ブラウザーの互換性
{{Compat}}
{{WebExtExamples}}
> **メモ:** この API は Chromium の [`chrome.alarms`](https://developer.chrome.com/extensions/alarms) API に基づいています。