Guide
Comment utiliser Alarm dans Capacitor
Utiliser @capgo/capacitor-alarm
L'interface du plugin Capacitor Alarm pour gérer les alarmes natives de l'OS.
Installer
bun add @capgo/capacitor-alarm
bunx cap sync
bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.
Importer
import { CapgoAlarm } from '@capgo/capacitor-alarm';
Aperçu de API
| Méthode | Description |
|---|---|
createAlarm |
Créez une alarme native via l'application horloge de la plateforme. Sur Android, cela utilise l'intent Alarm Clock ; sur iOS, cela utilise AlarmKit si disponible (iOS 16+). |
openAlarms |
Ouvrez l'interface native de la liste des alarmes de la plateforme, si disponible. |
getOSInfo |
Récupérez des informations sur l'OS et ses capacités. |
requestPermissions |
Demandez les permissions nécessaires pour l'utilisation des alarmes sur la plateforme. Sur Android, cela peut rediriger vers les paramètres pour les alarmes exactes. |
checkPermissions |
Vérifiez l'état actuel des permissions pour l'accès aux alarmes natives sans déclencher d'interface. Sur iOS, cela indique la disponibilité d'AlarmKit ; sur Android, cela indique les détails des capacités. |
getAlarms |
Récupérez la liste des alarmes programmées par cette application. Sur iOS 26+, renvoie les alarmes d'AlarmKit. Sur Android, ce n'est pas pris en charge car le système ne fournit pas de API pour interroger les alarmes. |
cancelAlarm |
Annulez une alarme programmée via son ID. Sur iOS 26+, supprime l'alarme d'AlarmKit. Sur Android/web, renvoie une erreur « non pris en charge ». |
Exemples
createAlarm()
Créez une alarme native via l'application horloge de la plateforme. Sur Android, cela utilise l'intent Alarm Clock ; 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 l'interface native de la liste des alarmes 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()
Récupérez des informations sur l'OS 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()
Demandez les permissions nécessaires pour l'utilisation des alarmes sur la plateforme. Sur Android, cela 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 d'interface. Sur iOS, cela indique la disponibilité d'AlarmKit ; sur Android, cela indique 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()
Récupérez la liste des alarmes programmées par cette application. Sur iOS 26+, renvoie les alarmes d'AlarmKit. Sur Android, ce n'est pas pris en charge car le système ne fournit pas de API pour interroger les alarmes.
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}`);
});
Le tableau ci-dessus liste les 7 méthodes principales. Les helpers pour les listeners et les versions, ainsi que le contrat complet de chaque méthode, sont documentés dans la dépôt GitHub.
Référence complète
Continuer après l'utilisation de @capgo/capacitor-alarm
Si vous utilisez Utilisation de @capgo/capacitor-alarm pour planifier le travail sur les plugins natifs, 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 Getting Started Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans les plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Adding or Updating Plugins.