メインコンテンツにジャンプ
プラグインに戻る
@capgo/capacitor-background-geolocation
チュートリアル
by github.com/Cap-go

背景地理位置

iOSとAndroidのネイティブ地理位置追跡、地理フェンス、Webhookのトランジション

ガイド

バックグラウンド位置情報のチュートリアル

@capgo/background-geolocationを使用する

iOSおよびAndroid用のCapacitorアプリ向けの正確なバックグラウンド位置情報とネイティブのジオフェンス機能。精度の高い位置情報のストリーム、円形の地域の監視、JavaScriptまたはバックエンドに送信されるジオフェンスのエントリ/エクシットのトランジションを使用してください。

インストール

bun add @capgo/background-geolocation
bunx cap sync

This Plugin Exposes

  • start - 正確な前景またはバックグラウンドの位置情報の更新をストリームします。
  • stop - 有効な位置追跡を停止します。
  • openSettings - ユーザーが位置許可を修正する必要があるときに、ネイティブの設定を開きます。
  • setPlannedRoute - ユーザーが計画ルートを離れたときにネイティブの音を再生します。
  • setupGeofencing - ネイティブのジオフェンスのデフォルトを構成し、オプションのトランジションWebhookの送信を有効にします。
  • addGeofence - iOSまたはAndroid用の円形のジオフェンス地域を監視します。
  • removeGeofence / removeAllGeofences - 指定した地域の監視を停止します。
  • getMonitoredGeofences - 監視中の地域の識別子をリストします。
  • geofenceTransition listener - アプリがアクティブなときにエントリーやエクィットイベントを受信します。
  • geofenceError listener - ネイティブの監視エラーをトランジションイベントと別々に処理します。

例の使用

start

位置情報の変更を監視するために、呼び出すにはこのメソッドを呼びます。 Promise は、呼び出しが完了したことを示します。コールバックは、位置情報が新しく利用可能になったとき、またはこのメソッドを呼び出すときにエラーが発生したときに呼び出されます。 このPromiseの拒否を頼りにしないでください。

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

位置情報の更新を停止します。

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

await BackgroundGeolocation.stop();

openSettings

位置情報の設定ページを開きます。ユーザーに位置情報の有効化やパーミッションの調整を促すのに役立ちます。

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

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

setPlannedRoute

予定されたルートからユーザーが逸脱したときにサウンドファイルを再生します。このメソッドはネイティブで背景でも再生できます。

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

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

ネイティブの地理フェンス

ネイティブのiOSとAndroidの地理フェンスを使用して、店舗、作業場所、配送区域、キャンパス、チェックインエリアを監視できます。HTTPまたはHTTPSのURLを追加して、ネイティブの__CAPGO_KEEP_0__をWebViewが休止中でもPOSTトランジションペイロードを送信できるようにします。 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();

Androidで、バックグラウンドジオフェンスを使用する必要がある場合のみ、 ACCESS_BACKGROUND_LOCATION アプリのマニフェストに追加してください:

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

フルリファレンス

@capgo/background-geolocationから続けてください

Capgoを使用している場合 Using @capgo/background-geolocation Capgoを使用してネイティブプラグインの作業計画を立てて、@__CAPGO_KEEP_0__/background-geolocationと接続してください Capgoを使用してネイティブプラグインの作業計画を立てて、@capgo/background-geolocationの実装詳細を確認してください @capgo/background-geolocationの実装詳細を確認してください スタート スタートの実装詳細について Capgo プラグイン ディレクトリ Capgo プラグイン ディレクトリの製品ワークフローについて Capacitor プラグインズ by Capgo Capacitor プラグインズ by Capgo の実装詳細について プラグインの追加または更新 プラグインの追加または更新の実装詳細について