メインコンテンツへスキップ

@capgo/background-geolocation

Capacitor アプリ向けの正確なバックグラウンド位置情報トラッキング、ネイティブのジオフェンス入退場イベント、トランジションWebhook。

使用する @capgo/background-geolocation Capacitor アプリがフォアグラウンドまたはバックグラウンドでの正確な位置情報更新、iOS と Android のネイティブ円形ジオフェンス、WebView がサスペンドされている間のジオフェンス遷移のバックエンド配信を必要とする場合。

  • start - フォアグラウンドまたはバックグラウンドで正確な位置情報更新をストリーム配信。
  • stop - アクティブな位置情報トラッキングを正常に停止します。
  • openSettings - 権限の設定が必要な場合、ユーザーをネイティブの位置情報設定画面へ誘導します。
  • setPlannedRoute - ユーザーが予定ルートから外れた際に、ネイティブのサウンドを再生します。
  • setupGeofencing - ネイティブのジオフェンスのデフォルト設定と、オプションの遷移Webhook配信を設定。
  • addGeofence - iOS または Android の円形ジオフェンス領域を識別子で監視します。
  • removeGeofence / removeAllGeofences - 登録済みのジオフェンスを単一またはすべて停止します。
  • getMonitoredGeofences - ネイティブレイヤーで現在監視中のリージョンIDをリスト表示します。
  • geofenceTransition listener - アプリがアクティブな間にenterおよびexitイベントを受信。
  • geofenceError listener - トランジションイベントの形式を変えずに、ネイティブの監視エラーを処理します。
メソッド説明
start正確なフォアグラウンドまたはバックグラウンドの位置情報をストリーム配信します。
stop位置情報の更新を停止します。
openSettingsデバイスの位置情報設定画面を開きます。ユーザーに位置情報サービスを有効にさせたり、権限を調整させたりする場合に便利です。
setPlannedRouteユーザーが予定ルートから外れた際に、ネイティブサウンドを再生します。
setupGeofencingジオフェンスのデフォルト設定、およびオプションのネイティブ遷移POST配信を設定します。
addGeofenceiOSおよびAndroidで円形のジオフェンスの監視を開始します。
removeGeofence識別子を指定して、特定のジオフェンスの監視を停止します。
removeAllGeofencesこのプラグインによって登録されたすべてのジオフェンスの監視を停止します。
getMonitoredGeofences現在ネイティブレイヤーで監視されている識別子を返します。
addListener('geofenceTransition', ...)アプリが起動している間、ジオフェンスへの進入および退出イベントを受信します。
addListener('geofenceError', ...)アプリが起動している間、ネイティブのジオフェンス監視エラーを受信します。
getPluginVersionネイティブの Capacitor プラグインのバージョンを取得します。

このリファレンスは以下から同期されています: src/definitions.ts における capacitor-background-geolocation.

@capgo/background-geolocationの活用をさらに進める

「@capgo/background-geolocationの活用をさらに進める」セクション

使用している場合 @capgo/background-geolocation ネイティブプラグインの作業を計画するには、次と連携してください: @capgo/background-geolocation の使い方 @capgo/background-geolocationを使用する際のネイティブ機能について Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。