aboutsummaryrefslogtreecommitdiff
path: root/files/ja/mozilla/add-ons/webextensions/api/alarms/get/index.html
blob: 500a3be7db2022fb5956f62b0a684547b4fd800e (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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
---
title: alarms.get()
slug: Mozilla/Add-ons/WebExtensions/API/alarms/get
tags:
  - API
  - Add-ons
  - Extensions
  - Method
  - Non-standard
  - Reference
  - WebExtensions
  - alarms
  - get
translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/get
---
<div>{{AddonSidebar()}}</div>

<p>与えた名前に対応するアラームを取得します。取得したアラームは、コールバック関数に渡す {{WebExtAPIRef('alarms.Alarm')}} オブジェクトとして用いることがあります。</p>

<h2 id="構文">構文</h2>

<pre class="brush: js">browser.alarms.get(
  name,                   // 文字列
  function(alarm) {...}   // 関数
)
</pre>

<h3 id="引数">引数</h3>

<dl>
 <dt><code>name</code>{{optional_inline}}</dt>
 <dd><code><code>string</code></code>. 取得したいアラームの名前を指定します。指定しなかった場合は空文字列 "" が用いられます。</dd>
 <dt><code>callback</code></dt>
 <dd><code>function</code>. この関数には以下の引数が渡ります。</dd>
 <dd>
 <dl class="reference-values">
  <dt><code>alarm</code></dt>
  <dd><code>{{WebExtAPIRef('alarms.Alarm')}}</code>. 名前が <code>name</code> にマッチするアラームが入ります。マッチするアラームがなかった場合、<code>undefined</code> が入ります。</dd>
 </dl>
 </dd>
</dl>

<h2 id="ブラウザ実装状況">ブラウザ実装状況</h2>

<p>{{ CompatibilityTable() }}</p>

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>機能</th>
   <th>Chrome</th>
   <th>Edge</th>
   <th>Firefox (Gecko)</th>
   <th>Opera</th>
  </tr>
  <tr>
   <td>基本サポート</td>
   <td>{{ CompatVersionUnknown }}</td>
   <td>{{ CompatUnknown }}</td>
   <td>{{ CompatGeckoDesktop('45.0') }}</td>
   <td>{{ CompatOpera('33') }}</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>機能</th>
   <th>Edge</th>
   <th>Firefox OS</th>
   <th>Firefox Mobile (Gecko)</th>
  </tr>
  <tr>
   <td>基本サポート</td>
   <td>{{ CompatNo() }}</td>
   <td>{{ CompatNo() }}</td>
   <td>{{ CompatNo() }}</td>
  </tr>
 </tbody>
</table>
</div>

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

<div class="note"><strong>謝辞</strong>

<p>この API は Chromium の <a href="https://developer.chrome.com/extensions/alarms"><code>chrome.alarms</code></a> API に基づいています。</p>
</div>