Sauter au contenu

@capgo/capacitor-background-task

Exécution de tâches de fond Expo-style nommées pour les applications Capacitor, basées sur Android WorkManager et iOS BGTaskScheduler.

Utilisez @capgo/capacitor-background-task lorsque votre application Capacitor nécessite des travaux de récupération de fond périodiques comme la synchronisation, les mises à jour de cache, la lecture de la boîte de réception, l'écoulement des statistiques d'analyse ou des tâches de maintenance légères.

Le plugin suit l'ensemble de fonctionnalités pratique de l'Expo BackgroundTask avec des tâches nommées, l'enregistrement persistant, les vérifications d'état, la désinscription, un déclencheur de développement et les événements d'expiration iOS.

  • defineTask - Enregistrer l'appel de rappel JavaScript pour une tâche nommée.
  • registerTaskAsync - Persister et planifier une tâche périodique.
  • unregisterTaskAsync - Annuler les exécutions futures pour une tâche.
  • isTaskRegisteredAsync - Vérifier si une tâche est enregistrée.
  • getRegisteredTasksAsync - Listez les noms de tâches actuellement enregistrées.
  • getPendingTaskRunsAsync - Inspecter les événements de tâche native enregistrés avant que JavaScript soit prêt.
  • getStatusAsync - Vérifier la disponibilité de la tâche de fond native.
  • triggerTaskWorkerForTestingAsync - Exécuter les tâches enregistrées immédiatement pendant le développement.
  • addExpirationListener - Gérer les rappels de callback iOS expirés.
  • define, schedule, cancel, statusAsync, et finish - Aideurs de compatibilité pour react-native-background-task.

Les tâches de fond ne sont pas des temporisations exactes. Android et iOS décident quand exécuter le travail planifié en fonction de la batterie, du réseau, de l'utilisation de l'application et de la politique du système.

PlateformePlanificateur natifComportement important
AndroidWorkManagerLe travail périodique a un intervalle minimum de 15 minutes.
iOSBGTaskSchedulerminimumInterval est une date de début la plus tôt, pas une cadence garantie.
WebFallback de test uniquementAucun planificateur de fond réel n'est disponible.
MéthodeDescription
defineTaskDéfinit l'appel de rappel JavaScript pour une tâche nommée.
registerTaskAsyncEnregistre une tâche de fond périodique nommée.
unregisterTaskAsyncAnnule les futures exécutions de tâche.
isTaskRegisteredAsyncRenvoie si une tâche est enregistrée.
getRegisteredTasksAsyncListe les noms de tâches enregistrées.
getPendingTaskRunsAsyncListe les événements de tâches natives en attente de fin.
getStatusAsyncDétermine si la planification de fond native est disponible.
triggerTaskWorkerForTestingAsyncDéclenche les tâches enregistrées pour le développement et la QA.
addExpirationListenerÉcoute les événements d'expiration iOS.

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-tâche de fond.

Si vous utilisez @capgo/capacitor-task de fond pour planifier le travail du plugin natif, connectez-le à Utilisez @capgo/capacitor-task de fond pour la capacité native dans Utilisez @capgo/capacitor-task de fond, Répertoire de plugin Capgo pour le flux de travail du produit dans Répertoire de plugin Capgo, Plugins Capacitor par Capgo pour le détail d'implémentation dans Plugins Capacitor par Capgo, 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 pour le flux de travail du produit dans les alternatives du plugin Enterprise Ionic.