Guide
Hilfe zu Hintergrundaufgaben
Verwenden Sie @capgo/capacitor-hintergrundaufgaben
Planen Sie periodische Hintergrundabfragen in einer Capacitor-App mit benannten Aufgaben, persistenter Registrierung, Statusprüfungen, De-Registrierung und einem Entwicklungs-Trigger. Der Plugin verwendet Android WorkManager und iOS BGTaskScheduler.
Installieren
npm install @capgo/capacitor-background-task
npx cap sync
iOS-Einrichtung
Hinzufügen von Hintergrundverarbeitungsfunktionen ios/App/App/Info.plist:
<key>UIBackgroundModes</key>
<array>
<string>processing</string>
</array>
<key>BGTaskSchedulerPermittedIdentifiers</key>
<array>
<string>app.capgo.backgroundtask.processing</string>
</array>
Dann ausführen:
npx cap sync ios
Was dieses Plugin bietet
defineTask- Definieren Sie die JavaScript-Rückruf-Funktion für eine benannte Aufgabe.registerTaskAsync- Eine periodische Aufgabe persistieren und planen.unregisterTaskAsync- Eine Aufgabe stornieren.isTaskRegisteredAsync- Überprüfen Sie den Registrierungsstatus einer Aufgabe.getRegisteredTasksAsync- Liste der registrierten Aufgabennamen.getStatusAsync- Überprüfen Sie die Verfügbarkeit von Hintergrundaufgaben.triggerTaskWorkerForTestingAsync- Ausgelöste registrierte Aufgaben sofort für die Entwicklung ausführen.addExpirationListener- Reagieren Sie, wenn iOS eine Aufgabe abläuft.
- Beispielverwendung
- Definieren Sie die Aufgabe im Modulbereich, damit sie verfügbar ist, wenn das Betriebssystem den App wachruft:
import { BackgroundTask, BackgroundTaskResult } from '@capgo/capacitor-background-task';
const SYNC_TASK = 'sync-offline-data';
BackgroundTask.defineTask(SYNC_TASK, async () => {
try {
await fetch('https://api.example.com/sync', { method: 'POST' });
return BackgroundTaskResult.Success;
} catch {
return BackgroundTaskResult.Failed;
}
});
await BackgroundTask.registerTaskAsync(SYNC_TASK, {
minimumInterval: 30,
requiresNetwork: true,
});
Überprüfe den Status und die registrierten Aufgabenamen:
const status = await BackgroundTask.getStatusAsync();
const tasks = await BackgroundTask.getRegisteredTasksAsync();
console.log({ status, tasks });
- Auslösen Sie einen Entwicklungsrun:
await BackgroundTask.triggerTaskWorkerForTestingAsync();
- Stornieren Sie die Aufgabe:
await BackgroundTask.unregisterTaskAsync(SYNC_TASK);
Hinweise zur Plattform
- Die Hintergrundaufgaben werden opportunistisch und nicht als genaue Timer durchgeführt.
- Android-Periodikarbeit hat einen Mindestabstand von 15 Minuten.
- iOS behandelt
minimumIntervalals frühesten Beginn und kann später durchgeführt werden. - Testen Sie die Hintergrundverarbeitung von iOS auf einem physischen Gerät.
Vollständige Referenz
- GitHub: https://github.com/Cap-go/capacitor-Hintergrundaufgabe/
- Dokumentation: /docs/plugins/Hintergrundaufgabe/
Fortsetzen Sie mit Verwendung von @capgo/capacitor-Hintergrundaufgabe
Wenn Sie die Verwendung von Mit @capgo/capacitor-Hintergrundaufgabe um native Plugin-Arbeit zu planen, verbinden Sie es mit @capgo/capacitor-Hintergrundaufgabe für die Implementierungsdetails in @capgo/capacitor-Hintergrundaufgabe, Getting Started für die Implementierungsdetails in Einführung, Capgo Plugin-Verzeichnis für den Produktworkflow in 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.