Erste Schritte

@capgo/capacitor-background-task Ermöglicht es einer Capacitor App, periodische Jobs für Sync, Cache-Refreshes, Analytics-Übermittlung und andere Background-Fetch-Operationen zu registrieren.

Installieren

Du kannst unser KI-gestütztes Setup nutzen, um das Plugin zu installieren. Füge die Capgo Skills mit dem folgenden Befehl deinem KI-Tool hinzu:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Nutze dann diesen Prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-background-task` plugin in my project.

Wenn du ein manuelles Setup bevorzugst, installiere das Plugin mit den folgenden Befehlen und befolge die plattformspezifischen Anweisungen unten:

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

iOS-Setup

Füge den Background-Processing-Modus und die erlaubte Task-ID 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>

Führe dann aus:

npx cap sync ios

Importieren

import { BackgroundTask, BackgroundTaskResult } from '@capgo/capacitor-background-task';

Häufige Stolperfallen

• Modul-Scope: registrieren defineTask bevor registerTaskAsync.
• iOS-IDs: abgleichen BGTaskSchedulerPermittedIdentifiers Einträge.
• Intervalle: Das OS kann Jobs länger verzögern minimumInterval.

Task definieren

Definiere den Callback auf Modulebene, damit er registriert wird, sobald das Betriebssystem die App startet.

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

Zeitplan registrieren

Rufe registerTaskAsync nachdem deine App genügend Kontext hat, um den Background-Job zu aktivieren.

await BackgroundTask.registerTaskAsync(SYNC_TASK, {
  minimumInterval: 30,
  requiresNetwork: true,
});

minimumInterval ist in Minuten. Android erzwingt mindestens 15 Minuten. iOS behandelt den Wert als frühestes Startdatum und führt den Job eventuell später aus.

Status prüfen

const status = await BackgroundTask.getStatusAsync();
const isRegistered = await BackgroundTask.isTaskRegisteredAsync(SYNC_TASK);
const registeredTasks = await BackgroundTask.getRegisteredTasksAsync();

console.log({ status, isRegistered, registeredTasks });

Testlauf auslösen

Nutze den Test-Trigger in der Entwicklung oder QA. Er ruft sofort alle registrierten Tasks auf.

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Task unregistrieren

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

iOS-Ablauf

iOS kann einen Background Task stoppen, bevor deine JavaScript-Arbeit abgeschlossen ist. Achte auf Expiration-Events, wenn Cleanup oder Checkpointing wichtig sind.

const expiration = await BackgroundTask.addExpirationListener((event) => {
  console.warn('Background task expired', event.taskName, event.taskId);
});

await expiration.remove();

React Native Background Task-Kompatibilität

Das Plugin bietet zudem einen kleinen Compatibility Layer für Apps, die migrieren von react-native-background-task.

import { BackgroundTask } from '@capgo/capacitor-background-task';

BackgroundTask.define(async () => {
  await fetch('https://api.example.com/sync', { method: 'POST' });
});

await BackgroundTask.schedule({
  period: 1800,
});

Produktionshinweise

• Das Scheduling im Hintergrund erfolgt opportunistisch, nicht exakt.
• Halte die Aufgaben kurz und idempotent.
• Speichere alle benötigten States, bevor du zurückgibst BackgroundTaskResult.Success.
• Verlasse dich nicht auf Background Tasks für zeitkritische User-Deadlines oder Alarme.

Weiter geht's nach Getting Started

Wenn du es nutzt Erste Schritte Um die Arbeit an nativen Plugins zu planen, verbinde sie mit @capgo/capacitor-background-task verwenden für die native Funktion in „@capgo/capacitor-background-task verwenden“, Capgo Plugin-Verzeichnis für den Produkt-Workflow im Capgo Plugin-Verzeichnis, Capacitor Plugins von Capgo für das Implementierungsdetail in Capacitor Plugins von Capgo, Plugins hinzufügen oder aktualisieren für das Implementierungsdetail beim Hinzufügen oder Aktualisieren von Plugins, und Ionic Enterprise Plugin-Alternativen für den Produkt-Workflow bei den Ionic Enterprise Plugin-Alternativen.