Alarme plugin Capacitor

Utilisation de @capgo/capacitor-alarm

Interface du plugin Capacitor Alarm pour gérer les alarmes OS natives.

Installer

bun add @capgo/capacitor-alarm
bunx cap sync

bunx cap sync copie le code natif du plugin code dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à jour du plugin.

Importer

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

API en un coup d'œil

Exemples

createAlarm()

Créez un alarme native à l'aide de l'application 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 du système, 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 et ses 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 de l'alarme sur la plateforme. Sur Android, peut rediriger vers les paramètres pour les alarmes précises.

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 de permission actuel pour l'accès à l'alarme native sans déclencher l'interface utilisateur. Sur iOS, cela signale la disponibilité d'AlarmKit ; sur Android, cela signale les détails de la capacité.

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

La table ci-dessus liste les 7 méthodes de base. Les helpers de listener et de version, ainsi que la pleine convention de chaque méthode, sont documentés dans le répertoire GitHub.

Référence complète

• répertoire GitHub
• Documentation
• Référence de API

Continuez à partir de l'utilisation de @capgo/capacitor-alarm

Continuez à partir de l'utilisation de @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-alarm Utiliser @capgo/capacitor-alarm pour planifier le travail de plugin natif, connectez-l’à @capgo/capacitor-alarm pour les détails d'implémentation dans @capgo/capacitor-alarm, Prise en main pour les détails d'implémentation dans Prise en main, Répertoire des plugins Capgo pour le flux de travail du produit dans Répertoire des plugins Capgo, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajouter ou mettre à jour des plugins.