uni.startWifi(option)

初始化Wi-Fi模块

本 API 是 uni ext api，需下载插件：uni-wifi

startWifi 兼容性 ^?

Android	iOS	HarmonyOS 系统版本	HarmonyOS
3.9.0	4.11	x	x

参数

名称	类型	必填	兼容性
option	WifiOption	是
名称 类型 必备 兼容性 success (res: UniWifiResult) => void 否 fail (res: UniError) => void 否 complete (res: any) => void 否

UniWifiResult 的属性值

名称	类型	必备	兼容性
errCode	number	是
errSubject	string	是
errMsg	string	是
wifi	UniWifiInfo	否
名称 类型 必备 兼容性 SSID string 是 BSSID string 否 secure boolean 否 signalStrength number 否 frequency number 否

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

uni.stopWifi(option)

关闭 Wi-Fi 模块

本 API 是 uni ext api，需下载插件：uni-wifi

stopWifi 兼容性 ^?

Android	iOS	HarmonyOS 系统版本	HarmonyOS
x	4.11	x	x

参数

名称	类型	必填	兼容性
option	WifiOption	是
名称 类型 必备 兼容性 success (res: UniWifiResult) => void 否 fail (res: UniError) => void 否 complete (res: any) => void 否

UniWifiResult 的属性值

名称	类型	必备	兼容性
errCode	number	是
errSubject	string	是
errMsg	string	是
wifi	UniWifiInfo	否
名称 类型 必备 兼容性 SSID string 是 BSSID string 否 secure boolean 否 signalStrength number 否 frequency number 否

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

uni.connectWifi(option)

connectWifi 兼容性 ^?

Android 系统版本	Android	iOS	HarmonyOS 系统版本	HarmonyOS
>=4.4 && <10.0	3.9.0	4.11	x	x

参数

名称	类型	必填	兼容性
option	WifiConnectOption	是
名称 类型 必备 兼容性 SSID string 否 BSSID string 否 password string 否 maunal boolean 否 partialInfo boolean 否 success (res: UniWifiResult) => void 否 fail (res: UniError) => void 否 complete (res: any) => void 否

UniWifiResult 的属性值

名称	类型	必备	兼容性
errCode	number	是
errSubject	string	是
errMsg	string	是
wifi	UniWifiInfo	否
名称 类型 必备 兼容性 SSID string 是 BSSID string 否 secure boolean 否 signalStrength number 否 frequency number 否

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

uni.setWifiList(option)

SetWifiList 暂未实现

本 API 是 uni ext api，需下载插件：uni-wifi

setWifiList 兼容性 ^?

Android 系统版本	Android	iOS 系统版本	iOS	HarmonyOS 系统版本	HarmonyOS
x	x	x	x	x	x

参数

名称	类型	必填	兼容性	描述
option	WifiOption	是		Wifi 函数通用入参封装
名称 类型 必备 兼容性 success (res: UniWifiResult) => void 否 fail (res: UniError) => void 否 complete (res: any) => void 否

UniWifiResult 的属性值

名称	类型	必备	兼容性
errCode	number	是
errSubject	string	是
errMsg	string	是
wifi	UniWifiInfo	否
名称 类型 必备 兼容性 SSID string 是 BSSID string 否 secure boolean 否 signalStrength number 否 frequency number 否

参见

• 相关 Bug
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

uni.getWifiList(option)

请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。

本 API 是 uni ext api，需下载插件：uni-wifi

getWifiList 兼容性 ^?

Android	iOS	HarmonyOS 系统版本	HarmonyOS
3.9.0	4.11	x	x

参数

名称	类型	必填	兼容性
option	WifiOption	是
名称 类型 必备 兼容性 success (res: UniWifiResult) => void 否 fail (res: UniError) => void 否 complete (res: any) => void 否

UniWifiResult 的属性值

