メインコンテンツにスキップ
プラグインに戻る
@capgo/capacitor-バックグラウンド地理位置
チュートリアル
@capgo/capacitor-バックグラウンド地理位置

バックグラウンド地理位置

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

ガイド

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

デバイスでテスト

Download the Capgo app, then scan the QR code.

バックグラウンド地理位置プラグインプレビューQRcode

@capgo/background-geolocationを使用

iOSとAndroid用のCapacitorアプリ向けの正確なバックグラウンド地理位置とネイティブのジオフェンス機能。JavaScriptまたはバックエンドに精度の高い位置更新をストリームし、円形の地域を監視し、JavaScriptまたはバックエンドに地理フェンスのエントリ/エクスィットトランジションを送信できます。

インストール

bun add @capgo/background-geolocation
bunx cap sync

このプラグインが公開するもの

  • start - 正確な前景またはバックグラウンドの位置更新をストリームします。
  • stop - アクティブな位置追跡を停止します。
  • openSettings - ユーザーが位置許可を修正する必要があるときに、ネイティブの設定を開きます。
  • setPlannedRoute - ユーザーが計画ルートを離れたときにネイティブの音を再生します。
  • setupGeofencing - ネイティブのジオフェンスのデフォルトを構成し、オプションのトランジションWebhookの配信も可能です。
  • addGeofence - iOS または Android の円形のジオフェンス地域を監視します。
  • removeGeofence / removeAllGeofences - 登録済みの地域の 1 つまたはすべてを停止して監視を停止します。
  • 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 native code をウェブビューが休止中でも POST トランジション ペイロードを許可するようにします。

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" />

フル リファレンス

Keep going from Using @capgo/background-geolocation

Capacitor の背景地理位置を使用している場合、@Capacitor/background-geolocation を使用してください。 Using @capgo/background-geolocation Capacitor の背景地理位置を使用している場合、@Capacitor/background-geolocation を使用してください。 @capgo/background-geolocation for the implementation detail in @capgo/background-geolocation, はじめに Capacitor背景地理位置プラグインの実装詳細 Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and フッター Capgoアプリをパワーアップする