ガイド
Capacitor で Alarm を使用する方法
@capgo/capacitor-alarm の使用
ネイティブOSのアラームを管理するための Capacitor Alarm Plugin インターフェース。
インストール
bun add @capgo/capacitor-alarm
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { CapgoAlarm } from '@capgo/capacitor-alarm';
API の概要
| メソッド | 説明 |
|---|---|
createAlarm |
プラットフォームの時計アプリを使って、ネイティブOSのアラームを作成します。AndroidではAlarm Clock intentを使用し、iOSでは利用可能な場合（iOS 16以降）AlarmKitを使用します。 |
openAlarms |
利用可能な場合、プラットフォームのネイティブなアラーム一覧UIを開きます。 |
getOSInfo |
OSとその機能に関する情報を取得します。 |
requestPermissions |
プラットフォームでアラームを使用するための関連権限をリクエストします。Androidでは、exact alarms の設定画面へ遷移する場合があります。 |
checkPermissions |
UIを表示せずに、ネイティブアラームへのアクセス権限の現在の状態を確認します。iOSではAlarmKitの準備状況を、Androidでは機能の詳細を返します。 |
getAlarms |
このアプリがスケジュールしたアラームの一覧を取得します。iOS 26以降ではAlarmKitからアラームを返します。Androidでは、システムがアラームを照会するための API を提供していないため、サポートされていません。 |
cancelAlarm |
スケジュール済みのアラームをIDでキャンセルします。iOS 26以降ではAlarmKitからアラームを削除します。Android/webでは、not supported を返します。 |
例
createAlarm()
プラットフォームの時計アプリを使って、ネイティブOSのアラームを作成します。AndroidではAlarm Clock intentを使用し、iOSでは利用可能な場合（iOS 16以降）AlarmKitを使用します。
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const result = await CapgoAlarm.createAlarm({
hour: 7,
minute: 30,
label: 'Wake up',
skipUi: false,
vibrate: true
});
console.log('Alarm created:', result.success);
openAlarms()
利用可能な場合、プラットフォームのネイティブなアラーム一覧UIを開きます。
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const result = await CapgoAlarm.openAlarms();
if (result.success) {
console.log('Alarms UI opened');
}
getOSInfo()
OSとその機能に関する情報を取得します。
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const info = await CapgoAlarm.getOSInfo();
console.log('Platform:', info.platform);
console.log('Supports native alarms:', info.supportsNativeAlarms);
if (info.platform === 'android') {
console.log('Can schedule exact alarms:', info.canScheduleExactAlarms);
}
requestPermissions()
プラットフォームでアラームを使用するための関連権限をリクエストします。Androidでは、exact alarms の設定画面へ遷移する場合があります。
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const result = await CapgoAlarm.requestPermissions({ exactAlarm: true });
if (result.granted) {
console.log('Permissions granted');
} else {
console.log('Permissions denied');
}
checkPermissions()
UIを表示せずに、ネイティブアラームへのアクセス権限の現在の状態を確認します。iOSではAlarmKitの準備状況を、Androidでは機能の詳細を返します。
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const status = await CapgoAlarm.checkPermissions();
console.log('AlarmKit allowed?', status.details?.alarmKit);
getAlarms()
このアプリがスケジュールしたアラームの一覧を取得します。iOS 26以降ではAlarmKitからアラームを返します。Androidでは、システムがアラームを照会するための API を提供していないため、サポートされていません。
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const { alarms } = await CapgoAlarm.getAlarms();
console.log('Scheduled alarms:', alarms);
alarms.forEach(alarm => {
console.log(`Alarm ${alarm.id}: ${alarm.hour}:${alarm.minute} - ${alarm.label}`);
});
上記の表には7つのコアメソッドが記載されています。リスナーやバージョンのヘルパー、および各メソッドの詳細な仕様については、以下に記載されています。 GitHub リポジトリ.
完全なリファレンス
「@capgo/capacitor-alarm の使用」から続ける
使用している場合 @capgo/capacitor-alarm の使用 ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-alarm @capgo/capacitor-alarm の実装の詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。