Passer à la navigation principale
Retour aux plugins
@capgo/capacitor-geolocalisation-en-arrière-plan
Tutoriel
@capgo/capacitor-geolocalisation-en-arrière-plan

Geolocalisation en arrière-plan

Suivi de la localisation en arrière-plan précis avec la geofencing native iOS et Android, ainsi que les webhooks de transition

Guide

Tutoriel sur la géolocalisation de fond

Tester sur appareil

Téléchargez l'application Capgo, puis scannez le code QR code.

Background Geolocation plugin preview QR code

Utilisation de @capgo/background-geolocation

Une géolocalisation de fond précise et un geofencing natif pour les applications Capacitor sur iOS et Android. Utilisez-le pour diffuser des mises à jour de localisation précises, surveiller des régions circulaires et transmettre des transitions de geofence entrée/sortie vers JavaScript ou votre serveur backend.

Installation

bun add @capgo/background-geolocation
bunx cap sync

Ce que ce plugin expose

  • start - Diffuser des mises à jour de localisation précises en avant-plan ou en arrière-plan.
  • stop - Arrêter la traçabilité active de la localisation.
  • openSettings - Ouvrir les paramètres natifs lorsque les utilisateurs doivent fixer les autorisations de localisation.
  • setPlannedRoute - Jouer un son natif lorsque l'utilisateur quitte un itinéraire planifié.
  • setupGeofencing - Configurer les paramètres de geofence natifs par défaut et la livraison facultative d'un webhook de transition.
  • addGeofence - Surveiller une région circulaire de geofence iOS ou Android.
  • removeGeofence / removeAllGeofences - Arrêter la surveillance d'une ou de toutes les régions enregistrées.
  • getMonitoredGeofences - Liste des identificateurs de région surveillée.
  • geofenceTransition - listener - Recevoir les événements d'entrée et de sortie tout en faisant fonctionner l'application.
  • geofenceError - listener - Gérer les erreurs de suivi natif séparément des événements de transition.

Exemple d'utilisation

start

Pour commencer à écouter les changements de la position du dispositif, appelez cette méthode. Une promesse est renvoyée pour indiquer qu'elle a terminé l'appel. Le callback sera appelé chaque fois qu'une nouvelle position sera disponible, ou si une erreur s'est produite lors de l'appel de cette méthode. N'ayez pas confiance dans la rejet de promesse pour cela.

import { BackgroundGeolocation } from '@capgo/background-geolocation';

await BackgroundGeolocation.start(
  {
    backgroundMessage: "App is using your location in the background",
    backgroundTitle: "Location Service",
    requestPermissions: true,
    stale: false,
    distanceFilter: 10
  },
  (location, error) => {
    if (error) {
      console.error('Location error:', error);
      return;
    }
    if (location) {
      console.log('New location:', location.latitude, location.longitude);
    }
  }
);

stop

Arrête les mises à jour de la position.

import { BackgroundGeolocation } from '@capgo/background-geolocation';

await BackgroundGeolocation.stop();

openSettings

Ouvre la page de paramètres de la position du dispositif. Utile pour diriger les utilisateurs pour activer les services de localisation ou ajuster les permissions.

import { BackgroundGeolocation } from '@capgo/background-geolocation';

// Direct user to location settings
await BackgroundGeolocation.openSettings();

setPlannedRoute

Joue un fichier audio lorsque l'utilisateur dévie de la route planifiée. Cela devrait être utilisé pour jouer un son (en arrière-plan également, uniquement pour natif).

import { BackgroundGeolocation } from '@capgo/background-geolocation';

await BackgroundGeolocation.setPlannedRoute({
  soundFile: "notification.mp3",
  route: [[-74.0060, 40.7128], [-118.2437, 34.0522]]
});

Geofencing natif

Surveiller les magasins, les sites de travail, les zones de livraison, les campus ou les zones de vérification avec des geofences iOS et Android natifs. Ajoutez un url to let native code POST transition payloads while the WebView is suspended.

import { BackgroundGeolocation } from '@capgo/background-geolocation';

await BackgroundGeolocation.setupGeofencing({
  url: 'https://api.example.com/geofences',
  notifyOnEntry: true,
  notifyOnExit: true,
  payload: { userId: '123' },
});

await BackgroundGeolocation.addGeofence({
  identifier: 'warehouse',
  latitude: 40.7128,
  longitude: -74.006,
  radius: 200,
});

const listener = await BackgroundGeolocation.addListener(
  'geofenceTransition',
  (event) => console.log(event.identifier, event.transition),
);

const errorListener = await BackgroundGeolocation.addListener(
  'geofenceError',
  (event) => console.error(event.identifier, event.message),
);

await BackgroundGeolocation.removeGeofence({ identifier: 'warehouse' });
await listener.remove();
await errorListener.remove();

Sur Android, ajoutez ACCESS_BACKGROUND_LOCATION à votre manifeste d'application que lorsque vous avez besoin de la géolocalisation en arrière-plan :

<uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />

Référence complète

Continuez à partir de l'utilisation de @capgo/geolocalisation-en-arrière-plan

Si vous utilisez Utilisation de @capgo/geolocalisation-en-arrière-plan pour planifier le travail du plugin natif, connectez-le avec @capgo/geolocalisation-en-arrière-plan pour les détails d'implémentation dans @capgo/geolocalisation-en-arrière-plan, Démarrage pour les détails d'implémentation dans Getting Started, Capgo Répertoire des plugins pour le flux de travail du produit dans Capgo Répertoire des plugins, Capacitor Plugins par Capgo pour les détails d'implémentation dans Capacitor Plugins par Capgo, et Ajouter ou Mettre à Jour les Plugins pour les détails d'implémentation dans Ajouter ou Mettre à Jour les Plugins.