名称	类型	必备	兼容性
errCode	number	是
errSubject	string	是
errMsg	string	是
wifi	UniWifiInfo	否
名称 类型 必备 兼容性 SSID string 是 BSSID string 否 secure boolean 否 signalStrength number 否 frequency number 否

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

uni.onGetWifiList(UniWifiCallback)

监听获取到 Wi-Fi 列表数据事件。

本 API 是 uni ext api，需下载插件：uni-wifi

onGetWifiList 兼容性 ^?

Android	iOS	HarmonyOS 系统版本	HarmonyOS
3.9.0	4.11	x	x

参数

名称	类型	必填	兼容性
callback	(wifiInfo: Record<string, any>) => void	是

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

uni.offGetWifiList(UniWifiCallback)

移除获取到 Wi-Fi 列表数据事件的监听函数。

本 API 是 uni ext api，需下载插件：uni-wifi

offGetWifiList 兼容性 ^?

Android	iOS	HarmonyOS 系统版本	HarmonyOS
3.9.0	4.11	x	x

参数

名称	类型	必填	兼容性
callback	() => void	是

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

uni.getConnectedWifi(option)

获取已连接的 Wi-Fi 信息

本 API 是 uni ext api，需下载插件：uni-wifi

getConnectedWifi 兼容性 ^?

Android	iOS	HarmonyOS 系统版本	HarmonyOS
3.9.0	4.11	x	x

参数

名称	类型	必填	兼容性
option	GetConnectedWifiOptions	是
名称 类型 必备 兼容性 partialInfo boolean 否 success (res: UniWifiResult) => void 否 fail (res: UniError) => void 否 complete (res: any) => void 否

UniWifiResult 的属性值

名称	类型	必备	兼容性
errCode	number	是
errSubject	string	是
errMsg	string	是
wifi	UniWifiInfo	否
名称 类型 必备 兼容性 SSID string 是 BSSID string 否 secure boolean 否 signalStrength number 否 frequency number 否

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

uni.onWifiConnected(UniWifiCallback)

监听连接上 Wi-Fi 的事件

本 API 是 uni ext api，需下载插件：uni-wifi

onWifiConnected 兼容性 ^?

Android	iOS	HarmonyOS 系统版本	HarmonyOS
3.9.0	4.11	x	x

参数

名称	类型	必填	兼容性
callback	(wifiInfo: UniWifiResult) => void	是

UniWifiResult 的属性值

名称	类型	必备	兼容性
errCode	number	是
errSubject	string	是
errMsg	string	是
wifi	UniWifiInfo	否
名称 类型 必备 兼容性 SSID string 是 BSSID string 否 secure boolean 否 signalStrength number 否 frequency number 否

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

uni.onWifiConnectedWithPartialInfo(UniWifiCallback)

监听连接上 Wi-Fi 的事件。

本 API 是 uni ext api，需下载插件：uni-wifi

onWifiConnectedWithPartialInfo 兼容性 ^?

Android	iOS
3.9.0	4.11

参数

名称	类型	必填
callback	(wifiInfo: UniWifiInfoWithPartialInfo) => void	是

UniWifiInfoWithPartialInfo 的属性值

名称	类型	必备
SSID	string	是

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

uni.offWifiConnected(callback?)

移除连接上 Wi-Fi 的事件的监听函数。

本 API 是 uni ext api，需下载插件：uni-wifi

offWifiConnected 兼容性 ^?

Android	iOS	HarmonyOS 系统版本	HarmonyOS
3.9.0	4.11	x	x

参数

名称	类型	必填	兼容性
callback	() => void	否

参见

• 相关 Bug
• 参见uni-app相关文档
• 微信小程序文档
• 支付宝小程序文档
• 百度小程序文档
• 抖音小程序文档
• 飞书小程序文档
• 钉钉小程序文档
• QQ小程序文档
• 快手小程序文档
• 京东小程序文档
• 华为快应用文档
• 360小程序文档

通用类型

GeneralCallbackResult

名称	类型	必备	兼容性	描述
errMsg	string	是		错误信息