Passer à la navigation principale

@capgo/capacitor-background-task

Tâches de fond nommées à la manière d'Expo 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 d'écran périodiques comme la synchronisation, les mises à jour de cache, la lecture de la boîte de réception, l'écoulement des statistiques ou des tâches de maintenance légères.

Le plugin suit l'ensemble de fonctionnalités pratique de Expo BackgroundTask avec des tâches nommées, une inscription persistante, des 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 - Liste actuellement les noms des tâches enregistrées.
  • getPendingTaskRunsAsync - Inspecter les événements de tâches natives enregistrés avant que JavaScript soit prêt.
  • getStatusAsync - Vérifier la disponibilité des tâches de fond natives.
  • triggerTaskWorkerForTestingAsync - Exécuter les tâches enregistrées immédiatement pendant le développement.
  • addExpirationListener - Gérer les rappels de fin de vie iOS.
  • define, schedule, cancel, statusAsync, et finish - Aideurs de compatibilité pour react-native-background-task.

Les tâches de fond ne sont pas des temporisateurs exacts. 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
AndroidWorkManagerLa tâche périodique a un intervalle minimum de 15 minutes.
IOSBGTaskSchedulerminimumInterval est une date de début la plus tôt, et non une cadence garantie.
WebMode de fallback test uniquementAucun vrai planificateur de fond n'est disponible.
MéthodeDescription
defineTaskDéfinit l'appel de callback JavaScript pour une tâche nommée.
registerTaskAsyncEnregistre une tâche de fond périodique nommée.
unregisterTaskAsyncAnnule les exécutions futures de tâches.
isTaskRegisteredAsyncRenvoie si une tâche est enregistrée.
getRegisteredTasksAsyncAffiche les noms de tâches enregistrées.
getPendingTaskRunsAsyncAffiche les événements de tâche native en attente de fin.
getStatusAsyncRenvoie 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 à partir de src/definitions.ts en capacitor-tâche de fond.

Continuez à partir de @capgo/capacitor-tâche de fond

Section intitulée « Continuez à partir de @capgo/capacitor-tâche de fond »

Si vous utilisez @capgo/capacitor-tâche de fond pour planifier le travail de plugin natif, connectez-le avec En utilisant @capgo/capacitor-tâche de fond pour la capacité native dans En utilisant @capgo/capacitor-tâche de fond, Répertoire de plugin Capgo pour le flux de produit dans le répertoire de plugin Capgo les plugins Capacitor par Capgo pour le détail d'implémentation dans les 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 produit dans Alternatives de plugins d'entreprise Ionic.