Hintergrundaufgabe Capacitor-Plugin

Verwenden Sie @capgo/capacitor-hintergrundaufgaben

Planen Sie periodische Hintergrundabfragen in einer Capacitor-App mit benannten Aufgaben, persistenter Registrierung, Statusprüfungen, Entregistrierung und einem Entwicklungs-Trigger. Der 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 dieser Plugin bereitstellt

• defineTask - Definieren Sie die JavaScript-Rückruf 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 - Aktivieren Sie für die Entwicklung registrierte Aufgaben sofort.
• addExpirationListener - Reagieren Sie auf iOS, wenn eine Aufgabe abläuft.

- Beispielverwendung

- Definieren Sie die Aufgabe im Modulbereich, damit sie verfügbar ist, wenn der 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 Status und registrierte Aufgaben:

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

console.log({ status, tasks });

- Aktivieren Sie einen Entwicklungsstart:

await BackgroundTask.triggerTaskWorkerForTestingAsync();

- Stornieren Sie die Aufgabe:

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Plattform Hinweise

• Hintergrundaufgaben werden opportunistisch und nicht als genaue Timer durchgeführt.
• Android periodische Arbeit hat einen Mindestabstand von 15 Minuten.
• iOS behandelt minimumInterval als frühesten Beginndatum und kann später ausgeführt werden.
• Teste Hintergrundverarbeitung auf iOS 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 die Plugin-Verwendung von @__CAPGO_KEEP_0__-Plugin verwenden Mit @capgo/capacitor-Hintergrundaufgabe um native Plugin-Arbeit zu planen, mit ihr zu verbinden 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.