From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- .../webextensions/api/alarms/alarm/index.html | 84 ++++++++++++++ .../webextensions/api/alarms/clear/index.html | 92 +++++++++++++++ .../webextensions/api/alarms/clearall/index.html | 89 +++++++++++++++ .../webextensions/api/alarms/create/index.html | 125 +++++++++++++++++++++ .../webextensions/api/alarms/get/index.html | 92 +++++++++++++++ .../webextensions/api/alarms/getall/index.html | 73 ++++++++++++ .../add-ons/webextensions/api/alarms/index.html | 50 +++++++++ .../webextensions/api/alarms/onalarm/index.html | 105 +++++++++++++++++ 8 files changed, 710 insertions(+) create mode 100644 files/ja/mozilla/add-ons/webextensions/api/alarms/alarm/index.html create mode 100644 files/ja/mozilla/add-ons/webextensions/api/alarms/clear/index.html create mode 100644 files/ja/mozilla/add-ons/webextensions/api/alarms/clearall/index.html create mode 100644 files/ja/mozilla/add-ons/webextensions/api/alarms/create/index.html create mode 100644 files/ja/mozilla/add-ons/webextensions/api/alarms/get/index.html create mode 100644 files/ja/mozilla/add-ons/webextensions/api/alarms/getall/index.html create mode 100644 files/ja/mozilla/add-ons/webextensions/api/alarms/index.html create mode 100644 files/ja/mozilla/add-ons/webextensions/api/alarms/onalarm/index.html (limited to 'files/ja/mozilla/add-ons/webextensions/api/alarms') 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 +--- +
{{AddonSidebar()}}
+ +

単一のアラームに関する情報を含みます。このオブジェクトは {{WebExtAPIRef('alarms.get()')}} や {{WebExtAPIRef('alarms.getAll()')}} の戻り値として返されます。また、{{WebExtAPIRef('alarms.onAlarm')}} リスナに渡されることもあります。

+ +

値の型

+ +

この値の型はオブジェクトであり、以下のプロパティを含みます。

+ +
+
name
+
string. アラームの名前（このアラームを生成した {{WebExtAPIRef('alarms.create()')}} の呼び出し時に渡された名前）を表します。
+
scheduledTime
+
double. 次にアラームが発火する時刻（1970 年 1 月 1 日からの経過ミリ秒）を表します。
+
periodInMinutes{{optional_inline}}
+
double. この値が null ではない場合、アラームが発火する周期を分単位で表します。
+
+ +

ブラウザ実装状況

+ +

{{ CompatibilityTable() }}

+ +
+ + + + + + + + + + + + + + + + + +
機能ChromeEdgeFirefox (Gecko)Opera
基本サポート{{ CompatVersionUnknown }}{{ CompatUnknown }}{{ CompatGeckoDesktop('45.0') }}{{ CompatOpera('33') }}
+
+ +
+ + + + + + + + + + + + + + + +
機能EdgeFirefox OSFirefox Mobile (Gecko)
+

基本サポート

+ 		{{ CompatNo() }}{{ CompatNo() }}{{ CompatNo() }}
+
+ +

{{WebExtExamples}}

+ +
謝辞 + +

この API は Chromium の chrome.alarms API に基づいています。

+
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 +--- +
{{AddonSidebar()}}
+ +

与えた名前に対応するアラームを解除します。

+ +

Syntax

+ +
browser.alarms.clear(
+  name,                        // 文字列
+  function(wasCleared) {...}   // 関数
+)
+
+ +

引数

+ +
+
name{{optional_inline}}
+
string. 解除したいアラームの名前を指定します。指定しなかった場合は空文字列 "" が用いられます。
+
callback{{optional_inline}}
+
function. この関数には以下の引数が渡されます。
+
+
+
wasCleared
+
boolean. アラームが解除された場合は true が、それ以外の場合は false が入ります。
+
+
+
+ +

ブラウザ実装状況

+ +

{{ CompatibilityTable() }}

+ +
+ + + + + + + + + + + + + + + + + +
機能ChromeEdgeFirefox (Gecko)Opera
基本サポート{{ CompatVersionUnknown }}{{ CompatUnknown }}{{ CompatGeckoDesktop('45.0') }}{{ CompatOpera('33') }}
+
+ +
+ + + + + + + + + + + + + + + +
機能EdgeFirefox OSFirefox Mobile (Gecko)
基本サポート{{ CompatNo() }}{{ CompatNo() }}{{ CompatNo() }}
+
+ +

{{WebExtExamples}}

+ +
謝辞 + +

この API は Chromium の chrome.alarms API に基づいています。

+
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 +--- +
{{AddonSidebar()}}
+ +

予約されたアラームすべてを解除します。

+ +

構文

+ +
browser.alarms.clearAll(
+  function(wasCleared) {...}   // 関数
+)
+
+ +

引数

+ +
+
callback
+
function. この関数には以下の引数が渡ります。
+
+
+
wasCleared
+
boolean. アラームが解除された場合は true が、それ以外の場合は false が入ります。Chrome の場合は常に true が入ることに注意してください。
+
+
+
+ +

ブラウザ実装状況

+ +

{{ CompatibilityTable() }}

+ +
+ + + + + + + + + + + + + + + + + +
機能ChromeEdgeFirefox (Gecko)Opera
基本サポート{{ CompatVersionUnknown }}{{ CompatUnknown }}{{ CompatGeckoDesktop('45.0') }}{{ CompatOpera('33') }}
+
+ +
+ + + + + + + + + + + + + + + +
機能EdgeFirefox OSFirefox Mobile (Gecko)
基本サポート{{ CompatNo() }}{{ CompatNo() }}{{ CompatNo() }}
+
+ +

{{WebExtExamples}}

+ +
謝辞 + +

この API は Chromium の chrome.alarms API に基づいています。

+
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 +--- +
{{AddonSidebar()}}
+ +

新しいアラームを生成します。

+ +

構文

+ +
browser.alarms.create(
+  name,              // 文字列
+  alarmInfo          // オブジェクト
+)
+
+ +

引数

+ +
+
name{{optional_inline}}
+
string. アラームの名前を指定します。デフォルト値は空の文字列です。
+
この値は {{WebExtAPIRef('alarms.get()')}} や {{WebExtAPIRef('alarms.clear()')}} で特定のアラームを参照する際に用います。また、{{WebExtAPIRef('alarms.onAlarm')}} のリスナ関数に渡すオブジェクト {{WebExtAPIRef('alarms.Alarm')}} のプロパティ name からも参照されます。
+
アラームの名前は常に固有です（スコープはアドオンごとに区切られます）。以前そのアドオンが作成したアラーム名に一致する文字列を name に与えた場合、既存のアラームは削除されて発火しなくなります。
+
alarmInfo{{optional_inline}}
+
+

object. アラームが最初に発火する時刻を指定する引数です。時刻の指定には絶対値（when プロパティ）か、アラーム設定時を基準とした時間（delayInMinutes プロパティ）のどちらかで指定します。アラームを周期的に発火させるには periodInMinutes プロパティも指定します。

+ +

Chrome の場合、パッケージ化された状態でアドオンが読み込まれると、アラームを 1 分に 1 回以上の頻度で呼び出すことはできません。ここでアドオンが delayInMinutes や when に 1 未満の値を指定しようとすると、アラームは 1 分後に発火します。アドオンが periodInMinutes に 1 未満の値を指定した場合、アラームは 1 分おきに発火します。

+ +

alarmInfo オブジェクトで指定できるプロパティは以下の通りです。

+
+
+
+
when{{optional_inline}}
+
double. アラームが最初に発火する時刻を 1970 年 1 月 1 日からの経過ミリ秒 で指定します。現在までの経過ミリ秒は Date.now() で取得できます。when を指定した場合は delayInMinutes を指定しないでください。
+
delayInMinutes{{optional_inline}}
+
double. アラームが最初に発火する時刻を、アラーム設定時から何分後かで指定します。 delayInMinutes を指定した場合は when を指定しないでください。
+
periodInMinutes{{optional_inline}}
+
double. この値が指定された場合、アラームは最初の発火時刻から periodInMinutes の周期で繰り返し発火します。この値を指定したうえでwhen と delayInMinutes の両方を省略した場合、最初にアラームが発火するのは periodInMinutes の時間が経過した後になります。periodInMinutes が指定されなければ、アラームは一度だけ発火します。
+
+
+
+ +

ブラウザ実装状況

+ +

{{Compat("webextensions.api.alarms.create")}}

+ +

例

+ +

現在から相対的な時刻で一度限り発火するアラームを "" という名前で作成する例：

+ +
const delayInMinutes = 5;
+
+chrome.alarms.create({
+  delayInMinutes
+});
+ +

現在からの相対的な時刻から繰り返すアラームを "my-periodic-alarm" の名前で作成する例：

+ +
const delayInMinutes = 5;
+const periodInMinutes = 2;
+
+chrome.alarms.create("my-periodic-alarm", {
+  delayInMinutes,
+  periodInMinutes
+});
+ +

絶対的な時刻から繰り返すアラームを "my-periodic-alarm" の名前で作成する例：

+ +
const when = 1545696000;
+const periodInMinutes = 2;
+
+chrome.alarms.create("my-periodic-alarm", {
+  when,
+  periodInMinutes
+});
+ +
謝辞 + +

この API は Chromium の chrome.alarms API に基づいています。

