Richtlinie
Tutorial zu Hintergrundaufgabe
Mit @capgo/capacitor-hintergrundaufgabe
Führen Sie periodische Hintergrundabfragen in einer Capacitor-App mit benannten Aufgaben, persistenter Registrierung, Statusprüfungen, Entregistrierung und einem Entwicklungs-Trigger durch.
Installieren
npm install @capgo/capacitor-background-task
npx cap sync
iOS-Einrichtung
Fügen Sie Hintergrundverarbeitungssupport hinzu 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 enthüllt
defineTask- Definieren Sie die JavaScript-Rückrufmethode für eine benannte Aufgabe.registerTaskAsync- Persistieren und planen Sie eine periodische Aufgabe.unregisterTaskAsync- Stornieren Sie eine Aufgabe.isTaskRegisteredAsync- Überprüfen Sie den Registrierungszustand einer Aufgabe.getRegisteredTasksAsync- Registrierte Aufgaben auflisten.getStatusAsync- Überprüfen Sie die Verfügbarkeit von Hintergrundaufgaben für native Geräte.triggerTaskWorkerForTestingAsync- Registrierte Aufgaben sofort für die Entwicklung auslösen.addExpirationListener- Reagieren Sie, wenn iOS eine Aufgabe abläuft.
Beispiel für die Verwendung
Definieren Sie die Aufgabe im Modulumfang, 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üfen Sie den Status und die registrierten Aufgabenamen:
const status = await BackgroundTask.getStatusAsync();
const tasks = await BackgroundTask.getRegisteredTasksAsync();
console.log({ status, tasks });
Ein Entwicklungsrun auslösen:
await BackgroundTask.triggerTaskWorkerForTestingAsync();
Die Aufgabe stornieren:
await BackgroundTask.unregisterTaskAsync(SYNC_TASK);
Plattformhinweise
- Hintergrundaufgabenskalen sind opportunistisch, nicht genaue Timer.
- Android-Periodic-Work hat einen Mindestabstand von 15 Minuten.
- iOS behandelt
minimumIntervalals frühesten Beginnstag und kann später laufen. - Teste iOS-Hintergrundverarbeitung auf einem physischen Gerät.
Vollständige Referenz
- GitHub: https://github.com/Cap-go/capacitor-hintergrundaufgabe/
- Dokumentation: /docs/plugins/hintergrundaufgabe/
Fahre fort von Using @capgo/capacitor-hintergrundaufgabe
Wenn Sie Mit @capgo/capacitor-hintergrundaufgabe native Plugin-Arbeit planen, verbinden Sie es mit @capgo/capacitor-hintergrundaufgabe für die Implementierungsdetails in @capgo/capacitor-Hintergrundaufgabe Einstieg für die Implementierungsdetails in Einstieg Capgo-Plugin-Verzeichnis für den Produktworkflow in Capgo-Plugin-Verzeichnis Capacitor-Plugins von Capgo für die Implementierungsdetails in Capacitor-Plugins von Capgo Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren