跳转到正文

@capgo/background-geolocation

为 Capacitor 应用提供精准的后台位置追踪、原生地理围栏进入/退出事件和状态变更 webhook。

使用 @capgo/background-geolocation 当您的 Capacitor 应用在前端或后台需要精确的位置更新时,本插件可提供 iOS 和 Android 的原生地理围栏(geofence)功能,并在 WebView 挂起时通过后端推送地理围栏状态变更。

  • start - 持续获取精准的前台或后台位置更新。
  • stop - 优雅地停止活跃的位置追踪。
  • openSettings - 当权限需要关注时,引导用户前往原生位置设置。
  • setPlannedRoute - 当用户偏离预定路线时,播放原生提示音。
  • setupGeofencing - 配置原生地理围栏默认值及可选的 transition webhook 投递。
  • addGeofence - 通过标识符监控 iOS 或 Android 的圆形地理围栏区域。
  • removeGeofence / removeAllGeofences - 停止监控一个或所有已注册的地理围栏。
  • getMonitoredGeofences - 列出当前由原生层监控的所有区域标识符。
  • geofenceTransition listener - 在 App 处于活跃状态时接收进入和退出事件。
  • geofenceError listener - 处理原生监控错误,且不改变 transition 事件的结构。
方法描述
start流式传输精准的前台或后台位置更新。
stop停止位置更新。
openSettings打开设备的定位设置页面。适用于引导用户开启定位服务或调整权限。
setPlannedRoute当用户偏离预定路线时,播放原生提示音。
setupGeofencing配置地理围栏默认值及可选的原生状态转换 POST 投递。
addGeofence在 iOS 和 Android 上开始监控圆形地理围栏。
removeGeofence按标识符停止监控单个地理围栏。
removeAllGeofences停止监控该插件注册的所有地理围栏。
getMonitoredGeofences返回当前由原生层监控的标识符。
addListener('geofenceTransition', ...)在 App 运行期间接收地理围栏进入和离开事件。
addListener('geofenceError', ...)在 App 运行期间接收原生地理围栏监控错误。
getPluginVersion获取原生 Capacitor 插件版本。

此参考文档同步自 src/definitions.ts 中的 capacitor-background-geolocation.

如果你正在使用 @capgo/background-geolocation 要规划原生插件工作,请将其与 使用 @capgo/background-geolocation 关于使用 @capgo/background-geolocation 时的原生能力, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节, 添加或更新插件 关于“添加或更新插件”中的实现细节,以及 Ionic Enterprise 插件替代方案 关于“Ionic Enterprise 插件替代方案”中的产品工作流。