跳转至正文

iBeacon Capacitor 插件

Capacitor 的 iBeacon 插件 - 接近检测与 beacon 区域监控

安装

bun add @capgo/capacitor-ibeacon bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-ibeacon
  • pnpm add @capgo/capacitor-ibeacon
  • yarn add @capgo/capacitor-ibeacon

指南

如何在 Capacitor 中使用 iBeacon

使用 @capgo/capacitor-ibeacon

Capacitor iBeacon 插件 - 邻近检测与信标区域监控。

安装

bun add @capgo/capacitor-ibeacon
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

API 概览

方法 描述
startMonitoringForRegion 开始监测 Beacon 区域。进入或离开该区域时触发事件。
stopMonitoringForRegion 停止监测 Beacon 区域。
startRangingBeaconsInRegion 开始对区域内的 Beacon 进行测距,持续提供距离更新。
stopRangingBeaconsInRegion 停止区域内的 Beacon 测距。
startAdvertising 开始将设备作为 iBeacon 广播(仅限 iOS)。
stopAdvertising 停止将设备作为 iBeacon 广播(仅限 iOS)。
requestWhenInUseAuthorization 请求“使用App期间”位置授权(测距/监控必需)。
requestAlwaysAuthorization 请求“始终”位置授权(后台监测必需)。
getAuthorizationStatus 获取当前位置授权状态。
isBluetoothEnabled 检查设备蓝牙是否已开启。
isRangingAvailable 检查设备是否支持 ranging 功能。
enableARMAFilter 为距离计算启用 ARMA 滤波(仅限 Android)。
enableBackgroundMode 启用或禁用后台 Beacon 扫描模式(仅 Android)。该模式会启用前台服务,以实现可靠的后台 Beacon 检测。必须在请求“始终”位置授权后调用。
setBackgroundScanPeriod 配置后台扫描周期(仅 Android)。控制设备在后台扫描 Beacon 的频率和时长。

示例

startMonitoringForRegion()

开始监测 Beacon 区域。进入或离开该区域时触发事件。

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.startMonitoringForRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

stopMonitoringForRegion()

停止监测 Beacon 区域。

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.stopMonitoringForRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

startRangingBeaconsInRegion()

开始对区域内的 Beacon 进行测距,持续提供距离更新。

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.startRangingBeaconsInRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

stopRangingBeaconsInRegion()

停止区域内的 Beacon 测距。

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.stopRangingBeaconsInRegion({
  identifier: 'MyBeaconRegion',
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D'
});

startAdvertising()

开始将设备作为 iBeacon 广播(仅限 iOS)。

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.startAdvertising({
  uuid: 'B9407F30-F5F8-466E-AFF9-25556B57FE6D',
  major: 1,
  minor: 2,
  identifier: 'MyBeacon'
});

stopAdvertising()

停止将设备作为 iBeacon 广播(仅限 iOS)。

import { CapacitorIbeacon } from '@capgo/capacitor-ibeacon';

await CapacitorIbeacon.stopAdvertising();

上表列出了 14 个核心方法。监听器与版本辅助函数,以及每个方法的完整规范,均记录在 GitHub 仓库.

监听事件

addListener 会返回一个句柄。调用 handle.remove() 在屏幕卸载时,或者调用 CapacitorIbeacon.removeAllListeners() 以清除所有监听器。

完整参考文档

继续了解如何使用 @capgo/capacitor-ibeacon

如果你正在使用 使用 @capgo/capacitor-ibeacon 要规划原生插件工作,请将其与 @capgo/capacitor-ibeacon 有关 @capgo/capacitor-ibeacon 的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

iBeacon 插件常见问题

如何在 Capacitor 应用中安装 iBeacon 插件?

运行 "bun add @capgo/capacitor-ibeacon"(或 "npm install @capgo/capacitor-ibeacon"),然后运行 "bunx cap sync",以便 iOS 和 Android 项目获取原生 code。在您的应用 code 中从 "@capgo/capacitor-ibeacon" 导入它。

@capgo/capacitor-ibeacon 支持 React、Vue 和 Angular 吗?

支持。iBeacon 是一个 Capacitor 包,因此适用于任何在 Capacitor 内运行的 Web 框架,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-ibeacon 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-ibeacon 是免费且开源的吗?

是的。code 源代码公开在 GitHub 上,地址为 https://github.com/Cap-go/capacitor-ibeacon/,并且可以从 npm 免费安装该包。欢迎提交 Bug 报告和 Pull Request。

我可以更新使用 iBeacon 的 code 而无需经过 App Store 审核吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待应用审核,即可发布 iBeacon 变更

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo