For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/device/ibeacon/getBeacons.md.

getBeacons

获取已搜索到的 iBeacon 列表。

扫码预览

扫码预览 getBeacons

支持版本

前端库版本不低于 0.0.25。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片不支持

接入准备

权限要求

类型标识是否必须平台说明
系统权限定位权限按条件AndroidAndroid 获取列表时会校验定位权限
系统权限蓝牙权限按条件AndroidAndroid 获取列表时会校验蓝牙权限

授权行为

  • Android:获取列表时会校验定位和蓝牙权限,权限缺失时调用可能失败;在系统设置中授予对应权限后可正常调用。

前置条件

  • 无额外前置条件;通常在 startBeaconDiscovery 后调用

使用说明

  • 使用限制:iOS 恒返回成功,Android 权限缺失时可能失败

调用方式

异步 API

getBeacons(params?: object): Promise<GetBeaconsResult>

入参

无。

调用示例

import { getBeacons } from '@doubao-dev/framework/api';

const { beacons } = await getBeacons();

console.log(beacons);

成功返回

名称类型必返说明
beaconsBeaconInfo[]是当前搜到的 iBeacon 列表。
beacons[].accuracynumber是距离,单位米。
beacons[].majornumber是主 ID。
beacons[].minornumber是次 ID。
beacons[].proximityBeaconProximity是距离等级。
beacons[].rssinumber是RSSI 信号强度,单位 dBm。
beacons[].uuidstring是Beacon UUID。

返回示例

{
  "beacons": [
    {
      "uuid": "FDA50693-A4E2-4FB1-AFCF-C6EB07647825",
      "major": 10001,
      "minor": 19641,
      "proximity": 1,
      "accuracy": 0.52,
      "rssi": -59
    }
  ]
}

错误处理

错误对象和通用错误码见 通用错误处理。

失败示例

{
  "errNo": 106,
  "errMsg": "system permission denied"
}

错误码

errNoerrMsg平台触发条件处理建议
106system permission deniedAndroid定位或蓝牙权限未授予在系统设置中授予定位和蓝牙权限后重试

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android

平台差异

  • iOS:获取列表恒返回成功,不校验权限