@capgo/background-geolocation

Suivi de localisation de fond précis, événements de pénétration de zone géographique native et webhooks de transition pour les applications Capacitor.

Commencez GitHub

Présentation

Utilisation @capgo/background-geolocation Lorsque votre application Capacitor nécessite des mises à jour de localisation précises en avant-plan ou en arrière-plan, des cercles de géofences natifs sur iOS et Android, et la livraison backend pour les transitions de géofence lorsque la vue Web est suspendue.

Capacités de base

start - Flux de mises à jour de localisation précises en avant-plan ou en arrière-plan.
stop - Arrêt de la traçabilité de localisation active de manière propre.
openSettings - Envoyer les utilisateurs vers les paramètres de localisation natifs lorsque les autorisations nécessitent une attention.
setPlannedRoute - Jouer un son natif lorsque l'utilisateur dévie d'un itinéraire planifié.
setupGeofencing - Configurer les paramètres de géofence natifs par défaut et la livraison facultative de webhook pour les transitions de géofence.
addGeofence - Surveiller une région de cercle de géofence iOS ou Android par identifiant.
removeGeofence / removeAllGeofences - Arrêtez la surveillance d'un ou de tous les geofences enregistrés.
getMonitoredGeofences - Liste les identificateurs de région actuellement surveillés par la couche native.
geofenceTransition listener - Recevez les événements d'entrée et de sortie tout en gardant l'application active.
geofenceError listener - Gérez les erreurs de surveillance native sans modifier la forme de l'événement de transition.

Public API

Méthode	Description
`start`	Fournit des mises à jour de localisation précises en mode aéroport ou en arrière-plan.
`stop`	Arrête les mises à jour de localisation.
`openSettings`	Ouvre la page de paramètres de localisation du dispositif. Utile pour diriger les utilisateurs pour activer les services de localisation ou ajuster les permissions.
`setPlannedRoute`	Joue un son natif lorsque l'utilisateur dévie d'un itinéraire planifié.
`setupGeofencing`	Configure les paramètres de la zone géographique par défaut et la livraison optionnelle de transition native POST.
`addGeofence`	Démarre la surveillance d'une zone géographique circulaire sur iOS et Android.
`removeGeofence`	Arrête la surveillance d'une zone géographique par son identifiant.
`removeAllGeofences`	Arrête la surveillance de toutes les zones géographiques enregistrées par ce plugin.
`getMonitoredGeofences`	Renvoie les identifiants actuellement surveillés par la couche native.
`addListener('geofenceTransition', ...)`	Reçoit les événements d'entrée et de sortie de la zone géographique pendant que l'application est en cours d'exécution.
`addListener('geofenceError', ...)`	Reçoit les erreurs de surveillance de la zone géographique native pendant que l'application est en cours d'exécution.
`getPluginVersion`	Obtenez la version native du plugin Capacitor.

Source De Vérité

Cette référence est synchronisée à partir de src/definitions.ts en localisation de géolocalisation de fond - capacitor.