Commencer

##Installation

npm

npm install @capgo/capacitor-alarm
npx cap sync

yarn

yarn add @capgo/capacitor-alarm
npx cap sync

pnpm

pnpm add @capgo/capacitor-alarm
npx cap sync

bun

bun add @capgo/capacitor-alarm
npx cap sync

Exigences

• iOS : iOS 26+ uniquement. Ce plugin s’appuie sur les API AlarmKit et signalera les versions non prises en charge sur les versions antérieures ou lorsque le framework n’est pas disponible.
• Android : utilise les intentions AlarmClock ; le comportement dépend de l’application Clock par défaut et des politiques OEM.

Remarque : Ce plugin expose uniquement les actions d’alarme natives (créer/ouvrir). Il n’implémente aucune planification d’alarme/CRUD personnalisée dans l’application.

API

créer une alarme (…)

createAlarm(options: NativeAlarmCreateOptions) => Promise<NativeActionResult>

Créez une alarme native du système d’exploitation à l’aide de l’application d’horloge de la plateforme. Sur Android, cela utilise l’intention Réveil ; sur iOS, utilisez AlarmKit si disponible (iOS 26+).

Paramètres	Tapez
options	NativeAlarmCreateOptions

Retours : Promise<NativeActionResult>

ouvrirAlarms()

openAlarms() => Promise<NativeActionResult>

Ouvrez l’interface utilisateur de la liste d’alarmes native de la plateforme, si disponible.

Retours : Promise<NativeActionResult>

###getOSInfo()

getOSInfo() => Promise<OSInfo>

Obtenez des informations sur le système d’exploitation et ses fonctionnalités.

Retours : Promise<OSInfo>

requêtePermissions(…)

requestPermissions(options?: { exactAlarm?: boolean | undefined; } | undefined) => Promise<PermissionResult>

Demandez les autorisations pertinentes pour l’utilisation des alarmes sur la plateforme. Sur Android, peut être acheminé vers les paramètres d’alarmes exactes.

Paramètres	Tapez
options	{ exactAlarm?: boolean; }

Retours : Promise<PermissionResult>

##Interfaces

NativeActionRésultat

Accessoire	Tapez
success	boolean
message	string

NativeAlarmCreateOptions

Options pour créer une alarme native du système d’exploitation via l’application d’horloge de la plateforme.

Accessoire	Tapez	Descriptif
hour	number	Heure de la journée au format 24h (0-23)
minute	number	Minute d’heure (0-59)
label	string	Etiquette optionnelle pour l’alarme
skipUi	boolean	Android uniquement : essayez d’ignorer l’interface utilisateur si possible
vibrate	boolean	Android uniquement : régler l’alarme pour qu’elle vibre

OSInfo

Informations renvoyées sur le système d’exploitation actuel et ses capacités.| Accessoire | Tapez | Descriptif | | ------------------------------------ | -------------------- | ----------------------------------------------------------- | | platform | string | ‘iOS’ | ‘androïde’ | ‘Internet’ | | version | string | Chaîne de version du système d’exploitation | | supportsNativeAlarms | boolean | Si la plate-forme expose une intégration native d’application d’alarme | | supportsScheduledNotifications | boolean | Si la planification des notifications locales est prise en charge | | canScheduleExactAlarms | boolean | Android uniquement : si les alarmes exactes sont autorisées |

AutorisationRésultat

Résultat d’une demande d’autorisations.

Accessoire	Tapez	Descriptif
granted	boolean	Subvention globale pour le périmètre demandé
details	Record<string, boolean>	Détails facultatifs par clé d’autorisation