> 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.

# startBeaconDiscovery

开始搜索附近的 iBeacon。

## 扫码预览

![扫码预览 startBeaconDiscovery](https://api.qrserver.com/v1/create-qr-code/?size=200x200\&data=doubao%3A%2F%2Fdoubao_apps%3Fapp_id%3Ddb_1McM5Ni%26path%3D%252Fpages%252Fapi%252Fdevice%252Fbeacon%252Findex)

## 使用限制

> \[!WARNING]
> **Android**：Android 不读取该字段，蓝牙不可用时仍会失败；Android 调用方设置该参数不会生效。

## 支持版本

前端库版本不低于 `0.0.25`。

## 支持平台

<table>
<thead>
<tr><th>平台</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>Android</td><td>支持</td></tr>
<tr><td>iOS</td><td>支持</td></tr>
<tr><td>PC</td><td>不支持</td></tr>
<tr><td>HarmonyOS</td><td>不支持</td></tr>
</tbody>
</table>

## 支持场景

<table>
<thead>
<tr><th>场景</th><th>支持情况</th></tr>
</thead>
<tbody>
<tr><td>页面</td><td>支持</td></tr>
<tr><td>卡片</td><td>不支持</td></tr>
</tbody>
</table>

## 接入准备

### 权限要求

<table>
<thead>
<tr><th>类型</th><th>标识</th><th>是否必须</th><th>平台</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td>系统权限</td><td>定位权限</td><td>必须</td><td>Android、iOS</td><td>需要定位权限以搜索 iBeacon</td></tr>
<tr><td>系统权限</td><td>蓝牙权限</td><td>必须</td><td>Android、iOS</td><td>需要蓝牙权限以搜索 iBeacon</td></tr>
</tbody>
</table>

### 授权行为

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

### 前置条件

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

## 使用说明

需配对调用 stopBeaconDiscovery。

- 使用限制：Android 会忽略 `ignoreBluetoothAvailable`，蓝牙不可用时仍会失败；不再需要时调用 `stopBeaconDiscovery`

## 调用方式

### 异步 API

```typescript
startBeaconDiscovery(params: StartBeaconDiscoveryParams): Promise<object>
```

## 入参

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必填</th><th>默认值</th><th>约束</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>ignoreBluetoothAvailable</code></td><td><code>boolean</code></td><td>否</td><td><code>false</code></td><td>仅 iOS 生效，Android 忽略该字段</td><td>iOS 下是否忽略蓝牙可用性校验。Android：Android 不读取该字段，蓝牙不可用时仍会失败。</td></tr>
<tr><td><code>uuids</code></td><td><code>string[]</code></td><td>是</td><td>-</td><td>-</td><td>要搜索的 iBeacon UUID 列表。</td></tr>
</tbody>
</table>

## 调用示例

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

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

## 成功返回

无返回字段。

### 返回示例

```json
{}
```

## 错误处理

错误对象和通用错误码见 [通用错误处理](/apps-plugin/docs/js-api/common-errors.md#错误返回)。

### 失败示例

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

### 错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
</thead>
<tbody>
<tr><td><code>104</code></td><td><code>invalid parameter</code></td><td>Android、iOS</td><td>uuids 为空</td><td>传入至少一个合法的 iBeacon UUID</td></tr>
<tr><td><code>106</code></td><td><code>system permission denied</code></td><td>Android、iOS</td><td>定位或蓝牙权限未授予</td><td>在系统设置中授予定位和蓝牙权限后重试</td></tr>
<tr><td><code>116</code></td><td><code>resource not found</code></td><td>Android、iOS</td><td>蓝牙不可用或已关闭</td><td>开启蓝牙后重试</td></tr>
<tr><td><code>103</code></td><td><code>feature not support</code></td><td>iOS</td><td>当前设备不支持 iBeacon 搜索</td><td>更换支持 iBeacon 的设备</td></tr>
</tbody>
</table>

#### 通用错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>说明</th><th>平台</th></tr>
</thead>
<tbody>
<tr><td><code>102</code></td><td><code>internal error</code></td><td>内部错误</td><td>Android、iOS</td></tr>
</tbody>
</table>

## 平台差异

- **iOS**：支持通过 `ignoreBluetoothAvailable` 跳过蓝牙可用性校验
