Zum Hauptinhalt springen
Zurück zu Plugins
@capgo/capacitor-Hintergrundaufgabe
Tutorial
von github.com/Cap-go

Hintergrundaufgabe

Scheduling periodischer Hintergrundabfragen auf iOS und Android mit Expo-Task-Registrierung

Richtlinie

Tutorial zum Hintergrundauftrag

Mit @capgo/capacitor-hintergrundauftrag

In einer Capacitor-App periodische Hintergrundabfragen mit benannten Aufgaben, persistenter Registrierung, Statusprüfungen, Entregistrierung und einem Entwicklungs-Trigger planen. Das Plugin verwendet Android WorkManager und iOS BGTaskScheduler.

Installieren

npm install @capgo/capacitor-background-task
npx cap sync

iOS-Einrichtung

Hintergrundprozessunterstützung hinzufügen zu 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 diese Erweiterung enthüllt

  • defineTask - Definieren Sie die JavaScript-Rückruf für einen benannten Auftrag.
  • registerTaskAsync - Speichern und planen Sie einen periodischen Auftrag.
  • unregisterTaskAsync - Stornieren Sie einen Auftrag.
  • isTaskRegisteredAsync - Überprüfen Sie den Registrierungsstatus eines Auftrags.
  • getRegisteredTasksAsync - Liste der registrierten Auftragsnamen.
  • getStatusAsync - Überprüfen Sie die Verfügbarkeit von Hintergrundaufgaben für native Apps.
  • triggerTaskWorkerForTestingAsync - Auslösen Sie die sofortige Ausführung der registrierten Aufgaben für Entwicklungszwecke.
  • addExpirationListener - Reagieren Sie auf iOS, wenn ein Auftrag abläuft.

Beispiel für die Verwendung

Definieren Sie die Aufgabe im Modulbereich, damit sie verfügbar ist, wenn das Betriebssystem die App weckt:

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

Auslösen Sie einen Entwicklungsstart:

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Stornieren Sie die Aufgabe:

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Plattformhinweise

  • Hintergrundaufgaben sind opportunistisch und nicht exakte Timer.
  • Android-Periodic-Work hat einen Mindestabstand von 15 Minuten.
  • iOS behandelt minimumInterval als frühesten Beginndatum und kann später laufen.
  • Testen Sie die Hintergrundverarbeitung von iOS auf einem physischen Gerät.

Vollständige Referenz

Weitermachen von Using @capgo/capacitor-Hintergrundaufgabe

Wenn Sie Using verwenden 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, Einstieg für die Implementierungsdetails in Einstieg, Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren.