Démarrage

Installer

bun add @capgo/capacitor-alarm
bunx cap sync

Importer

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

API Vue d'ensemble

createAlarm

Créez un alarme native du système en utilisant l'application de l'horloge du système. Sur Android, cela utilise l'intent de l'alarme; sur iOS, cela utilise AlarmKit si disponible (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

Ouvrez la liste d'alarme native de la plateforme, si disponible.

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

const result = await CapgoAlarm.openAlarms();
if (result.success) {
  console.log('Alarms UI opened');
}

getOSInfo

Obtenez des informations sur le système d'exploitation et les capacités.

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

Demander les permissions pertinentes pour l'utilisation des alarmes sur la plateforme. Sur Android, peut rediriger vers les paramètres pour les alarmes exactes.

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

Vérifiez l'état actuel des permissions pour l'accès aux alarmes natives sans déclencher l'interface utilisateur. Sur iOS, cela signifie la disponibilité de AlarmKit ; sur Android, cela signifie les détails des capacités.

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

const status = await CapgoAlarm.checkPermissions();
console.log('AlarmKit allowed?', status.details?.alarmKit);

getAlarms

Get a list of alarms scheduled by this app. On iOS 26+, returns alarms from AlarmKit. On Android, this is not supported as the system does not provide an API to query alarms.

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

Référence de type

NativeAlarmCreateOptions

Options pour créer une alarme native via l'application d'horloge du système.

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

Résultat d'une action native.

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

OSInfo

Informations renvoyées sur le système actuel et ses capacités.

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

Résultat d'une demande de permission.

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

Informations sur une alarme planifiée.

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

Source de Vérité

Cette page est générée à partir du plugin. src/definitions.ts. Re-run the sync when the public API changes upstream.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier l'interface de bord et les opérations API, connectez-le à Utilisation de @capgo/capacitor-alarm pour la capacité native dans Utilisation de @capgo/capacitor-alarm, API Vue d'ensemble pour le détail d'implémentation dans API Vue d'ensemble, Introduction pour le détail d'implémentation dans Introduction, API Clés pour le détail d'implémentation dans API Clés, et Appareils pour le détail d'implémentation dans Appareils.