Démarrage

@capgo/capacitor-background-task Permet à une application Capacitor de s'inscrire pour des tâches de synchronisation périodiques, des mises à jour de cache, la livraison d'analytiques et d'autres opérations de récupération de fond d'écran.

Installez

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Configuration iOS

Ajoutez le mode de traitement en arrière-plan et l'identifiant de tâche autorisé à ios/App/App/Info.plist:

<key>UIBackgroundModes</key>
<array>
  <string>processing</string>
</array>
<key>BGTaskSchedulerPermittedIdentifiers</key>
<array>
  <string>app.capgo.backgroundtask.processing</string>
</array>

Ensuite, exécutez :

npx cap sync ios

Importer

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

Définir une tâche

Définissez l'appel de retour au niveau du module afin qu'il soit enregistré dès que l'application est lancée par le système d'exploitation.

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

Enregistrer le planning

Appel registerTaskAsync Après que votre application ait suffisamment de contexte pour activer le travail en arrière-plan.

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

minimumInterval La valeur est en minutes. Android impose un minimum de 15 minutes. iOS traite la valeur comme une date de début la plus tôt et peut exécuter plus tard.

Vérifier l'état

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

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

Déclencher Un Lancement De Test

Utilisez le déclencheur de test en développement ou en QA. Il appelle toutes les tâches enregistrées immédiatement.

await BackgroundTask.triggerTaskWorkerForTestingAsync();

Désinscrire une Tâche

await BackgroundTask.unregisterTaskAsync(SYNC_TASK);

Expiration iOS

iOS peut interrompre une tâche de fond avant que votre travail JavaScript ne se termine. Écoutez les événements d'expiration lorsqu'il s'agit de nettoyage ou de point de contrôle.

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

await expiration.remove();

Compatibilité des Tâches de Fond pour React Native

Le plugin expose également une petite couche de compatibilité pour les applications en train de migrer depuis 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,
});

Notes de Production

• La planification en arrière-plan est opportuniste, pas exacte.
• Gardez les tâches courtes et idempotentes.
• Persistez dans tout l'état dont vous avez besoin avant de renvoyer BackgroundTaskResult.Success.
• Évitez de vous fier aux tâches en arrière-plan pour les échéances ou les alarmes visibles par l'utilisateur.

Continuez à partir de Getting Started

Si vous utilisez Getting Started pour planifier le travail de plugin natif, connectez-le avec Utilisez @capgo/capacitor-task-en-arrière-plan pour la capacité native dans Utilisez @capgo/capacitor-task-en-arrière-plan, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Plugins Capgo par Capacitor pour le détail d'implémentation dans Plugins Capgo par Capacitor, Ajouter ou Mettre à Jour les Plugins pour le détail d'implémentation dans Ajouter ou Mettre à Jour les Plugins, et Alternatives de plugins d'entreprise Ionic Enterprise pour le flux de travail du produit dans Alternatives de plugins d'entreprise Ionic Enterprise.