Aller au contenu

@capgo/capacitor-background-task

Tâches de récupération en arrière-plan périodiques sur iOS et Android.

Définissez les tâches du module, planifiez les intervalles et renvoyez des résultats compris par l’OS pour la synchro et le cache warming.

PlateformeSupportNotes
iOSOuiIdentifiants BGTaskScheduler dans Info.plist
AndroidOuiJobs de type WorkManager
Le WebNonUtiliser des service workers
  • defineTask - Enregistrer le callback JavaScript pour une tâche nommée.
  • registerTaskAsync - Persister et planifier une tâche périodique.
  • unregisterTaskAsync - Annuler les exécutions futures d'une tâche.
  • isTaskRegisteredAsync - Vérifier si une tâche est enregistrée.
  • getRegisteredTasksAsync - Lister les noms des tâches actuellement enregistrées.
  • getPendingTaskRunsAsync - Inspecter les événements de tâches natives enregistrés avant que le JavaScript ne soit prêt.
  • getStatusAsync - Vérifier la disponibilité des tâches de fond natives.
  • triggerTaskWorkerForTestingAsync - Exécuter immédiatement les tâches enregistrées pendant le développement.
  • addExpirationListener - Gérer les callbacks d'expiration iOS.
  • define, schedule, cancel, statusAsync, et finish - Helpers de compatibilité pour react-native-background-task.

Les tâches en arrière-plan ne sont pas des minuteurs précis. Android et iOS décident quand exécuter le travail planifié, selon la batterie, le réseau, l'usage de l'app et les règles du système.

PlateformePlanificateur natifComportement important
AndroidWorkManagerLe travail périodique a un intervalle minimum de 15 minutes.
iOSBGTaskSchedulerminimumInterval est une date de début au plus tôt, pas une cadence garantie.
Le WebRepli réservé aux testsAucun véritable planificateur d’arrière-plan n’est disponible.
MéthodeDescription
defineTaskDéfinit le callback JavaScript pour une tâche nommée.
registerTaskAsyncEnregistre une tâche périodique nommée en arrière-plan.
unregisterTaskAsyncAnnule les exécutions futures des tâches.
isTaskRegisteredAsyncIndique si une tâche est enregistrée.
getRegisteredTasksAsyncListe les noms des tâches enregistrées.
getPendingTaskRunsAsyncListe les événements de tâches natives en attente de fin.
getStatusAsyncIndique si la planification native en arrière-plan 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-background-task.

Si vous utilisez @capgo/capacitor-background-task pour planifier le travail sur les plugins natifs, connectez-l’à Utilisation de @capgo/capacitor-background-task pour la fonctionnalité native dans Utilisation de @capgo/capacitor-background-task, Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans Plugins Capacitor par Capgo, Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Ajout ou mise à jour de plugins, et Alternatives aux plugins Ionic Enterprise pour le workflow produit dans Alternatives aux plugins Ionic Enterprise.