- 动态与公告
- 产品简介
- 购买指南
- 快速入门
- 平台功能介绍
- 代码接入指引
- 小程序开发指南
- 常见问题
- API 文档
- Application APIs
- Management-Sensitive APIs
- Platform Management APIs
- Mini Program APIs
- DescribeMNPOfflinePackageURL
- CreateMNPDomainACL
- CreateMNP
- ReleaseMNPVersion
- CreateMNPApproval
- DescribeMNPAllStageVersions
- DeleteMNP
- DescribeMNP
- DescribeMNPList
- DescribeMNPCategory
- DescribeMNPPreview
- ModifyMNP
- ConfigureMNPPreview
- ProcessMNPApproval
- CreateMNPVersion
- DescribeMNPVersion
- DescribeMNPReleasedVersionHistory
- RemoveMNP
- RollbackMNPVersion
- Team Management APIs
- Global Domain Management APIs
- User Management APIs
- Role Management APIs
- Sensitive API-related APIs
- 相关协议
- 动态与公告
- 产品简介
- 购买指南
- 快速入门
- 平台功能介绍
- 代码接入指引
- 小程序开发指南
- 常见问题
- API 文档
- Application APIs
- Management-Sensitive APIs
- Platform Management APIs
- Mini Program APIs
- DescribeMNPOfflinePackageURL
- CreateMNPDomainACL
- CreateMNP
- ReleaseMNPVersion
- CreateMNPApproval
- DescribeMNPAllStageVersions
- DeleteMNP
- DescribeMNP
- DescribeMNPList
- DescribeMNPCategory
- DescribeMNPPreview
- ModifyMNP
- ConfigureMNPPreview
- ProcessMNPApproval
- CreateMNPVersion
- DescribeMNPVersion
- DescribeMNPReleasedVersionHistory
- RemoveMNP
- RollbackMNPVersion
- Team Management APIs
- Global Domain Management APIs
- User Management APIs
- Role Management APIs
- Sensitive API-related APIs
- 相关协议
stopBeaconDiscovery
该 API 使用方法为 wx.stopBeaconDiscovery(Object object)
功能说明：停止搜索附近的 Beacon 设备。
参数及说明：Object object。
属性 | 类型 | 默认值 | 必填 | 说明 |
success | function | - | 否 | 接口调用成功的回调函数 |
fail | function | - | 否 | 接口调用失败的回调函数 |
complete | function | - | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
错误码
错误码 | 错误信息 | 说明 |
0 | ok | 正常 |
11000 | unsupport | 系统或设备不支持 |
11001 | bluetooth service unavailable | 蓝牙服务不可用 |
11002 | location service unavailable | 位置服务不可用 |
11003 | already start | 已经开始搜索 |
11004 | not startBeaconDiscovery | 还未开始搜索 |
11005 | system error | 系统错误 |
11006 | invalid data | 参数不正确 |
startBeaconDiscovery
该 API 使用方法为 wx.startBeaconDiscovery(Object object)
功能说明：开始搜索附近的 Beacon 设备。
参数及说明：Object object。
属性 | 类型 | 默认值 | 必填 | 说明 |
uuids | Array.<string> | - | 是 | Beacon 设备广播的 UUID 列表 |
ignoreBluetoothAvailable | boolean | false | 否 | 是否校验蓝牙开关，仅在 iOS 下有效。iOS 11 起，控制面板里关掉蓝牙，还是能继续使用 Beacon 服务 |
success | function | - | 否 | 接口调用成功的回调函数 |
fail | function | - | 否 | 接口调用失败的回调函数 |
complete | function | - | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
错误码
错误码 | 错误信息 | 说明 |
0 | ok | 正常 |
11000 | unsupport | 系统或设备不支持 |
11001 | bluetooth service unavailable | 蓝牙服务不可用 |
11002 | location service unavailable | 位置服务不可用 |
11003 | already start | 已经开始搜索 |
11004 | not startBeaconDiscovery | 还未开始搜索 |
11005 | system error | 系统错误 |
11006 | invalid data | 参数不正确 |
示例代码：
wx.startBeaconDiscovery({success(res) { }})
onBeaconUpdate
该 API 使用方法为 wx.onBeaconUpdate(function listener)
功能说明：监听 Beacon 设备更新事件，仅能注册一个监听。
参数及说明：function listener，Beacon 设备更新事件的监听函数，参数 Object res 如下：
属性 | 类型 | 说明 |
beacons | 当前搜寻到的所有 Beacon 设备列表 |
示例代码：
wx.onBeaconUpdate(res => {console.log(res.beacons)})
offBeaconUpdate
该 API 使用方法为 wx.offBeaconUpdate()
功能说明：移除 Beacon 设备更新事件的全部监听函数。
示例代码：
wx.offBeaconUpdate()
onBeaconServiceChange
该 API 使用方法为 wx.onBeaconServiceChange(function listener)
功能说明：监听 Beacon 服务状态变化事件，仅能注册一个监听。
参数及说明：function listener，Beacon 服务状态变化事件的监听函数，参数 Object res 如下：
属性 | 类型 | 说明 |
available | boolean | 服务目前是否可用 |
discovering | boolean | 目前是否处于搜索状态 |
示例代码：
wx.onBeaconServiceChange(res => {console.log(res.available, res.discovering)})
offBeaconServiceChange
该 API 使用方法为 wx.offBeaconServiceChange()
功能说明：移除 Beacon 服务状态变化事件的全部监听函数。
示例代码：
wx.offBeaconServiceChange()
getBeacons
该 API 使用方法为 wx.getBeacons(Object object)
功能说明：获取所有已搜索到的 Beacon 设备。
参数及说明：Object object。
属性 | 类型 | 默认值 | 必填 | 说明 |
success | function | - | 否 | 接口调用成功的回调函数 |
fail | function | - | 否 | 接口调用失败的回调函数 |
complete | function | - | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |
object.success 回调函数参数：Object res。
属性 | 类型 | 说明 |
beacons | Beacon 设备列表 |
错误码
错误码 | 错误信息 | 说明 |
0 | ok | 正常 |
11000 | unsupport | 系统或设备不支持 |
11001 | bluetooth service unavailable | 蓝牙服务不可用 |
11002 | location service unavailable | 位置服务不可用 |
11003 | already start | 已经开始搜索 |
11004 | not startBeaconDiscovery | 还未开始搜索 |
11005 | system error | 系统错误 |
11006 | invalid data | 参数不正确 |
BeaconInfo
功能说明：Beacon 设备。
属性及说明
属性名 | 类型 | 说明 |
uuid | string | Beacon 设备广播的 UUID |
major | number | Beacon 设备的主 ID |
minor | number | Beacon 设备的次 ID |
proximity | number | 表示设备距离的枚举值（仅iOS） |
accuracy | number | Beacon 设备的距离，单位 m。iOS 上，proximity 为 0 时，accuracy 为 -1 |
rssi | number | 表示设备的信号强度，单位 dBm |
proximity 的合法值
值 | 说明 |
0 | 信号太弱不足以计算距离，或非 iOS 设备 |
1 | 十分近 |
2 | 比较近 |
3 | 远 |
是
否
本页内容是否解决了您的问题？