Zum Hauptinhalt springen
Zurück zu Plugins
@capgo/capacitor-Hintergrundaufgabe
Tutorial
@capgo/capacitor-Hintergrundaufgabe

Hintergrundaufgabe

Periodische Hintergrundabfragen auf iOS und Android mit Expo-Task-Registrierung

Richtlinie

Tutorial zu Hintergrundaufgabe

Auf Gerät testen

Laden Sie die Capgo-App, dann scannen Sie die QR-code-Code.

Hintergrundaufgabe-Plugin-Vorschau-QR code

Mit @capgo/capacitor-background-task

Führen Sie periodische Hintergrundabfragen in einer Capacitor-App mit benannten Aufgaben, persistenter Registrierung, Statusprüfungen, De-Registrierungen und einem Entwicklungs-Trigger durch. Das Plugin verwendet Android WorkManager und iOS BGTaskScheduler.

Installieren

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

iOS-Einrichtung

Fügen Sie Hintergrundverarbeitungssupport hinzu 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 dieses Plugin enthüllt

  • defineTask - Definieren Sie die JavaScript-Rückruf-Funktion für eine benannte Aufgabe.
  • registerTaskAsync - Persistieren und planen Sie eine periodische Aufgabe.
  • unregisterTaskAsync - Stornieren Sie eine Aufgabe.
  • isTaskRegisteredAsync - Überprüfen Sie den Registrierungsstatus einer Aufgabe.
  • getRegisteredTasksAsync - Registrierte Aufgaben auflisten.
  • getStatusAsync - Überprüfen Sie die Verfügbarkeit von Hintergrundaufgaben für native Apps.
  • triggerTaskWorkerForTestingAsync - Registrierte Aufgaben sofort für die Entwicklung auslösen.
  • addExpirationListener - Reagieren Sie, wenn iOS eine Aufgabe abläuft.

Beispiel zur Verwendung

Definieren Sie die Aufgabe im Modulumfang, damit sie verfügbar ist, wenn das Betriebssystem die 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,
});

Status und registrierte Aufgaben auflisten:

const status = await BackgroundTask.getStatusAsync();
const tasks = await BackgroundTask.getRegisteredTasksAsync();

console.log({ status, tasks });

Entwicklungsrun auslösen:

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Aufgabe stornieren:

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Plattformhinweise

  • Hintergrundaufgabenskalen sind opportunistisch und nicht genaue Timer.
  • Android-Periodic-Work hat eine Mindestintervall von 15 Minuten.
  • iOS behandelt minimumInterval als frühestes Startdatum und kann später laufen.
  • Testen Sie die Hintergrundverarbeitung von iOS auf einem physischen Gerät.

Vollständige Referenz

Fortsetzen Sie mit Verwendung von @capgo/capacitor-hintergrundaufgabe

Wenn Sie Verwendung von @capgo/capacitor-hintergrundaufgabe zum Planen der Arbeit an nativen Plugins verwenden, 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, und Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren.