Zum Hauptinhalt springen
@capgo/capacitor-alarm Device-APIs Open Source

Alarm Capacitor Plugin

Native Alarme und Benachrichtigungen planen, auch wenn die App geschlossen ist

Installieren

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

Anleitung

Alarm in Capacitor verwenden

Nutzung von @capgo/capacitor-alarm

Capacitor Alarm Plugin zur Verwaltung nativer OS-Alarme.

Installieren

bun add @capgo/capacitor-alarm
bunx cap sync

bunx cap sync kopiert den nativen code des Plugins in deine nativen Projekte. Nach jedem Plugin-Upgrade erneut ausführen.

Importieren

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

API auf einen Blick

Methode Beschreibung
createAlarm Erstelle einen nativen OS-Alarm über die Uhr-App der Plattform. Unter Android wird der Alarm Clock Intent genutzt; unter iOS wird AlarmKit verwendet, falls verfügbar (iOS 16+).
openAlarms Öffnet die native Alarmlisten-UI der Plattform, falls verfügbar.
getOSInfo Rufe Informationen über das OS und dessen Funktionen ab.
requestPermissions Fordere die erforderlichen Berechtigungen für die Alarm-Nutzung auf der Plattform an. Unter Android kann dies zu den Einstellungen für exakte Alarme führen.
checkPermissions Prüfe den aktuellen Berechtigungsstatus für den nativen Alarmzugriff, ohne UI auszulösen. Unter iOS wird die AlarmKit-Bereitschaft gemeldet; unter Android werden die Capability-Details gemeldet.
getAlarms Rufe eine Liste der von dieser App geplanten Alarme ab. Unter iOS 26+ werden Alarme aus AlarmKit zurückgegeben. Unter Android wird dies nicht unterstützt, da das System kein API zur Abfrage von Alarmen bereitstellt.
cancelAlarm Storniert einen geplanten Alarm anhand seiner ID. Auf iOS 26+ wird der Alarm aus AlarmKit entfernt. Auf Android/Web wird „nicht unterstützt“ zurückgegeben.

Beispiele

createAlarm()

Erstelle einen nativen OS-Alarm über die Uhr-App der Plattform. Unter Android wird der Alarm Clock Intent genutzt; unter iOS wird AlarmKit verwendet, falls verfügbar (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()

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

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

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

getOSInfo()

Rufe Informationen über das OS und dessen Funktionen ab.

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()

Fordere die erforderlichen Berechtigungen für die Alarm-Nutzung auf der Plattform an. Unter Android kann dies zu den Einstellungen für exakte Alarme führen.

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()

Prüfe den aktuellen Berechtigungsstatus für den nativen Alarmzugriff, ohne UI auszulösen. Unter iOS wird die AlarmKit-Bereitschaft gemeldet; unter Android werden die Capability-Details gemeldet.

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

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

getAlarms()

Rufe eine Liste der von dieser App geplanten Alarme ab. Unter iOS 26+ werden Alarme aus AlarmKit zurückgegeben. Unter Android wird dies nicht unterstützt, da das System kein API zur Abfrage von Alarmen bereitstellt.

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

Die obige Tabelle listet die 7 Kernmethoden auf. Listener- und Versions-Helfer sowie der vollständige Vertrag jeder Methode sind in der GitHub Repository.

Vollständige Referenz

Weiter mit der Verwendung von @capgo/capacitor-alarm

Wenn du es nutzt Nutzung von @capgo/capacitor-alarm Um die Arbeit an nativen Plugins zu planen, verbinde sie mit @capgo/capacitor-alarm für die Implementierungsdetails in @capgo/capacitor-alarm, Erste Schritte für die Implementierungsdetails in Erste Schritte, Capgo Plugin-Verzeichnis für den Produkt-Workflow im Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, und Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren.

FAQ

Alarm Plugin FAQ

Wie installiere ich das Alarm-Plugin in einer Capacitor-App?

Führe "bun add @capgo/capacitor-alarm" (oder "npm install @capgo/capacitor-alarm") aus und danach "bunx cap sync", damit die iOS- und Android-Projekte die nativen code übernehmen. Importiere es in deiner code-App aus "@capgo/capacitor-alarm".

Funktioniert @capgo/capacitor-alarm mit React, Vue und Angular?

Ja. Alarm ist ein Capacitor Package und funktioniert daher mit jedem Web-Framework, das in Capacitor läuft, einschließlich Ionic, React, Vue, Angular, Svelte und reinem JavaScript.

Welche Capacitor-Version unterstützt @capgo/capacitor-alarm?

Capgo Plugins folgen der Major-Version von Capacitor: Nutze die Plugin-Major-Version, die zu deiner Capacitor Major-Version passt (z. B. Plugin v8 bei Capacitor 8). Die Kompatibilitätstabelle im GitHub README listet die gepflegten Versionen auf.

Ist @capgo/capacitor-alarm kostenlos und Open Source?

Ja. Der Source Code von code ist auf GitHub unter https://github.com/Cap-go/capacitor-alarm/ öffentlich, und das Package lässt sich kostenlos über npm installieren. Bug-Reports und Pull Requests sind willkommen.

Kann ich code mit Alarm ohne App Store Review aktualisieren?

Die Installation oder ein Upgrade des Plugins ändert den nativen code, weshalb ein neuer Store-Build nötig ist. Danach können JavaScript-, HTML- und CSS-Änderungen, die das Plugin aufrufen, sofort per Capgo Live Updates ausgeliefert werden.

Alarm-Änderungen veröffentlichen, ohne auf die App-Prüfung zu warten

Sobald das Plugin in deinem Store-Build ist, bringt Capgo mit Live-Updates deine JavaScript-, HTML- und CSS-Änderungen in Minuten zu den Nutzern.

Starte mit Capgo