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

@capgo/background-geolocation

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

アプリ終了時の iOS 配信

呼び出す GeofenceRelay.shared.start() iOS アプリデリゲートから、終了したアプリが iOS によって再起動された際にリージョン横断を POST できるようにします。その再起動には常時位置情報アクセスが必要です。

ディスクキューとリトライ

iOS では、遷移がディスクにキューイングされ、順序通りに送信されます。ネットワーク切断、5xx、408、429、または 401/403 の場合、iOS はリトライします。この iOS キューは最新の 100 件の遷移を保持し、7 日より古いものは保持されません。Android は WorkManager 経由でリトライし、この順序付きキューやこれらの制限は使用しません。

clearGeofenceQueue()

同じ url。キューはまた、 setupGeofencing に別の urlが与えられた場合にも空になります。Web ではキューが存在せず、呼び出しは即座に解決されます。

イベント時刻

任意 GeofenceTransitionEvent.time 端末が境界の越境を検出した時刻です。エポックからのミリ秒で表されます。キューイングされた POST が遅れて届く可能性があるため、サーバーのクロックではなく、Webhook でこの値を読み取ってください。

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

  • start - フォアグラウンドまたはバックグラウンドで正確な位置情報更新をストリーム配信。
  • stop - アクティブな位置情報トラッキングを正常に停止します。
  • openSettings - 権限の設定が必要な場合、ユーザーをネイティブの位置情報設定画面へ誘導します。
  • setPlannedRoute - ユーザーが予定ルートから外れた際に、ネイティブのサウンドを再生します。
  • setupGeofencing - ネイティブのジオフェンスのデフォルト設定と、オプションの遷移Webhook配信を設定。
  • addGeofence - iOS または Android の円形ジオフェンス領域を識別子で監視します。
  • removeGeofence / removeAllGeofences - 1つまたはすべての登録済みジオフェンスの監視を停止します。
  • getMonitoredGeofences - 現在ネイティブレイヤーで監視されているリージョン識別子を一覧表示します。
  • updateHeaders - ネイティブ POST 配信で使用される永続化 HTTP ヘッダーを置き換えます。
  • clearGeofenceQueue - ネイティブ POST 用にキューイングされた未送信のジオフェンス遷移を破棄します。
  • geofenceTransition listener - アプリがアクティブの間、enter および exit イベントを受信します(オプションを含む) time.
  • geofenceError listener - トランジションイベントの形状を変更せずに、ネイティブ監視エラーを処理します。
メソッド説明
start正確なフォアグラウンドまたはバックグラウンドの位置情報更新をストリーミングします。
stop位置情報更新を停止します。
openSettingsデバイスの位置情報設定ページを開きます。ユーザーに位置情報サービスの有効化や権限の調整を促す際に便利です。
setPlannedRouteユーザーが計画されたルートから逸脱したときにネイティブサウンドを再生します。
setupGeofencingジオフェンスのデフォルト設定と、オプションのネイティブ遷移 POST 配信を設定します。
addGeofenceiOS と Android で円形ジオフェンスの監視を開始します。
removeGeofence識別子で指定したジオフェンスの監視を停止します。
removeAllGeofencesこのプラグインに登録されたすべてのジオフェンスの監視を停止します。
getMonitoredGeofencesネイティブレイヤーで現在監視されている識別子を返します。
updateHeadersネイティブ POST 配信用の永続化 HTTP ヘッダーを置き換えます。iOS ではジオフェンスキューもフラッシュされます。Android ではヘッダーを保存しますが、キューイングされた WorkManager ジョブは開始されません。
clearGeofenceQueueネイティブ POST 用にキューイングされ、まだ送信されていないジオフェンス遷移を破棄します。Web では即座に解決されます。
addListener('geofenceTransition', ...)アプリが稼働している間、ジオフェンスの進入と退出イベントを受信します。イベントには以下が含まれる場合があります time.
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 プラグインの代替案におけるプロダクトワークフローについては。