Guía
Cómo usar Alarm en Capacitor
Uso de @capgo/capacitor-alarm
Interfaz del plugin Capacitor Alarm para gestionar alarmas del SO nativo.
Instalar
bun add @capgo/capacitor-alarm
bunx cap sync
bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.
Importar
import { CapgoAlarm } from '@capgo/capacitor-alarm';
API de un vistazo
| Método | Descripción |
|---|---|
createAlarm |
Crea una alarma nativa del SO usando la app de reloj de la plataforma. En Android usa el intent de Alarm Clock; en iOS usa AlarmKit si está disponible (iOS 16+). |
openAlarms |
Abre la UI nativa de la lista de alarmas de la plataforma, si está disponible. |
getOSInfo |
Obtén información sobre el SO y sus capacidades. |
requestPermissions |
Solicita los permisos necesarios para usar alarmas en la plataforma. En Android, puede redirigir a los ajustes para alarmas exactas. |
checkPermissions |
Comprueba el estado actual de los permisos para acceder a alarmas nativas sin mostrar ninguna UI. En iOS informa sobre la disponibilidad de AlarmKit; en Android informa sobre los detalles de capacidad. |
getAlarms |
Obtén una lista de las alarmas programadas por esta app. En iOS 26+, devuelve las alarmas de AlarmKit. En Android no es compatible, ya que el sistema no ofrece un API para consultar alarmas. |
cancelAlarm |
Cancela una alarma programada mediante su ID. En iOS 26+, elimina la alarma de AlarmKit. En Android/web, devuelve no compatible. |
Ejemplos
createAlarm()
Crea una alarma nativa del SO usando la app de reloj de la plataforma. En Android usa el intent de Alarm Clock; en iOS usa AlarmKit si está 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()
Abre la UI nativa de la lista de alarmas de la plataforma, si está disponible.
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const result = await CapgoAlarm.openAlarms();
if (result.success) {
console.log('Alarms UI opened');
}
getOSInfo()
Obtén información sobre el SO y sus capacidades.
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()
Solicita los permisos necesarios para usar alarmas en la plataforma. En Android, puede redirigir a los ajustes para alarmas exactas.
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()
Comprueba el estado actual de los permisos para acceder a alarmas nativas sin mostrar ninguna UI. En iOS informa sobre la disponibilidad de AlarmKit; en Android informa sobre los detalles de capacidad.
import { CapgoAlarm } from '@capgo/capacitor-alarm';
const status = await CapgoAlarm.checkPermissions();
console.log('AlarmKit allowed?', status.details?.alarmKit);
getAlarms()
Obtén una lista de las alarmas programadas por esta app. En iOS 26+, devuelve las alarmas de AlarmKit. En Android no es compatible, ya que el sistema no ofrece un API para consultar alarmas.
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 tabla anterior enumera los 7 métodos principales. Los helpers de versión y listeners, así como el contrato completo de cada método, están documentados en la repositorio GitHub.
Referencia completa
Continúa desde Using @capgo/capacitor-alarm
Si estás usando Uso de @capgo/capacitor-alarm para planificar el trabajo con plugins nativos, conéctalo con @capgo/capacitor-alarm para los detalles de implementación en @capgo/capacitor-alarm, Primeros pasos para los detalles de implementación en Primeros pasos, Directorio de plugins de Capgo para el flujo de trabajo del producto en Capgo Plugin Directory, Plugins de Capacitor por Capgo para los detalles de implementación en Capacitor Plugins de Capgo, y Añadir o actualizar plugins para los detalles de implementación al añadir o actualizar plugins.