Iniziare

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-alarm`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/it/docs/plugins/alarm/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installazione

npm install @capgo/capacitor-alarm
npx cap sync

yarn add @capgo/capacitor-alarm
npx cap sync

pnpm add @capgo/capacitor-alarm
npx cap sync

bun add @capgo/capacitor-alarm
npx cap sync

Requisiti

iOS: Solo iOS 26+. Questo plugin si basa sulle API AlarmKit e segnalerà come non supportato su versioni precedenti o quando il framework non è disponibile.
Android: Utilizza intent AlarmClock; il comportamento dipende dall’app Orologio predefinita e dalle politiche OEM.

Nota: Questo plugin espone solo azioni di allarme native (crea/apri). Non implementa alcuna pianificazione/CRUD personalizzata di allarmi in-app.

API

createAlarm(…)

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

Crea un allarme nativo del sistema operativo utilizzando l’app orologio della piattaforma. Su Android utilizza l’intent Alarm Clock; su iOS utilizza AlarmKit se disponibile (iOS 26+).

Param	Type
`options`	`NativeAlarmCreateOptions`

Restituisce: Promise<NativeActionResult>

openAlarms()

openAlarms() => Promise<NativeActionResult>

Apre l’interfaccia nativa della lista degli allarmi della piattaforma, se disponibile.

Restituisce: Promise<NativeActionResult>

getOSInfo()

getOSInfo() => Promise<OSInfo>

Ottieni informazioni sul sistema operativo e le sue capacità.

Restituisce: Promise<OSInfo>

requestPermissions(…)

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

Richiedi i permessi pertinenti per l’uso degli allarmi sulla piattaforma. Su Android, può indirizzare alle impostazioni per gli allarmi esatti.

Param	Type
`options`	`{ exactAlarm?: boolean; }`

Restituisce: Promise<PermissionResult>

Interfacce

NativeActionResult

Prop	Type
`success`	`boolean`
`message`	`string`

NativeAlarmCreateOptions

Opzioni per creare un allarme nativo del sistema operativo tramite l’app orologio della piattaforma.

Prop	Type	Description
`hour`	`number`	Ora del giorno in formato 24h (0-23)
`minute`	`number`	Minuto dell’ora (0-59)
`label`	`string`	Etichetta opzionale per l’allarme
`skipUi`	`boolean`	Solo Android: tenta di saltare l’UI se possibile
`vibrate`	`boolean`	Solo Android: imposta l’allarme per vibrare

OSInfo

Informazioni restituite sul sistema operativo corrente e le sue capacità.

Prop	Type	Description
`platform`	`string`	’ios’ \| ‘android’ \| ‘web’
`version`	`string`	Stringa versione del sistema operativo
`supportsNativeAlarms`	`boolean`	Se la piattaforma espone un’integrazione con l’app allarmi nativa
`supportsScheduledNotifications`	`boolean`	Se la pianificazione delle notifiche locali è supportata
`canScheduleExactAlarms`	`boolean`	Solo Android: se gli allarmi esatti sono consentiti

PermissionResult

Risultato di una richiesta di permessi.

Prop	Type	Description
`granted`	`boolean`	Concessione complessiva per l’ambito richiesto
`details`	`Record<string, boolean>`	Dettagli opzionali per chiave di permesso