Aller au contenu

@capgo/background-geolocation

Suivi de localisation précis en arrière-plan, événements natifs d'entrée/sortie de geofence et webhooks de transition pour les applications Capacitor.

Livraison iOS en application fermée

Appelez GeofenceRelay.shared.start() depuis l’app delegate iOS, pour qu’une app terminée puisse quand même envoyer un POST de franchissement de région quand iOS la relance. L’accès à la localisation « Toujours » est requis pour cette relance.

File d’attente sur disque et nouvelles tentatives

Sur iOS, les transitions sont mises en file sur le disque et envoyées dans l’ordre. iOS réessaie en cas de perte de réseau, d’erreurs 5xx, 408, 429 ou 401/403. Cette file d’attente iOS conserve les 100 transitions les plus récentes, aucune ne datant de plus de sept jours. Android réessaie via WorkManager et n’utilise ni cette file ordonnée ni ces limites.

clearGeofenceQueue()

Supprimez les POST natifs non envoyés lors de la déconnexion ou du changement de compte url. La file est également vidée lorsque setupGeofencing reçoit un autre url. Sur le web, il n’y a pas de file et l’appel se résout immédiatement.

Event time

Optionnel GeofenceTransitionEvent.time indique le moment où le téléphone a détecté le franchissement, en millisecondes depuis l’epoch. Lisez cette valeur dans votre webhook, et non l’horloge du serveur, car un POST mis en file peut arriver plus tard.

Utiliser @capgo/background-geolocation lorsque votre application Capacitor a besoin de mises à jour de localisation précises au premier plan ou en arrière-plan, de geofences circulaires natives sur iOS et Android, et d'une remontée des transitions de geofence vers le backend quand la WebView est suspendue.

  • start Recevez des mises à jour de localisation précises en foreground/background.
  • stop - Arrêter proprement le suivi de localisation actif.
  • openSettings - Send users to native location settings when permissions need attention.
  • setPlannedRoute - Jouer un son natif lorsque l'utilisateur s'écarte d'un itinéraire prévu.
  • setupGeofencing Configurez les geofences natives par défaut et les webhooks de transition optionnels.
  • addGeofence - Surveiller une région de geofence circulaire iOS ou Android via son identifiant.
  • removeGeofence / removeAllGeofences - Arrêter la surveillance d'une ou de toutes les géorepères enregistrées.
  • getMonitoredGeofences - Lister les identifiants de région actuellement surveillés par la couche native.
  • updateHeaders - Remplacer les en-têtes HTTP persistants utilisés par la livraison POST native.
  • clearGeofenceQueue - Supprime les transitions de géofence en attente d’un POST natif et non encore envoyées.
  • geofenceTransition listener - Reçoit les événements d'entrée et de sortie pendant que l'app est active, y compris optionnel time.
  • geofenceError listener - Gérer les erreurs de surveillance natives sans modifier la forme de l'événement de transition.
MéthodeDescription
startFournit des mises à jour de localisation précises en premier ou en arrière-plan.
stopArrête les mises à jour de localisation.
openSettingsOuvre la page des paramètres de localisation de l’appareil. Pratique pour guider les utilisateurs vers l’activation des services de localisation ou l’ajustement des autorisations.
setPlannedRouteJoue un son natif lorsque l'utilisateur s'écarte de l'itinéraire prévu.
setupGeofencingConfigure les paramètres par défaut des geofences et l'envoi optionnel des transitions natives via POST.
addGeofenceLance la surveillance d'une geofence circulaire sur iOS et Android.
removeGeofenceArrête la surveillance d'une geofence via son identifiant.
removeAllGeofencesArrête la surveillance de toutes les geofences enregistrées par ce plugin.
getMonitoredGeofencesRetourne les identifiants actuellement surveillés par la couche native.
updateHeadersRemplace les en-têtes HTTP persistés pour la livraison native des requêtes POST. Sur iOS, cela vide également la file d’attente des géofences. Sur Android, il enregistre les en-têtes sans démarrer les tâches WorkManager en file d’attente.
clearGeofenceQueueSupprime les transitions de géofence en file d’attente pour un POST natif et non encore envoyées. Résout immédiatement sur le web.
addListener('geofenceTransition', ...)Reçoit les événements d’entrée et de sortie de géorepère pendant que l’app est active. Les événements peuvent inclure time.
addListener('geofenceError', ...)Reçoit les erreurs natives de surveillance de geofence lorsque l'application est active.
getPluginVersionRécupère la version du plugin natif Capacitor.

Cette référence est synchronisée depuis src/definitions.ts dans capacitor-background-geolocation.

Si vous utilisez @capgo/background-geolocation pour planifier le travail sur les plugins natifs, connectez-l’à Utiliser @capgo/background-geolocation pour la capacité native dans Utiliser @capgo/background-geolocation, 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.