メインコンテンツにスキップ
Back to プラグイン
@capgo/capacitor-alarm
チュートリアル
@capgo/capacitor-alarm

アラーム

アプリが閉じても、スケジュールされたネイティブのアラームと通知を実行します。

ガイド

アラームのチュートリアル

デバイスでテスト

Download the Capgo app, then scan the QR code.

アラーム プラグイン プレビュー QR code

Using @capgo/capacitor-alarm

Capacitor アラーム プラグイン インターフェイス

インストール

bun add @capgo/capacitor-alarm
bunx cap sync

このプラグインが公開するもの

  • createAlarm - Android の場合は、Alarm Clock インテントを使用して、プラットフォームの時計アプリでアラームを作成します。iOS の場合は、AlarmKit を使用します (iOS 16 以降)。
  • openAlarms - プラットフォームのネイティブ アラーム リスト UI を開きます (利用可能な場合)。
  • getOSInfo - OS の情報と機能を取得します。
  • requestPermissions - アラームの使用に必要な権限を要求します。Android の場合は、正確なアラームのために設定にルーティングします。

使用例

createAlarm

プラットフォームの時計アプリでネイティブ OS アラームを作成します。Android の場合は、Alarm Clock インテントを使用します。iOS の場合は、AlarmKit を使用します (iOS 16 以降)。

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の場合、正確なアラームの設定にルーティングする場合があります。

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');
}

フルリファレンス

capgoから続けて@capgo/capacitor-alarmを使用します。

__CAPGO_KEEP_0__を使用している場合 @capgo/capacitor-alarmを使用して ネイティブプラグインの作業を計画する場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-alarmを接続します。 @capgo/capacitor-alarm 実装詳細については @capgo/capacitor-alarm に Getting Started 実装詳細については Getting Started に Capgo プラグイン ディレクトリ 実装詳細については Capgo プラグイン ディレクトリ に Capacitor プラグイン ( Capgo による) 実装詳細については Capacitor プラグイン ( Capgo による) に プラグインの追加または更新 実装詳細については プラグインの追加または更新 に