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/wifi/setWifiList.md.

setWifiList

设置 Wi-Fi 预设列表(iOS 特有)。

扫码预览

扫码预览 setWifiList

使用限制

WARNING

Android:豆包 Android 的 setWifiList 固定返回失败(setWifiList is iOS only);Android 上调用无法设置预设列表。

支持版本

前端库版本不低于 0.0.25。

支持平台

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

支持场景

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

接入准备

前置条件

  • iOS:需先调用 startWifi 完成初始化

使用说明

该接口为 iOS 特有,用于预设 Wi-Fi 列表。Android 不支持该能力,调用会失败。

  • Android:该 API 在 Android 上不可用,调用会返回失败

调用方式

异步 API

setWifiList(params: SetWifiListParams): Promise<object>

入参

名称类型必填默认值约束说明
wifiListWifiListItem[]是--预设的 Wi-Fi 列表。
wifiList[].bssidstring否--Wi-Fi BSSID。
wifiList[].passwordstring否--Wi-Fi 密码。
wifiList[].ssidstring否--Wi-Fi SSID。

调用示例

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

await setWifiList({
  wifiList: [{ ssid: 'Office-WiFi', password: 'password' }]
});

成功返回

无返回字段。

返回示例

{}

错误处理

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

失败示例

{
  "errNo": 1401001,
  "errMsg": "wifi is not initialized"
}

错误码

errNoerrMsg平台触发条件处理建议
103feature not supportAndroid该 API 为 iOS 特有,Android 调用固定失败不要在 Android 调用该 API
1401001wifi is not initializediOS调用前未先调用 startWifi 完成初始化先调用 startWifi 再设置预设列表

通用错误码

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

平台差异

  • Android:固定返回 103(该能力仅 iOS);iOS 未初始化返回 1401001,其他失败统一返回 102。