Erste Schritte

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

Anforderungen

• iOS: Nur iOS 26+. Dieses Plugin basiert auf AlarmKit-APIs und meldet auf früheren Versionen oder wenn das Framework nicht verfügbar ist “nicht unterstützt”.
• Android: Verwendet AlarmClock-Intents; das Verhalten hängt von der Standard-Uhr-App und den OEM-Richtlinien ab.

Hinweis: Dieses Plugin stellt nur native Alarmaktionen (erstellen/öffnen) bereit. Es implementiert keine benutzerdefinierte In-App-Alarmplanung/CRUD.

API

createAlarm(…)

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

Erstellen Sie einen nativen OS-Alarm mit der Plattform-Uhr-App. Auf Android verwendet dies den Alarm Clock Intent; auf iOS verwendet dies AlarmKit, falls verfügbar (iOS 26+).

Parameter	Typ
options	NativeAlarmCreateOptions

Rückgabe: Promise<NativeActionResult>

openAlarms()

openAlarms() => Promise<NativeActionResult>

Öffnen Sie die native Alarmlisten-UI der Plattform, falls verfügbar.

Rückgabe: Promise<NativeActionResult>

getOSInfo()

getOSInfo() => Promise<OSInfo>

Informationen über das Betriebssystem und die Funktionen abrufen.

Rückgabe: Promise<OSInfo>

requestPermissions(…)

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

Relevante Berechtigungen für die Alarmnutzung auf der Plattform anfordern. Auf Android kann dies zu den Einstellungen für exakte Alarme führen.

Parameter	Typ
options	{ exactAlarm?: boolean; }

Rückgabe: Promise<PermissionResult>

Schnittstellen

NativeActionResult

Eigenschaft	Typ
success	boolean
message	string

NativeAlarmCreateOptions

Optionen zum Erstellen eines nativen OS-Alarms über die Plattform-Uhr-App.

Eigenschaft	Typ	Beschreibung
hour	number	Stunde des Tages im 24-Stunden-Format (0-23)
minute	number	Minute der Stunde (0-59)
label	string	Optionale Beschriftung für den Alarm
skipUi	boolean	Nur Android: UI überspringen, wenn möglich
vibrate	boolean	Nur Android: Alarm auf Vibration setzen

OSInfo

Zurückgegebene Informationen über das aktuelle Betriebssystem und die Funktionen.

Eigenschaft	Typ	Beschreibung
platform	string	’ios’ | ‘android’ | ‘web’
version	string	Versionsstring des Betriebssystems
supportsNativeAlarms	boolean	Ob die Plattform eine native Alarm-App-Integration bietet
supportsScheduledNotifications	boolean	Ob das Planen lokaler Benachrichtigungen unterstützt wird
canScheduleExactAlarms	boolean	Nur Android: Ob exakte Alarme erlaubt sind

PermissionResult

Ergebnis einer Berechtigungsanforderung.

Eigenschaft	Typ	Beschreibung
granted	boolean	Gesamtgenehmigung für angeforderten Bereich
details	Record<string, boolean>	Optionale Details nach Berechtigungsschlüssel