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/startBeaconDiscovery.md.

startBeaconDiscovery

开始搜索附近的 iBeacon。

扫码预览

扫码预览 startBeaconDiscovery

使用限制

WARNING

Android:Android 不读取该字段,蓝牙不可用时仍会失败;Android 调用方设置该参数不会生效。

支持版本

前端库版本不低于 0.0.25。

支持平台

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

支持场景

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

接入准备

权限要求

类型标识是否必须平台说明
系统权限定位权限必须Android、iOS需要定位权限以搜索 iBeacon
系统权限蓝牙权限必须Android、iOS需要蓝牙权限以搜索 iBeacon

授权行为

  • 调用会主动申请定位和蓝牙权限。用户拒绝后再次调用会直接失败,需引导用户在系统设置中开启定位和蓝牙权限后重试。

前置条件

  • 确保设备蓝牙已开启,并授予定位和蓝牙权限

使用说明

需配对调用 stopBeaconDiscovery。

  • 使用限制:Android 会忽略 ignoreBluetoothAvailable,蓝牙不可用时仍会失败;不再需要时调用 stopBeaconDiscovery

调用方式

异步 API

startBeaconDiscovery(params: StartBeaconDiscoveryParams): Promise<object>

入参

名称类型必填默认值约束说明
ignoreBluetoothAvailableboolean否false仅 iOS 生效,Android 忽略该字段iOS 下是否忽略蓝牙可用性校验。Android:Android 不读取该字段,蓝牙不可用时仍会失败。
uuidsstring[]是--要搜索的 iBeacon UUID 列表。

调用示例

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

await startBeaconDiscovery({ uuids: ['FDA50693-A4E2-4FB1-AFCF-C6EB07647825'] });

成功返回

无返回字段。

返回示例

{}

错误处理

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

失败示例

{
  "errNo": 104,
  "errMsg": "invalid parameter"
}

错误码

errNoerrMsg平台触发条件处理建议
104invalid parameterAndroid、iOSuuids 为空传入至少一个合法的 iBeacon UUID
106system permission deniedAndroid、iOS定位或蓝牙权限未授予在系统设置中授予定位和蓝牙权限后重试
116resource not foundAndroid、iOS蓝牙不可用或已关闭开启蓝牙后重试
103feature not supportiOS当前设备不支持 iBeacon 搜索更换支持 iBeacon 的设备

通用错误码

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

平台差异

  • iOS:支持通过 ignoreBluetoothAvailable 跳过蓝牙可用性校验