diff options
author | Peter Bengtsson <mail@peterbe.com> | 2020-12-08 14:40:17 -0500 |
---|---|---|
committer | Peter Bengtsson <mail@peterbe.com> | 2020-12-08 14:40:17 -0500 |
commit | 33058f2b292b3a581333bdfb21b8f671898c5060 (patch) | |
tree | 51c3e392513ec574331b2d3f85c394445ea803c6 /files/ja/mozilla/add-ons/webextensions/api/alarms | |
parent | 8b66d724f7caf0157093fb09cfec8fbd0c6ad50a (diff) | |
download | translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.tar.gz translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.tar.bz2 translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.zip |
initial commit
Diffstat (limited to 'files/ja/mozilla/add-ons/webextensions/api/alarms')
8 files changed, 710 insertions, 0 deletions
diff --git a/files/ja/mozilla/add-ons/webextensions/api/alarms/alarm/index.html b/files/ja/mozilla/add-ons/webextensions/api/alarms/alarm/index.html new file mode 100644 index 0000000000..0d57999f01 --- /dev/null +++ b/files/ja/mozilla/add-ons/webextensions/api/alarms/alarm/index.html @@ -0,0 +1,84 @@ +--- +title: alarms.Alarm +slug: Mozilla/Add-ons/WebExtensions/API/alarms/Alarm +tags: + - API + - Add-ons + - Extensions + - Non-standard + - Reference + - Type + - WebExtensions + - alarm + - alarms +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/Alarm +--- +<div>{{AddonSidebar()}}</div> + +<p>単一のアラームに関する情報を含みます。このオブジェクトは {{WebExtAPIRef('alarms.get()')}} や {{WebExtAPIRef('alarms.getAll()')}} の戻り値として返されます。また、{{WebExtAPIRef('alarms.onAlarm')}} リスナに渡されることもあります。</p> + +<h2 id="値の型">値の型</h2> + +<p>この値の型はオブジェクトであり、以下のプロパティを含みます。</p> + +<dl class="reference-values"> + <dt><code>name</code></dt> + <dd><code>string</code>. アラームの名前(このアラームを生成した {{WebExtAPIRef('alarms.create()')}} の呼び出し時に渡された名前)を表します。</dd> + <dt><code>scheduledTime</code></dt> + <dd><code>double</code>. 次にアラームが発火する時刻(<a href="https://ja.wikipedia.org/wiki/UNIX%E6%99%82%E9%96%93">1970 年 1 月 1 日からの経過ミリ秒</a>)を表します。</dd> + <dt><code>periodInMinutes</code>{{optional_inline}}</dt> + <dd><code>double</code>. この値が <code>null</code> ではない場合、アラームが発火する周期を分単位で表します。</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> + <p>基本サポート</p> + </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> diff --git a/files/ja/mozilla/add-ons/webextensions/api/alarms/clear/index.html b/files/ja/mozilla/add-ons/webextensions/api/alarms/clear/index.html new file mode 100644 index 0000000000..e4ddafb425 --- /dev/null +++ b/files/ja/mozilla/add-ons/webextensions/api/alarms/clear/index.html @@ -0,0 +1,92 @@ +--- +title: alarms.clear() +slug: Mozilla/Add-ons/WebExtensions/API/alarms/clear +tags: + - API + - Add-ons + - Extensions + - Method + - Non-standard + - Reference + - WebExtensions + - alarms + - clear +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/clear +--- +<div>{{AddonSidebar()}}</div> + +<p>与えた名前に対応するアラームを解除します。</p> + +<h2 id="Syntax">Syntax</h2> + +<pre class="brush: js">browser.alarms.clear( + name, // 文字列 + function(wasCleared) {...} // 関数 +) +</pre> + +<h3 id="引数">引数</h3> + +<dl> + <dt><code>name</code>{{optional_inline}}</dt> + <dd><code><code>string</code></code>. 解除したいアラームの名前を指定します。指定しなかった場合は空文字列 "" が用いられます。</dd> + <dt><code>callback</code>{{optional_inline}}</dt> + <dd><code>function</code>. この関数には以下の引数が渡されます。</dd> + <dd> + <dl class="reference-values"> + <dt><code>wasCleared</code></dt> + <dd><code>boolean</code>. アラームが解除された場合は <code>true</code> が、それ以外の場合は <code>false</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> diff --git a/files/ja/mozilla/add-ons/webextensions/api/alarms/clearall/index.html b/files/ja/mozilla/add-ons/webextensions/api/alarms/clearall/index.html new file mode 100644 index 0000000000..889a71b697 --- /dev/null +++ b/files/ja/mozilla/add-ons/webextensions/api/alarms/clearall/index.html @@ -0,0 +1,89 @@ +--- +title: alarms.clearAll() +slug: Mozilla/Add-ons/WebExtensions/API/alarms/clearAll +tags: + - API + - Add-ons + - Extensions + - Method + - Non-standard + - Reference + - WebExtensions + - alarms + - clearAll +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/clearAll +--- +<div>{{AddonSidebar()}}</div> + +<p>予約されたアラームすべてを解除します。</p> + +<h2 id="構文">構文</h2> + +<pre class="brush: js">browser.alarms.clearAll( + function(wasCleared) {...} // 関数 +) +</pre> + +<h3 id="引数">引数</h3> + +<dl> + <dt><code>callback</code></dt> + <dd><code>function</code>. この関数には以下の引数が渡ります。</dd> + <dd> + <dl class="reference-values"> + <dt><code>wasCleared</code></dt> + <dd><code>boolean</code>. アラームが解除された場合は <code>true</code> が、それ以外の場合は <code>false</code> が入ります。Chrome の場合は常に <code>true</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> diff --git a/files/ja/mozilla/add-ons/webextensions/api/alarms/create/index.html b/files/ja/mozilla/add-ons/webextensions/api/alarms/create/index.html new file mode 100644 index 0000000000..d95d778d6d --- /dev/null +++ b/files/ja/mozilla/add-ons/webextensions/api/alarms/create/index.html @@ -0,0 +1,125 @@ +--- +title: alarms.create() +slug: Mozilla/Add-ons/WebExtensions/API/alarms/create +tags: + - API + - Add-ons + - Create + - Extensions + - Method + - Non-standard + - Reference + - WebExtensions + - alarms +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/create +--- +<div>{{AddonSidebar()}}</div> + +<p>新しいアラームを生成します。</p> + +<h2 id="構文">構文</h2> + +<pre class="brush: js">browser.alarms.create( + name, // 文字列 + alarmInfo // オブジェクト +) +</pre> + +<h3 id="引数">引数</h3> + +<dl> + <dt><code>name</code>{{optional_inline}}</dt> + <dd><code>string</code>. アラームの名前を指定します。デフォルト値は空の文字列です。</dd> + <dd>この値は {{WebExtAPIRef('alarms.get()')}} や {{WebExtAPIRef('alarms.clear()')}} で特定のアラームを参照する際に用います。また、{{WebExtAPIRef('alarms.onAlarm')}} のリスナ関数に渡すオブジェクト {{WebExtAPIRef('alarms.Alarm')}} のプロパティ <code>name</code> からも参照されます。</dd> + <dd>アラームの名前は常に固有です(スコープはアドオンごとに区切られます)。以前そのアドオンが作成したアラーム名に一致する文字列を <code>name</code> に与えた場合、既存のアラームは削除されて発火しなくなります。</dd> + <dt><code>alarmInfo</code>{{optional_inline}}</dt> + <dd> + <p><code>object</code>. アラームが最初に発火する時刻を指定する引数です。時刻の指定には絶対値(<code>when</code> プロパティ)か、アラーム設定時を基準とした時間(<code>delayInMinutes</code> プロパティ)のどちらかで指定します。アラームを周期的に発火させるには <code>periodInMinutes</code> プロパティも指定します。</p> + + <p>Chrome の場合、パッケージ化された状態でアドオンが読み込まれると、アラームを 1 分に 1 回以上の頻度で呼び出すことはできません。ここでアドオンが <code>delayInMinutes</code> や <code>when</code> に 1 未満の値を指定しようとすると、アラームは 1 分後に発火します。アドオンが <code>periodInMinutes</code> に 1 未満の値を指定した場合、アラームは 1 分おきに発火します。</p> + + <p><code>alarmInfo</code> オブジェクトで指定できるプロパティは以下の通りです。</p> + </dd> + <dd> + <dl class="reference-values"> + <dt><code>when</code>{{optional_inline}}</dt> + <dd><code>double</code>. アラームが最初に発火する時刻を <a href="https://ja.wikipedia.org/wiki/UNIX%E6%99%82%E9%96%93">1970 年 1 月 1 日からの経過ミリ秒</a> で指定します。現在までの経過ミリ秒は <code><a href="/ja/docs/Web/JavaScript/Reference/Global_Objects/Date/now">Date.now()</a></code> で取得できます。<code>when</code> を指定した場合<code>は delayInMinutes</code> を指定しないでください。</dd> + <dt><code>delayInMinutes</code>{{optional_inline}}</dt> + <dd><code>double</code>. アラームが最初に発火する時刻を、アラーム設定時から何分後かで指定します。 <code>delayInMinutes</code> を指定した場合は <code>when</code> を指定しないでください。</dd> + <dt><code>periodInMinutes</code>{{optional_inline}}</dt> + <dd><code>double</code>. この値が指定された場合、アラームは最初の発火時刻から <code>periodInMinutes</code> の周期で繰り返し発火します。この値を指定したうえで<code>when</code> と <code>delayInMinutes</code> の両方を省略した場合、最初にアラームが発火するのは <code>periodInMinutes</code> の時間が経過した後になります。<code>periodInMinutes</code> が指定されなければ、アラームは一度だけ発火します。</dd> + </dl> + </dd> +</dl> + +<h2 id="ブラウザ実装状況">ブラウザ実装状況</h2> + +<p>{{Compat("webextensions.api.alarms.create")}}</p> + +<h2 id="例">例</h2> + +<p>現在から相対的な時刻で一度限り発火するアラームを "" という名前で作成する例:</p> + +<pre class="brush: js line-numbers language-js"><code class="language-js"><span class="keyword token">const</span> delayInMinutes <span class="operator token">=</span> <span class="number token">5</span><span class="punctuation token">;</span> + +chrome<span class="punctuation token">.</span>alarms<span class="punctuation token">.</span><span class="function token">create</span><span class="punctuation token">(</span><span class="punctuation token">{</span> + delayInMinutes +<span class="punctuation token">}</span><span class="punctuation token">)</span><span class="punctuation token">;</span></code></pre> + +<p>現在からの相対的な時刻から繰り返すアラームを "my-periodic-alarm" の名前で作成する例:</p> + +<pre class="brush: js line-numbers language-js"><code class="language-js"><span class="keyword token">const</span> delayInMinutes <span class="operator token">=</span> <span class="number token">5</span><span class="punctuation token">;</span> +<span class="keyword token">const</span> periodInMinutes <span class="operator token">=</span> <span class="number token">2</span><span class="punctuation token">;</span> + +chrome<span class="punctuation token">.</span>alarms<span class="punctuation token">.</span><span class="function token">create</span><span class="punctuation token">(</span><span class="string token">"my-periodic-alarm"</span><span class="punctuation token">,</span> <span class="punctuation token">{</span> + delayInMinutes<span class="punctuation token">,</span> + periodInMinutes +<span class="punctuation token">}</span><span class="punctuation token">)</span><span class="punctuation token">;</span></code></pre> + +<p>絶対的な時刻から繰り返すアラームを "my-periodic-alarm" の名前で作成する例:</p> + +<pre class="brush: js line-numbers language-js"><code class="language-js"><span class="keyword token">const</span> when <span class="operator token">=</span> <span class="number token">1545696000</span><span class="punctuation token">;</span> +<span class="keyword token">const</span> periodInMinutes <span class="operator token">=</span> <span class="number token">2</span><span class="punctuation token">;</span> + +chrome<span class="punctuation token">.</span>alarms<span class="punctuation token">.</span><span class="function token">create</span><span class="punctuation token">(</span><span class="string token">"my-periodic-alarm"</span><span class="punctuation token">,</span> <span class="punctuation token">{</span> + when<span class="punctuation token">,</span> + periodInMinutes +<span class="punctuation token">}</span><span class="punctuation token">)</span><span class="punctuation token">;</span></code></pre> + +<div class="note"><strong>謝辞</strong> + +<p>この API は Chromium の <a href="https://developer.chrome.com/extensions/alarms"><code>chrome.alarms</code></a> API に基づいています。</p> + +<p>Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。</p> +</div> + +<div class="hidden"> +<pre>// Copyright 2015 The Chromium Authors. All rights reserved. +// +// Redistribution and use in source and binary forms, with or without +// modification, are permitted provided that the following conditions are +// met: +// +// * Redistributions of source code must retain the above copyright +// notice, this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above +// copyright notice, this list of conditions and the following disclaimer +// in the documentation and/or other materials provided with the +// distribution. +// * Neither the name of Google Inc. nor the names of its +// contributors may be used to endorse or promote products derived from +// this software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +</pre> +</div> diff --git a/files/ja/mozilla/add-ons/webextensions/api/alarms/get/index.html b/files/ja/mozilla/add-ons/webextensions/api/alarms/get/index.html new file mode 100644 index 0000000000..500a3be7db --- /dev/null +++ b/files/ja/mozilla/add-ons/webextensions/api/alarms/get/index.html @@ -0,0 +1,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> diff --git a/files/ja/mozilla/add-ons/webextensions/api/alarms/getall/index.html b/files/ja/mozilla/add-ons/webextensions/api/alarms/getall/index.html new file mode 100644 index 0000000000..a7d8a3759b --- /dev/null +++ b/files/ja/mozilla/add-ons/webextensions/api/alarms/getall/index.html @@ -0,0 +1,73 @@ +--- +title: alarms.getAll() +slug: Mozilla/Add-ons/WebExtensions/API/alarms/getAll +tags: + - API + - Add-ons + - Extensions + - Method + - Non-standard + - Reference + - WebExtensions + - alarms + - getAll +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms/getAll +--- +<div>{{AddonSidebar()}}</div> + +<p>予約されたアラームすべてを取得します。取得されたアラームは {{WebExtAPIRef('alarms.Alarm')}} オブジェクトの配列としてコールバック関数に渡されます。</p> + +<h2 id="構文">構文</h2> + +<pre class="brush: js">browser.alarms.getAll( + function(array) {...} // 関数 +) +</pre> + +<h3 id="引数">引数</h3> + +<dl> + <dt><code>callback</code></dt> + <dd><code>function</code>. この関数には以下の引数が渡ります。</dd> + <dd> + <dl class="reference-values"> + <dt><code>alarms</code></dt> + <dd>予約されたアラームすべてを含む <code>{{WebExtAPIRef('alarms.Alarm')}}</code> の配列です。予約されたアラームがない場合は空の配列となります。</dd> + </dl> + </dd> +</dl> + +<h2 id="ブラウザ実装状況">ブラウザ実装状況</h2> + +<p>{{Compat("webextensions.api.alarms.getAll")}}</p> + +<h2 id="例">例</h2> + +<p>コールバックを用いた例:</p> + +<pre class="brush: js line-numbers language-js"><code class="language-js"><span class="keyword token">function</span> <span class="function token">gotAll</span><span class="punctuation token">(</span>alarms<span class="punctuation token">)</span> <span class="punctuation token">{</span> + <span class="keyword token">for</span> <span class="punctuation token">(</span><span class="keyword token">var</span> alarm <span class="keyword token">of</span> alarms<span class="punctuation token">)</span> <span class="punctuation token">{</span> + console<span class="punctuation token">.</span><span class="function token">log</span><span class="punctuation token">(</span>alarm<span class="punctuation token">.</span>name<span class="punctuation token">)</span><span class="punctuation token">;</span> + <span class="punctuation token">}</span> +<span class="punctuation token">}</span> + +chrome<span class="punctuation token">.</span>alarms<span class="punctuation token">.</span><span class="function token">getAll</span><span class="punctuation token">(</span>gotAll<span class="punctuation token">)</span><span class="punctuation token">;</span></code></pre> + +<p>Promise を用いた例:</p> + +<pre class="brush: js line-numbers language-js"><code class="language-js"><span class="keyword token">function</span> <span class="function token">gotAll</span><span class="punctuation token">(</span>alarms<span class="punctuation token">)</span> <span class="punctuation token">{</span> + <span class="keyword token">for</span> <span class="punctuation token">(</span><span class="keyword token">var</span> alarm <span class="keyword token">of</span> alarms<span class="punctuation token">)</span> <span class="punctuation token">{</span> + console<span class="punctuation token">.</span><span class="function token">log</span><span class="punctuation token">(</span>alarm<span class="punctuation token">.</span>name<span class="punctuation token">)</span><span class="punctuation token">;</span> + <span class="punctuation token">}</span> +<span class="punctuation token">}</span> + +<span class="keyword token">var</span> getAlarms <span class="operator token">=</span> browser<span class="punctuation token">.</span>alarms<span class="punctuation token">.</span><span class="function token">getAll</span><span class="punctuation token">(</span><span class="punctuation token">)</span><span class="punctuation token">;</span> +getAlarms<span class="punctuation token">.</span><span class="function token">then</span><span class="punctuation token">(</span>gotAll<span class="punctuation token">)</span><span class="punctuation token">;</span></code></pre> + +<p>{{WebExtExamples}}</p> + +<div class="note"> +<p><strong>謝辞</strong></p> + +<p>この API はChromium の <a href="https://developer.chrome.com/extensions/alarms"><code>chrome.alarms</code></a> API に基づいています。</p> +</div> diff --git a/files/ja/mozilla/add-ons/webextensions/api/alarms/index.html b/files/ja/mozilla/add-ons/webextensions/api/alarms/index.html new file mode 100644 index 0000000000..3f37d24473 --- /dev/null +++ b/files/ja/mozilla/add-ons/webextensions/api/alarms/index.html @@ -0,0 +1,50 @@ +--- +title: alarms +slug: Mozilla/Add-ons/WebExtensions/API/alarms +translation_of: Mozilla/Add-ons/WebExtensions/API/alarms +--- +<div>{{AddonSidebar}}</div> + +<p>コードが動作するタイミングを予約します。この API は <code><a href="https://developer.mozilla.org/ja/docs/Web/API/WindowTimers/setTimeout">setTimeout()</a></code> や <code><a href="https://developer.mozilla.org/ja/docs/Web/API/WindowTimers/setInterval">setInterval()</a></code> と似ていますが、 alarms API はバックグラウンドで動作する点が異なります。</p> + +<p>この API を利用するには "alarms" <a href="/ja/docs/Mozilla/Add-ons/WebExtensions/manifest.json/permissions">パーミッション</a> が必要です。</p> + +<h2 id="関連する値の型">関連する値の型</h2> + +<dl> + <dt>{{WebExtAPIRef("alarms.Alarm")}}</dt> + <dd>特定のアラームに関する情報が含まれます。</dd> +</dl> + +<h2 id="メソッド">メソッド</h2> + +<dl> + <dt>{{WebExtAPIRef("alarms.create()")}}</dt> + <dd>新しいアラームを生成します。</dd> + <dt>{{WebExtAPIRef("alarms.get()")}}</dt> + <dd>与えた名前に対応するアラームを取得します。</dd> + <dt>{{WebExtAPIRef("alarms.getAll()")}}</dt> + <dd>予約されたアラームすべてを取得します。</dd> + <dt>{{WebExtAPIRef("alarms.clear()")}}</dt> + <dd>与えた名前に対応するアラームを解除します。</dd> + <dt>{{WebExtAPIRef("alarms.clearAll()")}}</dt> + <dd>予約されたアラームすべてを解除します。</dd> +</dl> + +<h2 id="イベント">イベント</h2> + +<dl> + <dt>{{WebExtAPIRef("alarms.onAlarm")}}</dt> + <dd>アラームが動作した際に発火します。</dd> +</dl> + +<h2 id="ブラウザ実装状況">ブラウザ実装状況</h2> + +<p>{{Compat("webextensions.api.alarms")}} {{WebExtExamples("h2")}}</p> + +<div class="note"><strong>謝辞</strong> + +<p>この API は Chromium の <a href="https://developer.chrome.com/extensions/alarms"><code>chrome.alarms</code></a> API に基づいています。</p> + +<p>Microsoft Edge の実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。</p> +</div> diff --git a/files/ja/mozilla/add-ons/webextensions/api/alarms/onalarm/index.html b/files/ja/mozilla/add-ons/webextensions/api/alarms/onalarm/index.html new file mode 100644 index 0000000000..fec4fd491a --- /dev/null +++ b/files/ja/mozilla/add-ons/webextensions/api/alarms/onalarm/index.html @@ -0,0 +1,105 @@ +--- +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>アドオンによってアラームが動作した際に発火します。</p> + +<h2 id="構文">構文</h2> + +<pre class="brush: js">browser.alarms.onAlarm.addListener(function( + alarm // Alarm +) {...}) +browser.alarms.onAlarm.removeListener(listener) +browser.alarms.onAlarm.hasListener(listener) +</pre> + +<p>このイベントには 3 つのメソッドが用意されています。</p> + +<dl> + <dt><code>addListener(callback)</code></dt> + <dd>イベントリスナを追加します。</dd> + <dt><code>removeListener(listener)</code></dt> + <dd>イベントリスナを削除します。引数 <code>listener</code> には削除したいリスナを指定します。</dd> + <dt><code>hasListener(listener)</code></dt> + <dd><code>listener</code> がイベントリスナとして登録されているか確認します。登録されていれば <code>true</code> を、それ以外の場合は <code>false</code> を返します。</dd> +</dl> + +<h2 id="addListener_の構文">addListener の構文</h2> + +<h3 id="引数">引数</h3> + +<dl> + <dt><code>callback</code></dt> + <dd> + <p>このイベントが発火した際に呼び出される関数を指定します。この関数には以下の引数が渡ります。</p> + + <dl class="reference-values"> + <dt><code>alarm</code></dt> + <dd>発火するアラーム {{WebExtAPIRef('alarms.Alarm')}} が入ります。発火したアラームを判別するには <code>Alarm.name</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> |