概要
概要セクション使用 @capgo/background-geolocation あなたのCapacitorアプリが、前面または背景で正確な位置情報の更新が必要な場合、またはiOSおよびAndroidでネイティブの円形の地理フェンス、WebViewが停止したときのバックエンドの地理フェンスのトランジションの配信が必要な場合に使用してください。
基本機能
基本機能セクションstart- 前面または背景で正確な位置情報の更新をストリームします。stop- アクティブな位置追跡をクリーンに停止します。openSettings- パーミッションの注意が必要なときにユーザーをネイティブの位置設定に送信します。setPlannedRoute- ユーザーが予定されたルートから逸脱したときにネイティブの音を再生します。setupGeofencing- ネイティブの地理フェンスのデフォルトを設定し、オプションのトランジションのWebhook配信を有効にします。addGeofence- iOSまたはAndroidの円形の地理フェンスの領域を監視するために識別子を使用します。removeGeofence/removeAllGeofences- 指定されたジオフェンスの監視を停止します。getMonitoredGeofences- Nativeレイヤーによって現在監視されている地域識別子の一覧を表示します。geofenceTransition- アプリがアクティブな場合にエントリーやエクィットイベントを受信します。geofenceError- Nativeの監視エラーを処理する方法を示します。
Public API
Section titled “Public API”| Method | Description |
|---|---|
start | 正確な前景または背景の位置情報の更新を取得します。 |
stop | 位置情報の更新を停止します。 |
openSettings | デバイスの位置設定のページを開きます。ユーザーに位置情報の有効化やパーミッションの調整を指示するのに役立ちます。 |
setPlannedRoute | プランされたルートからユーザーが逸脱した場合にネイティブの音を再生します。 |
setupGeofencing | 地理境界のデフォルト値とオプションのネイティブのトランジションPOST送信を構成します。 |
addGeofence | iOSとAndroidで円形の地理境界を監視します。 |
removeGeofence | 指定されたIDの1つの地理境界の監視を停止します。 |
removeAllGeofences | このプラグインによって登録されたすべての地理境界の監視を停止します。 |
getMonitoredGeofences | 現在ネイティブ層で監視されている識別子を返します。 |
addListener('geofenceTransition', ...) | アプリが起動中のときに地理境界の入退出イベントを受け取ります。 |
addListener('geofenceError', ...) | アプリが起動中のときにネイティブの地理境界監視エラーを受け取ります。 |
getPluginVersion | ネイティブのCapacitorプラグインのバージョンを取得します。 |
真実の源
「真実の源」というセクションこのリファレンスは src/definitions.ts in capacitor-background-geolocation.