Empezar

Instalar

bun add @capgo/capacitor-alarm
bunx cap sync

Importar

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

Resumen de API

createAlarm

Crea 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

Abre la lista de alarma nativa del sistema UI, 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 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

Solicita permisos relevantes para el uso de alarma en el sistema. 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 el acceso a alarmas nativas sin desencadenar la interfaz de usuario. En iOS, esto informa la disponibilidad de AlarmKit; en Android, informa 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}`);
});

Referencia de tipos

NativeAlarmCreateOptions

Opciones para crear una alarma nativa OS mediante la aplicación de reloj del sistema.

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

Resultado de una acción nativa.

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

OSInfo

Información devuelta sobre el sistema operativo actual y capacidades.

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

Resultado de una solicitud de permisos.

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

Información sobre un alarma programada.

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

Fuente de Verdad

Esta página se genera desde el plugin’s src/definitions.tsRe-ejecutar la sincronización cuando los archivos públicos API cambien en la fuente.