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.

Utiliser @capgo/background-geolocation lorsque votre application Capacitor nécessite des mises à jour de localisation précises au premier plan ou en arrière-plan, avec des geofences circulaires natives sur iOS et Android, et une livraison backend pour les transitions de geofence lorsque la WebView est suspendue.

  • start - Diffusez des mises à jour de localisation précises, en foreground ou en background.
  • stop - Arrêtez proprement le suivi de localisation actif.
  • openSettings - Send users to native location settings when permissions need attention.
  • setPlannedRoute - Jouez un son natif lorsque l'utilisateur s'écarte d'un itinéraire prévu.
  • setupGeofencing - Configurez les paramètres par défaut des geofences natives et l'envoi optionnel de webhooks de transition.
  • addGeofence - Surveillez une région de geofence circulaire iOS ou Android par identifiant.
  • removeGeofence / removeAllGeofences - Arrêter la surveillance d'une ou de toutes les geofences enregistrées.
  • getMonitoredGeofences - Lister les identifiants de région actuellement surveillés par la couche native.
  • geofenceTransition listener - Recevoir les événements d'entrée et de sortie lorsque l'app est active.
  • geofenceError listener - Gérer les erreurs de monitoring natif sans modifier la structure de l'événement de transition.
MéthodeDescription
startDiffuse des mises à jour de localisation précises en foreground ou en background.
stopArrête les mises à jour de localisation.
openSettingsOuvre la page des paramètres de localisation de l'appareil. Utile pour diriger les utilisateurs vers l'activation des services de localisation ou l'ajustement des permissions.
setPlannedRouteJoue un son natif lorsque l'utilisateur s'écarte d'un 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.
addListener('geofenceTransition', ...)Reçoit les événements d'entrée et de sortie de geofence lorsque l'application est active.
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.