Vai alla navigazione principale
Indietro ai plugin
@capgo/capacitor-background-geolocation
Tutorial
da github.com/Cap-go

Geolocalizzazione in background

Geolocalizzazione precisa in background con geofencing nativo per iOS e Android, oltre a webhook di transizione

Guida

Tutorial sulla geolocalizzazione di background

Utilizzo di @capgo/background-geolocation

Geolocalizzazione di background precisa e geofencing nativa per le app Capacitor su iOS e Android. Utilizzalo per streamare aggiornamenti di posizione precisi, monitorare regioni circolari e inviare transizioni di ingresso/uscita di geofence al JavaScript o al tuo backend.

Installa

bun add @capgo/background-geolocation
bunx cap sync

Cosa questo plugin espone

  • start - Invia aggiornamenti di posizione precisi in primo piano o in background.
  • stop - Fermare la tracciatura attiva della posizione.
  • openSettings - Apri le impostazioni native quando gli utenti hanno bisogno di risolvere le autorizzazioni di posizione.
  • setPlannedRoute - Riproduci un suono nativo quando l'utente lascia una rotta pianificata.
  • setupGeofencing - Configura i default di geofencing nativi e l'invio facoltativo di webhook di transizione.
  • addGeofence - Monitora una regione circolare di iOS o Android.
  • removeGeofence / removeAllGeofences - Fermati di monitorare una o tutte le regioni registrate.
  • getMonitoredGeofences - Elenco gli identificatori delle regioni monitorate.
  • geofenceTransition listener - Ricevi eventi di ingresso e uscita mentre l'app è attiva.
  • geofenceError listener - Gestisci gli errori di monitoraggio nativi separatamente dagli eventi di transizione.

Esempio di utilizzo

start

Per iniziare a ricevere informazioni sulle modifiche della posizione del dispositivo, chiama questo metodo. Un Promessa viene restituita per indicare che è terminata la chiamata. Il callback verrà chiamato ogni volta che sarà disponibile una nuova posizione, o se è stato verificato un errore durante la chiamata di questo metodo. Non affidarti alla rifiutazione della promessa per questo.

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

Smette gli aggiornamenti della posizione.

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

await BackgroundGeolocation.stop();

openSettings

Apri la pagina di impostazioni della posizione del dispositivo. Utile per dirigere gli utenti a consentire i servizi di posizione o adattare le autorizzazioni.

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

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

setPlannedRoute

Gioca un file audio quando l'utente si allontana dalla rotta pianificata. Questo dovrebbe essere utilizzato per riprodurre un suono (anche in background, solo per nativo).

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

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

Geofencing nativo

Monitorare negozi, aree di lavoro, zone di consegna, campus o aree di check-in con geofreni nativi per iOS e Android. 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();

per consentire ai payload POST nativi di __CAPGO_KEEP_0__ di essere inviati mentre il WebView è sospeso. ACCESS_BACKGROUND_LOCATION Aggiungi

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

solo quando hai bisogno di geofreni di background: