指南
如何在 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 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。