[UTS蓝牙插件文档] getSPPClients 接口描述文档

getSPPClients

获取当前所有存活的 SPP 连接（客户端）列表。

所属能力组：经典蓝牙 SPP（Serial Port Profile / RFCOMM）串口通信
支持平台：Android、鸿蒙 NEXT（iOS 不支持，统一回调错误码 10020）

功能说明

返回插件当前持有的全部 SPP 连接信息。列表中的连接既包括 createSPPClient 主动连接得到的连接，也包括服务端 onSPPClientCreateByServer accept 得到的连接；可通过 fromServer 字段区分。

返回的是当前存活的连接快照，适合用于查询状态或在多连接场景下做界面刷新。

请求参数 GetSPPClientsOptions

参数	类型	必填	默认值	说明
success	function	否	-	接口调用成功的回调函数
fail	function	否	-	接口调用失败的回调函数
complete	function	否	-	接口调用结束的回调函数（成功、失败都会执行）

不传 success / fail / complete 时，接口返回 Promise。

成功回调结果 GetSPPClientsSuccessCallbackResult

字段	类型	说明
clients	SPPClientInfo[]	当前所有存活的 SPP 连接列表
errMsg	string	错误信息，成功时为 getSPPClients:ok

SPPClientInfo

字段	类型	说明
socketId	number	连接标识
deviceId	string	该连接对应的设备 id（服务端 accept 得到的连接可能为空串）
fromServer	boolean	该连接是主动连接（false）还是服务端 accept 得到的（true）

返回 Promise

未传任何回调时返回 Promise<GetSPPClientsSuccessCallbackResult>。

错误码

错误码	说明
10000	未初始化蓝牙适配器
10008	系统异常
10020	当前平台不支持 SPP（iOS）

示例

import * as UTSBLE from '@/uni_modules/xl-uts-bluetooth/jssdk/BLE.js';

UTSBLE.getSPPClients({
    success: (res) => {
        res.clients.forEach((c) => {
            console.log('socketId =', c.socketId, 'deviceId =', c.deviceId, 'fromServer =', c.fromServer);
        });
    },
});

// Promise 风格
const res = await UTSBLE.getSPPClients();
console.log('连接数量 =', res.clients.length);