__CAPGO_KEEP_0__-Startseite
Zurück zu Plugins
@capgo/capacitor-Hintergrundaufgabe
Tutorial
@capgo/capacitor-Hintergrundaufgabe

Hintergrundaufgabe

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

Führung

Anleitung zu Hintergrundaufgaben

Gerät testen

Herunterladen Sie die Capgo-App, dann scannen Sie die QR-code.

Hintergrund-Aufgabe-Plugin-Vorschau-QR code

Verwenden Sie @capgo/capacitor-background-task

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

Installieren

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

iOS-Einrichtung

Hinzufügen von Hintergrundverarbeitungsfunktionen 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>

Hinweis: Sie müssen das Plugin in Ihrem Projekt installieren, bevor Sie es verwenden können.

npx cap sync ios

Was dieses Plugin bereitstellt

  • 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 - Die Verfügbarkeit von native Hintergrundaufgaben überprüfen.
  • triggerTaskWorkerForTestingAsync - Registrierte Aufgaben sofort für die Entwicklung auslösen.
  • addExpirationListener - Reagieren, wenn iOS eine Aufgabe abläuft.

Beispielanwendung

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

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

Hinweise zur Plattform

  • Hintergrundaufgabenskalen sind Opportunismus, keine genauen Timer.
  • Android-Periodikarbeit hat einen Mindestabstand von 15 Minuten.
  • iOS behandelt minimumInterval als frühesten Beginn und kann später laufen.
  • Teste iOS-Hintergrundverarbeitung auf einem physischen Gerät.

Vollständige Referenz

Fortsetzen Sie von Using @capgo/capacitor-Hintergrundaufgabe/

Wenn Sie @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-Hintergrundaufgabe/ verwenden Um native Plugin-Arbeit zu planen, verbinden Sie es mit @capgo/capacitor-Hintergrundaufgabe/ iOS behält @capgo/capacitor-background-task zur Implementierungsdetail in @capgo/capacitor-Hintergrundaufgabe, Einstieg zur Implementierungsdetail in Einstieg, Capgo-Plugin-Verzeichnis zur Produktworkflow in Capgo-Plugin-Verzeichnis, Capacitor-Plugins von Capgo zur Implementierungsdetail in Capacitor-Plugins von Capgo, und Plugins hinzufügen oder aktualisieren zur Implementierungsdetail in Plugins hinzufügen oder aktualisieren.