+ +

Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。

+
+ + 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 +--- +
{{AddonSidebar()}}
+ +

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

+ +

構文

+ +
browser.alarms.get(
+  name,                   // 文字列
+  function(alarm) {...}   // 関数
+)
+
+ +

引数

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

ブラウザ実装状況

+ +

{{ CompatibilityTable() }}

+ +
+ + + + + + + + + + + + + + + + + +
機能ChromeEdgeFirefox (Gecko)Opera
基本サポート{{ CompatVersionUnknown }}{{ CompatUnknown }}{{ CompatGeckoDesktop('45.0') }}{{ CompatOpera('33') }}
+
+ +
+ + + + + + + + + + + + + + + +
機能EdgeFirefox OSFirefox Mobile (Gecko)
基本サポート{{ CompatNo() }}{{ CompatNo() }}{{ CompatNo() }}
+
+ +

{{WebExtExamples}}

+ +
謝辞 + +

この API は Chromium の chrome.alarms API に基づいています。

+
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 +--- +
{{AddonSidebar()}}
+ +

予約されたアラームすべてを取得します。取得されたアラームは {{WebExtAPIRef('alarms.Alarm')}} オブジェクトの配列としてコールバック関数に渡されます。

+ +

構文

+ +
browser.alarms.getAll(
+  function(array) {...}   // 関数
+)
+
+ +

引数

+ +
+
callback
+
function. この関数には以下の引数が渡ります。
+
+
+
alarms
+
予約されたアラームすべてを含む {{WebExtAPIRef('alarms.Alarm')}} の配列です。予約されたアラームがない場合は空の配列となります。
+
+
+
+ +

ブラウザ実装状況

+ +

{{Compat("webextensions.api.alarms.getAll")}}

+ +

例

+ +

コールバックを用いた例：

+ +
function gotAll(alarms) {
+  for (var alarm of alarms) {
+    console.log(alarm.name);
+  }
+}
+
+chrome.alarms.getAll(gotAll);
+ +

Promise を用いた例：

+ +
function gotAll(alarms) {
+  for (var alarm of alarms) {
+    console.log(alarm.name);
+  }
+}
+
+var getAlarms = browser.alarms.getAll();
+getAlarms.then(gotAll);
+ +

{{WebExtExamples}}

+ +
+

謝辞

+ +

この API はChromium の chrome.alarms API に基づいています。

+
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 +--- +
{{AddonSidebar}}
+ +

コードが動作するタイミングを予約します。この API は setTimeout() や setInterval() と似ていますが、 alarms API はバックグラウンドで動作する点が異なります。

+ +

この API を利用するには "alarms" パーミッション が必要です。

+ +

関連する値の型

+ +
+
{{WebExtAPIRef("alarms.Alarm")}}
+
特定のアラームに関する情報が含まれます。
+
+ +

メソッド

+ +
+
{{WebExtAPIRef("alarms.create()")}}
+
新しいアラームを生成します。
+
{{WebExtAPIRef("alarms.get()")}}
+
与えた名前に対応するアラームを取得します。
+
{{WebExtAPIRef("alarms.getAll()")}}
+
予約されたアラームすべてを取得します。
+
{{WebExtAPIRef("alarms.clear()")}}
+
与えた名前に対応するアラームを解除します。
+
{{WebExtAPIRef("alarms.clearAll()")}}
+
予約されたアラームすべてを解除します。
+
+ +

イベント

+ +
+
{{WebExtAPIRef("alarms.onAlarm")}}
+
アラームが動作した際に発火します。
+
+ +

ブラウザ実装状況

+ +

{{Compat("webextensions.api.alarms")}} {{WebExtExamples("h2")}}

+ +
謝辞 + +

この API は Chromium の chrome.alarms API に基づいています。

+ +

Microsoft Edge の実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。

+
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 +--- +
{{AddonSidebar()}}
+ +

アドオンによってアラームが動作した際に発火します。

+ +

構文

+ +
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 が利用できます。
+
+
+
+ +

ブラウザ実装状況

+ +

{{ CompatibilityTable() }}

+ +
+ + + + + + + + + + + + + + + + + +
機能ChromeEdgeFirefox (Gecko)Opera
基本サポート{{ CompatVersionUnknown }}{{ CompatUnknown }}{{ CompatGeckoDesktop('45.0') }}{{ CompatOpera('33') }}
+
+ +
+ + + + + + + + + + + + + + + +
機能EdgeFirefox OSFirefox Mobile (Gecko)
基本サポート{{ CompatNo() }}{{ CompatNo() }}{{ CompatNo() }}
+
+ +

{{WebExtExamples}}

+ +
謝辞 + +

この API は Chromium の chrome.alarms API に基づいています。

+
-- cgit v1.2.3-54-g00ecf