Wifi

uni.startWifi(option) @startwifi

初始化Wi-Fi模块

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

startWifi 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
option	WifiOption	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

option 的属性描述

名称	类型	必备	默认值	兼容性	描述
success	(res: UniWifiResult) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
fail	(res: UniError) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
complete	(res: any) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

UniWifiResult 的属性值 @uniwifiresult-values

名称	类型	必备	默认值	兼容性	描述
errCode	number	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errSubject	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errMsg	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
wifi	UniWifiInfo	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

wifi 的属性描述

名称	类型	必备	默认值	兼容性	描述
SSID	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
BSSID	string	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
secure	boolean	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
signalStrength	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
frequency	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

参见

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

uni.stopWifi(option) @stopwifi

关闭 Wi-Fi 模块

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

stopWifi 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	4.11	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
option	WifiOption	是	-	Web: -; 微信小程序: -; Android: x; iOS: -; HarmonyOS: x

option 的属性描述

名称	类型	必备	默认值	兼容性	描述
success	(res: UniWifiResult) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
fail	(res: UniError) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
complete	(res: any) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

UniWifiResult 的属性值 @uniwifiresult-values

名称	类型	必备	默认值	兼容性	描述
errCode	number	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errSubject	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errMsg	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
wifi	UniWifiInfo	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

wifi 的属性描述

名称	类型	必备	默认值	兼容性	描述
SSID	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
BSSID	string	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
secure	boolean	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
signalStrength	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
frequency	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

参见

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

uni.connectWifi(option) @connectwifi

connectWifi 兼容性

Web	微信小程序	Android 系统版本	Android	iOS	HarmonyOS
-	-	>=4.4 && <10.0	3.9.0	4.11	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
option	WifiConnectOption	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

option 的属性描述

名称	类型	必备	默认值	兼容性	描述
SSID	string	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
BSSID	string	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
password	string	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
maunal	boolean	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
partialInfo	boolean	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
success	(res: UniWifiResult) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
fail	(res: UniError) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
complete	(res: any) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

UniWifiResult 的属性值 @uniwifiresult-values

名称	类型	必备	默认值	兼容性	描述
errCode	number	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errSubject	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errMsg	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
wifi	UniWifiInfo	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

wifi 的属性描述

名称	类型	必备	默认值	兼容性	描述
SSID	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
BSSID	string	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
secure	boolean	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
signalStrength	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
frequency	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

参见

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

uni.setWifiList(option) @setwifilist

SetWifiList 暂未实现

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

setWifiList 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
option	WifiOption	是	-	Web: -; 微信小程序: -; Android: x; iOS: x; HarmonyOS: x	Wifi 函数通用入参封装

option 的属性描述

名称	类型	必备	默认值	兼容性	描述
success	(res: UniWifiResult) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
fail	(res: UniError) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
complete	(res: any) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

UniWifiResult 的属性值 @uniwifiresult-values

名称	类型	必备	默认值	兼容性	描述
errCode	number	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errSubject	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errMsg	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
wifi	UniWifiInfo	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

wifi 的属性描述

名称	类型	必备	默认值	兼容性	描述
SSID	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
BSSID	string	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
secure	boolean	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
signalStrength	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
frequency	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

参见

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

uni.getWifiList(option) @getwifilist

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

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

getWifiList 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
option	WifiOption	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

option 的属性描述

名称	类型	必备	默认值	兼容性	描述
success	(res: UniWifiResult) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
fail	(res: UniError) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
complete	(res: any) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

UniWifiResult 的属性值 @uniwifiresult-values

名称	类型	必备	默认值	兼容性	描述
errCode	number	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errSubject	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errMsg	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
wifi	UniWifiInfo	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

wifi 的属性描述

名称	类型	必备	默认值	兼容性	描述
SSID	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
BSSID	string	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
secure	boolean	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
signalStrength	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
frequency	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

参见

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

uni.onGetWifiList(UniWifiCallback) @ongetwifilist

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

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

onGetWifiList 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
callback	(wifiInfo: Record<string, any>) => void	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

参见

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

uni.offGetWifiList(UniWifiCallback) @offgetwifilist

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

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

offGetWifiList 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
callback	() => void	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

参见

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

uni.getConnectedWifi(option) @getconnectedwifi

获取已连接的 Wi-Fi 信息

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

getConnectedWifi 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
option	GetConnectedWifiOptions	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

option 的属性描述

名称	类型	必备	默认值	兼容性	描述
partialInfo	boolean	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
success	(res: UniWifiResult) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
fail	(res: UniError) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
complete	(res: any) => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

UniWifiResult 的属性值 @uniwifiresult-values

名称	类型	必备	默认值	兼容性	描述
errCode	number	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errSubject	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errMsg	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
wifi	UniWifiInfo	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

wifi 的属性描述

名称	类型	必备	默认值	兼容性	描述
SSID	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
BSSID	string	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
secure	boolean	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
signalStrength	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
frequency	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

参见

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

uni.onWifiConnected(UniWifiCallback) @onwificonnected

监听连接上 Wi-Fi 的事件

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

onWifiConnected 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
callback	(wifiInfo: UniWifiResult) => void	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

UniWifiResult 的属性值 @uniwifiresult-values

名称	类型	必备	默认值	兼容性	描述
errCode	number	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errSubject	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
errMsg	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
wifi	UniWifiInfo	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

wifi 的属性描述

名称	类型	必备	默认值	兼容性	描述
SSID	string	是	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
BSSID	string	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
secure	boolean	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
signalStrength	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x
frequency	number	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

参见

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

uni.onWifiConnectedWithPartialInfo(UniWifiCallback) @onwificonnectedwithpartialinfo

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

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

onWifiConnectedWithPartialInfo 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	-

参数

名称	类型	必填	默认值	兼容性	描述
callback	(wifiInfo: UniWifiInfoWithPartialInfo) => void	是	-	-

UniWifiInfoWithPartialInfo 的属性值 @uniwifiinfowithpartialinfo-values

名称	类型	必备	默认值	兼容性	描述
SSID	string	是	-	-	-

参见

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

uni.offWifiConnected(callback?) @offwificonnected

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

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

offWifiConnected 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	<a style="color:unset;" href="https://vote.dcloud.net.cn/#/?name=uni-app%20x">x</a>

参数

名称	类型	必填	默认值	兼容性	描述
callback	() => void	否	-	Web: -; 微信小程序: -; Android: -; iOS: -; HarmonyOS: x

参见

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

通用类型

GeneralCallbackResult

名称	类型	必备	默认值	兼容性	描述
errMsg	string	是	-	Web: -; 微信小程序: 4.41; Android: -; iOS: -; HarmonyOS: -	错误信息