blob: 8cc905dda2bd0d39144b82acfbcb65aa1b667f39 (
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
|
---
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
---
<div>{{AddonSidebar}}</div>
<p>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")}}).</p>
<h2 id="Syntaxe">Syntaxe</h2>
<pre class="syntaxbox brush:js">var getAlarm = browser.alarms.get(
name // optional string
)
</pre>
<h3 id="Paramètres">Paramètres</h3>
<dl>
<dt><code>name</code>{{optional_inline}}</dt>
<dd><code><code>string</code></code>. 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 (<code>""</code>).</dd>
</dl>
<h3 id="Valeur_de_retour">Valeur de retour</h3>
<p>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 <code>name</code>. Si aucune alarme ne correspond, la valeur renvoyée sera <code>undefined</code>.</p>
<h2 id="Exemples">Exemples</h2>
<pre class="brush: js">function gotAlarm(alarm) {
if (alarm) {
console.log(alarm.name);
}
}
var getAlarm = browser.alarms.get("my-periodic-alarm");
getAlarm.then(gotAlarm);</pre>
<p>{{WebExtExamples}}</p>
<h2 id="Compatibilité_du_navigateur">Compatibilité du navigateur</h2>
<p>{{Compat("webextensions.api.alarms.get")}}</p>
<div class="note"><strong>Remerciements :</strong>
<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>
|
