Zum Inhalt springen

@capgo/capacitor-Hintergrund-Aufgabe

Expo-stilige benannte Hintergrundaufgaben für Capacitor-Anwendungen, die von Android WorkManager und iOS BGTaskScheduler unterstützt werden.

Verwenden Sie @capgo/capacitor-background-task wenn Ihre Capacitor-Anwendung periodische Hintergrundabfragen wie Synchronisierung, Cacheaktualisierungen, E-Mail-Polling, Analytik-Entleerung oder leichte Wartungsarbeiten benötigt.

Die Erweiterung folgt dem praktischen Funktionsumfang von Expo BackgroundTask mit benannten Aufgaben, persistenter Registrierung, Statusprüfungen, Entregistrierung, einem Entwicklungs-Trigger und iOS-Ablaufereignissen.

  • defineTask - Registrieren Sie die JavaScript-Rückrufmethode für eine benannte Aufgabe.
  • registerTaskAsync - Persistieren und planen Sie eine periodische Aufgabe.
  • unregisterTaskAsync - Zukunftsvorkehrungen für eine Aufgabe stornieren.
  • isTaskRegisteredAsync - Überprüfen, ob eine Aufgabe registriert ist.
  • getRegisteredTasksAsync - Liste der derzeit registrierten Aufgabenamen anzeigen.
  • getPendingTaskRunsAsync - Inspektion von Ereignissen von native Aufgaben, die vor der Bereitstellung von JavaScript aufgezeichnet wurden.
  • getStatusAsync - Überprüfen, ob native Hintergrundaufgaben verfügbar sind.
  • triggerTaskWorkerForTestingAsync - Registrierte Aufgaben sofort während der Entwicklung ausführen.
  • addExpirationListener - iOS-Ablaufaufrufe verarbeiten.
  • define, schedule, cancel, statusAsync und finish - Kompatibilitäts-Hilfsmittel für react-native-background-task.

- Compatibility helpers for Capgo

PlattformEigener SchedulerWichtige Verhaltensweise
AndroidWorkManagerPeriodische Arbeit hat einen Mindestabstand von 15 Minuten.
iOSBGTaskSchedulerminimumInterval ist ein frühestes Beginndatum und nicht ein garantiertes Rhythmus.
WebTest-fallweises FallbackKein echter Hintergrundscheduler ist verfügbar.
MethodeBeschreibung
defineTaskDefiniert die JavaScript-Rückrufmethode für einen benannten Auftrag.
registerTaskAsyncRegistriert einen benannten periodischen Hintergrundauftrag.
unregisterTaskAsyncStorniert zukünftige Aufgabendurchführungen.
isTaskRegisteredAsyncGibt an, ob ein Auftrag registriert ist.
getRegisteredTasksAsyncListet die registrierten Aufgabennamen auf.
getPendingTaskRunsAsyncListet native Aufgabenereignisse auf, die abgeschlossen werden müssen.
getStatusAsyncGibt an, ob native Hintergrundscheduling verfügbar ist.
triggerTaskWorkerForTestingAsyncAuslöst die registrierten Aufgaben für Entwicklung und QA.
addExpirationListenerListet iOS-Ablaufereignisse ab.

Diese Referenz wird von src/definitions.ts in capacitor-Hintergrundaufgabe.