説明
chrome.alarms API を使用して、コードを定期的に実行するか、将来の指定した時間に実行するようにスケジュールします。
権限
alarmschrome.alarms API を使用するには、マニフェストで "alarms" 権限を宣言します。
{
"name": "My extension",
...
"permissions": [
"alarms"
],
...
}
コンセプトと使用方法
信頼性の高い動作を確保するには、API の動作を理解することが重要です。
デバイスのスリープ
デバイスがスリープ状態でもアラームは実行され続けます。ただし、アラームによってデバイスがスリープ解除されることはありません。デバイスがスリープ解除されると、トリガーされなかったアラームがトリガーされます。反復アラームは 1 回だけトリガーされ、デバイスがスリープ解除された時点から指定された期間で再スケジュールされます。アラームが最初に実行されるように設定されてから経過した時間は考慮されません。
永続性
アラームの永続性は、作成時に persistAcrossSessions フラグを使用して制御できます。これは true（拡張機能が更新されるまで保持される）または false（拡張機能が再読み込みされるか、ブラウザが再起動されるたびにクリアされ、拡張機能が更新されるたびにクリアされる）に設定できます。
他のブラウザと以前のバージョンの Chrome
このプロパティは、他のブラウザ（問題）や Chrome 150 より前のバージョンの Chrome では対象外です。これらの環境では、動作が予測不能になる可能性があります。したがって、Service Worker が起動するたびに重要なアラームが存在することを確認することをおすすめします。次に例を示します。
async function checkAlarmState() {
const alarm = await chrome.alarms.get("my-alarm");
if (!alarm) {
await chrome.alarms.create("my-alarm", { periodInMinutes: 1 });
}
}
checkAlarmState();
アラームがユーザー アクションに基づいて動的に作成される場合は、アラームが作成されたことを別の場所に保存して、必要に応じて再作成できるようにします。
例
次の例は、アラームの使用方法とアラームへの応答方法を示しています。この API を試すには、chrome-extension-samples リポジトリから Alarm API の例をインストールしてください。
アラームを設定する
次の例では、拡張機能の新しいバージョンがインストールされたときに、Service Worker でアラームを設定します。
service-worker.js:
chrome.runtime.onInstalled.addListener(async ({ reason }) => {
// Create an alarm so we have something to look at in the demo
await chrome.alarms.create('demo-default-alarm', {
delayInMinutes: 1,
periodInMinutes: 1,
persistAcrossSessions: true
});
});
アラームに対応する
次の例では、アラームが鳴った名前に基づいてアクション ツールバー アイコンを設定します。
service-worker.js:
chrome.alarms.onAlarm.addListener((alarm) => {
chrome.action.setIcon({
path: getIconPath(alarm.name),
});
});
型
Alarm
プロパティ
-
name
文字列
このアラームの名前。
-
periodInMinutes
number 省略可
null でない場合、アラームは繰り返しアラームであり、
periodInMinutes分後に再びトリガーされます。 -
persistAcrossSessions
ブール値
保留中アラームをセッション（ブラウザの再起動）をまたいで維持するかどうか。
-
scheduledTime
数値
このアラームが発火するようにスケジュールされた時刻（エポックからのミリ秒単位、例:
Date.now() + n）。パフォーマンス上の理由から、アラームはこれを超えて任意の量だけ遅延している可能性があります。
AlarmCreateInfo
プロパティ
-
delayInMinutes
number 省略可
onAlarmイベントを発生させるまでの時間（分単位）。 -
periodInMinutes
number 省略可
設定されている場合、onAlarm イベントは、
whenまたはdelayInMinutesで指定された最初のイベントのperiodInMinutes分ごとに発生します。設定しない場合、アラームは 1 回だけ発動します。 -
persistAcrossSessions
ブール値（省略可）
保留中アラームをセッション（ブラウザの再起動）間で保持するかどうか。Chrome では、過去の動作に合わせてデフォルトで true になっていますが、ブラウザ間の互換性を最大限に高めるために、明示的に設定する必要があります。
-
いつ
number 省略可
アラームを起動する日時をエポックからの経過時間（ミリ秒単位）で指定します（例:
Date.now() + n）。
メソッド
clear()
chrome.alarms.clear(
name?: string,
): Promise<boolean>
指定された名前のアラームをクリアします。
パラメータ
-
name
文字列 省略可
クリアするアラームの名前。デフォルトは空の文字列です。
戻り値
-
Promise<boolean>
Chrome 91 以降
clearAll()
chrome.alarms.clearAll(): Promise<boolean>
すべてのアラームを消去します。
戻り値
-
Promise<boolean>
Chrome 91 以降
create()
chrome.alarms.create(
name?: string,
alarmInfo: AlarmCreateInfo,
): Promise<void>
アラームを作成します。alarmInfo で指定された時刻の近くになると、onAlarm イベントが起動します。同じ名前のアラーム（名前が指定されていない場合は名前なし）がすでに存在する場合は、そのアラームはキャンセルされ、このアラームに置き換えられます。
ユーザーのマシンの負荷を軽減するため、Chrome はアラームを 30 秒に 1 回以下に制限しますが、任意に遅延させることもあります。つまり、delayInMinutes または periodInMinutes を 0.5 より小さい値に設定しても、その値は反映されず、警告が発生します。when は警告なしで「現在」から 30 秒未満に設定できますが、実際にはアラームは少なくとも 30 秒間トリガーされません。
アプリや拡張機能のデバッグを支援するため、パッケージ化されていない状態で読み込んだ場合、アラームの起動回数に制限はありません。
パラメータ
-
name
文字列 省略可
このアラームを識別するための名前（省略可）。デフォルトは空の文字列です。
-
alarmInfo
アラームを起動するタイミングを説明します。初期時刻は
whenまたはdelayInMinutesのいずれかで指定する必要があります（両方は不可）。periodInMinutesが設定されている場合、アラームは最初のイベントの後にperiodInMinutes分ごとに繰り返されます。繰り返しアラームにwhenとdelayInMinutesのどちらも設定されていない場合、periodInMinutesがdelayInMinutesのデフォルトとして使用されます。
戻り値
-
Promise<void>
Chrome 111 以降アラームが作成されたときに解決される Promise。
パラメータ
-
name
文字列 省略可
取得するアラームの名前。デフォルトは空の文字列です。
戻り値
-
Promise<Alarm | undefined>
Chrome 91 以降
戻り値
-
Promise<Alarm[]>
Chrome 91 以降