Saltar al contenido principal
@capgo/capacitor-alarma Dispositivos de API Fuente abierta

Alarmas plugin de Capacitor

Programar alarmas y notificaciones nativas incluso cuando la aplicación está cerrada

Instalar

bun add @capgo/capacitor-alarm bunx cap sync
npm, pnpm o yarn
  • npm install @capgo/capacitor-alarm
  • pnpm add @capgo/capacitor-alarm
  • yarn add @capgo/capacitor-alarm

Guía

Cómo usar Alarm en Capacitor

Probar en dispositivo

Descargue la aplicación Capgo, luego escane el código QR code.

Vista previa del plugin de alarma QR code

Usando @capgo/capacitor-alarm

Interface del plugin de Alarmas Capacitor para gestionar alarmas nativas del sistema.

Instalar

bun add @capgo/capacitor-alarm
bunx cap sync

bunx cap sync Copia el código nativo del plugin code en tus proyectos nativos. Correlo nuevamente después de cada actualización del plugin.

Importar

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

Vista general de API

Método Descripción
createAlarm Crear un alarma nativa del sistema utilizando la aplicación de reloj del sistema. En Android, utiliza la intención de la Alarma; en iOS, utiliza AlarmKit si está disponible (iOS 16+).
openAlarms Abrir la lista de alarmas nativas del sistema, si está disponible.
getOSInfo Obtener información sobre el sistema y sus capacidades.
requestPermissions Solicitar permisos relevantes para el uso de alarmas en el sistema. En Android, puede redirigir a ajustes para alarmas exactas.
checkPermissions Verifique el estado de permiso actual para acceso a alarmas nativas sin desencadenar la interfaz de usuario. En iOS, informa sobre la disponibilidad de AlarmKit; en Android, proporciona detalles de capacidad.
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.
cancelAlarm Cancelar una alarma programada por su ID. En iOS 26+, elimina la alarma de AlarmKit. En Android/web, devuelve no soportado.

Ejemplos

createAlarm()

Crear un alarma nativa del sistema utilizando la aplicación de reloj del sistema. En Android, utiliza la intención de la Alarma; en iOS, utiliza 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()

Abrir la lista de alarmas nativas del sistema, si está disponible.

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

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

getOSInfo()

Obtener información sobre el sistema 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()

Solicite permisos relevantes para el uso de la alarma en la plataforma. En Android, puede redirigir a 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()

Verifique el estado de permiso actual para acceso a alarmas nativas sin desencadenar la interfaz de usuario. En iOS, informa sobre la disponibilidad de AlarmKit; en Android, proporciona detalles de capacidad.

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

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

getAlarms()

Obtenga una lista de alarmas programadas por esta aplicación. En iOS 26+, devuelve alarmas de AlarmKit. En Android, esto no está soportado ya que el sistema no proporciona 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 básicos. Los ayudantes de escucha y versión, y el contrato completo de cada método, se documentan en el repositorio GitHub.

Referencia completa

Sigue adelante desde Usando @capgo/capacitor-alarma

Si está utilizando Usando @capgo/capacitor-alarma para planificar el trabajo de plugin nativo, conecte con @capgo/capacitor-alarma para los detalles de implementación en @capgo/capacitor-alarma, Getting Started para los detalles de implementación en Inicio, Directorio de Plugins de Capgo para el flujo de trabajo del producto en el directorio de plugins Capgo Plugins de Capacitor por Capgo para los detalles de implementación en Plugins de Capacitor por Capgo, y Agregar o Actualizar Plugins para los detalles de implementación en Agregar o Actualizar Plugins.

FAQ

FAQ del plugin de alarmas

Cómo instalo el plugin de alarmas en una aplicación Capacitor?

Ejecuta "bun add @capgo/capacitor-alarma" (o "npm install @capgo/capacitor-alarma"), luego ejecuta "bunx cap sync" para que los proyectos iOS y Android capturen el code nativo. Importa desde "@capgo/capacitor-alarma" en tu aplicación code.

¿Funciona @capgo/capacitor-alarm con React, Vue y Angular?

Sí. Alarm es un paquete Capacitor, por lo que funciona con cualquier framework web que se ejecute dentro de Capacitor, incluyendo Ionic, React, Vue, Angular, Svelte y JavaScript puro.

¿Qué versión de Capacitor soporta @capgo/capacitor-alarm?

Los plugins Capgo siguen la versión mayor de Capacitor: utilice la versión mayor del plugin que coincida con la versión mayor de Capacitor (por ejemplo, plugin v8 con Capacitor 8). La tabla de compatibilidad en el README de GitHub lista las versiones mantenidas.

¿Es @capgo/capacitor-alarm gratuito y de código abierto?

Sí. El código fuente de code está disponible en GitHub en https://github.com/Cap-go/capacitor-alarm/ y el paquete es gratuito para instalar desde npm. Se aceptan informes de errores y solicitudes de cambios.

¿Puedo actualizar code que utiliza Alarm sin una revisión de la Tienda?

Instalar o actualizar el plugin cambia el code nativo, por lo que necesita una nueva compilación de la tienda. Después de eso, los cambios en JavaScript, HTML y CSS que llaman al plugin pueden enviar directamente con Capgo actualizaciones en vivo.

Enviar cambios de Alarmas sin esperar a la revisión del app

Una vez que el plugin esté en tu tienda de construcción, Capgo actualizaciones en vivo envían los cambios de JavaScript, HTML y CSS a los usuarios en minutos.

Comienza con Capgo