Getting Started

インストール

bun add @capgo/capacitor-alarm
bunx cap sync

インポート

import { CapgoAlarm } from '@capgo/capacitor-alarm';

API の概要

createAlarm

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

checkPermissions

ネイティブアラームへのアクセス権の現在の状態を確認します。 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}`);
});

型の参照

NativeAlarmCreateOptions

OSの時計アプリを使用してネイティブOSアラームを作成するためのオプションです。

export interface NativeAlarmCreateOptions {
  /** Hour of day in 24h format (0-23) */
  hour: number;
  /** Minute of hour (0-59) */
  minute: number;
  /** Optional label for the alarm */
  label?: string;
  /** Android only: attempt to skip UI if possible */
  skipUi?: boolean;
  /** Android only: set alarm to vibrate */
  vibrate?: boolean;
}

NativeActionResult

ネイティブアクションの結果です。

export interface NativeActionResult {
  /** Whether the action was successful */
  success: boolean;
  /** Optional message with additional information */
  message?: string;
}

OSInfo

現在のOSと機能に関する情報が返されます。

export interface OSInfo {
  /** Platform identifier: 'ios' | 'android' | 'web' */
  platform: string;
  /** OS version string */
  version: string;
  /** Whether the platform exposes a native alarm app integration */
  supportsNativeAlarms: boolean;
  /** Whether scheduling local notifications is supported */
  supportsScheduledNotifications: boolean;
  /** Android only: whether exact alarms are allowed */
  canScheduleExactAlarms?: boolean;
}

PermissionResult

許可の要求の結果です。

export interface PermissionResult {
  /** Overall grant for requested scope */
  granted: boolean;
  /** Optional details by permission key */
  details?: Record<string, boolean>;
  /** Optional human readable diagnostic */
  message?: string;
}

AlarmInfo

予定のアラームに関する情報です。

export interface AlarmInfo {
  /** Unique identifier for the alarm */
  id: string;
  /** Hour of day in 24h format (0-23) */
  hour: number;
  /** Minute of hour (0-59) */
  minute: number;
  /** Optional label for the alarm */
  label?: string;
  /** Whether the alarm is enabled */
  enabled?: boolean;
}

真実の源

このページはプラグインの src/definitions.ts. 公開 API がアップストリームで変更されたときは、再度同期を実行してください。

始めてから続けてください

「Getting Started」を使用している場合 「Getting Started」 APIと連携するには、ダッシュボードとAPIの操作を計画するために capgo/capacitor-alarmを使用する capgo/capacitor-alarmのネイティブ機能について APIの概要 APIの実装詳細について 導入 導入の実装詳細について APIのキー APIのキーに関する実装詳細について デバイス デバイスの実装詳細について