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

# getBeacons

获取已搜索到的 iBeacon 列表。

## 扫码预览

![扫码预览 getBeacons](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)

## 支持版本

前端库版本不低于 `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</td><td>Android 获取列表时会校验定位权限</td></tr>
<tr><td>系统权限</td><td>蓝牙权限</td><td>按条件</td><td>Android</td><td>Android 获取列表时会校验蓝牙权限</td></tr>
</tbody>
</table>

### 授权行为

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

### 前置条件

- 无额外前置条件；通常在 `startBeaconDiscovery` 后调用

## 使用说明

- 使用限制：iOS 恒返回成功，Android 权限缺失时可能失败

## 调用方式

### 异步 API

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

## 入参

无。

## 调用示例

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

const { beacons } = await getBeacons();

console.log(beacons);
```

## 成功返回

<table>
<thead>
<tr><th>名称</th><th>类型</th><th>必返</th><th>说明</th></tr>
</thead>
<tbody>
<tr><td><code>beacons</code></td><td><code>BeaconInfo[]</code></td><td>是</td><td>当前搜到的 iBeacon 列表。</td></tr>
<tr><td><code>beacons[].accuracy</code></td><td><code>number</code></td><td>是</td><td>距离，单位米。</td></tr>
<tr><td><code>beacons[].major</code></td><td><code>number</code></td><td>是</td><td>主 ID。</td></tr>
<tr><td><code>beacons[].minor</code></td><td><code>number</code></td><td>是</td><td>次 ID。</td></tr>
<tr><td><code>beacons[].proximity</code></td><td><code>BeaconProximity</code></td><td>是</td><td>距离等级。</td></tr>
<tr><td><code>beacons[].rssi</code></td><td><code>number</code></td><td>是</td><td>RSSI 信号强度，单位 dBm。</td></tr>
<tr><td><code>beacons[].uuid</code></td><td><code>string</code></td><td>是</td><td>Beacon UUID。</td></tr>
</tbody>
</table>

### 返回示例

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

## 错误处理

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

### 失败示例

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

### 错误码

<table>
<thead>
<tr><th>errNo</th><th>errMsg</th><th>平台</th><th>触发条件</th><th>处理建议</th></tr>
</thead>
<tbody>
<tr><td><code>106</code></td><td><code>system permission denied</code></td><td>Android</td><td>定位或蓝牙权限未授予</td><td>在系统设置中授予定位和蓝牙权限后重试</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</td></tr>
</tbody>
</table>

## 平台差异

- **iOS**：获取列表恒返回成功，不校验权限
