uni.startWifi(option) @startwifi

# uni.startWifi(option)

初始化Wi-Fi模块

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

# # Parameters

name	type	required	default	description
option	WifiOption	YES	-	Wifi 函数通用入参封装

# # WifiOption Values

name	type	optinal	default	description
success	(res: UniWifiResult) => void	NO	-	-
fail	(res: UniError) => void	NO	-	-
complete	(res: any) => void	NO	-	-

# # UniWifiResult Values

name	type	optinal	default	description
errCode	number	YES	-	-
errSubject	string	YES	-	-
errMsg	string	YES	-	-
wifi	UniWifiInfo	NO	-	-

# # UniWifiInfo Values

name	type	optinal	default	description
SSID	string	YES	-	-
BSSID	string	NO	-	-
secure	boolean	NO	-	-
signalStrength	number	NO	-	-
frequency	number	NO	-	-

# # startWifi Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
4.4.4	3.7.0	3.9.0	9.0	3.7.7	3.9.0

# # See also

startWifi

Related Bug

# uni.stopWifi(option)

关闭 Wi-Fi 模块

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

# # Parameters

name	type	required	default	description
option	WifiOption	YES	-	Wifi 函数通用入参封装

# # WifiOption Values

name	type	optinal	default	description
success	(res: UniWifiResult) => void	NO	-	-
fail	(res: UniError) => void	NO	-	-
complete	(res: any) => void	NO	-	-

# # UniWifiResult Values

name	type	optinal	default	description
errCode	number	YES	-	-
errSubject	string	YES	-	-
errMsg	string	YES	-	-
wifi	UniWifiInfo	NO	-	-

# # UniWifiInfo Values

name	type	optinal	default	description
SSID	string	YES	-	-
BSSID	string	NO	-	-
secure	boolean	NO	-	-
signalStrength	number	NO	-	-
frequency	number	NO	-	-

# # stopWifi Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
4.4.4	3.7.0	3.9.0	9.0	3.7.7	3.9.0

# # See also

stopWifi

Related Bug

# uni.connectWifi(option)

# # Parameters

name	type	required	default	description
option	WifiConnectOption	YES	-	Wifi 链接参数封装

# # WifiConnectOption Values

name	type	optinal	default	description
SSID	string	NO	-	-
BSSID	string	NO	-	-
password	string	NO	-	-
maunal	boolean	NO	-	-
partialInfo	boolean	NO	-	-
success	(res: UniWifiResult) => void	NO	-	-
fail	(res: UniError) => void	NO	-	-
complete	(res: any) => void	NO	-	-

# # UniWifiResult Values

name	type	optinal	default	description
errCode	number	YES	-	-
errSubject	string	YES	-	-
errMsg	string	YES	-	-
wifi	UniWifiInfo	NO	-	-

# # UniWifiInfo Values

name	type	optinal	default	description
SSID	string	YES	-	-
BSSID	string	NO	-	-
secure	boolean	NO	-	-
signalStrength	number	NO	-	-
frequency	number	NO	-	-

# # connectWifi Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
>=4.4 && <10.0	3.7.0	3.9.0	9.0	3.7.7	3.9.0

# # See also

connectWifi

Related Bug

# uni.getWifiList(option)

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

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

# # Parameters

name	type	required	default	description
option	WifiOption	YES	-	Wifi 函数通用入参封装

# # WifiOption Values

name	type	optinal	default	description
success	(res: UniWifiResult) => void	NO	-	-
fail	(res: UniError) => void	NO	-	-
complete	(res: any) => void	NO	-	-

# # UniWifiResult Values

name	type	optinal	default	description
errCode	number	YES	-	-
errSubject	string	YES	-	-
errMsg	string	YES	-	-
wifi	UniWifiInfo	NO	-	-

# # UniWifiInfo Values

name	type	optinal	default	description
SSID	string	YES	-	-
BSSID	string	NO	-	-
secure	boolean	NO	-	-
signalStrength	number	NO	-	-
frequency	number	NO	-	-

# # getWifiList Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
4.4.4	3.7.0	3.9.0	9.0	3.7.7	3.9.0

# # See also

getWifiList

Related Bug

# uni.onGetWifiList(UniWifiCallback)

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

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

# # Parameters

name	type	required	default	description
callback	() => void	YES	-	-

# # onGetWifiList Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
4.4.4	3.7.0	3.9.0	9.0	3.7.7	3.9.0

# # See also

onGetWifiList

Related Bug

# uni.offGetWifiList(UniWifiCallback)

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

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

# # Parameters

name	type	required	default	description
callback	() => void	YES	-	-

# # offGetWifiList Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
4.4.4	3.7.0	3.9.0	9.0	3.7.7	3.9.0

# # See also

offGetWifiList

Related Bug

# uni.getConnectedWifi(option)

获取已连接的 Wi-Fi 信息

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

# # Parameters

name	type	required	default	description
option	GetConnectedWifiOptions	YES	-	获取当前链接的wifi信息

# # GetConnectedWifiOptions Values

name	type	optinal	default	description
partialInfo	boolean	NO	-	-
success	(res: UniWifiResult) => void	NO	-	-
fail	(res: UniError) => void	NO	-	-
complete	(res: any) => void	NO	-	-

# # UniWifiResult Values

name	type	optinal	default	description
errCode	number	YES	-	-
errSubject	string	YES	-	-
errMsg	string	YES	-	-
wifi	UniWifiInfo	NO	-	-

# # UniWifiInfo Values

name	type	optinal	default	description
SSID	string	YES	-	-
BSSID	string	NO	-	-
secure	boolean	NO	-	-
signalStrength	number	NO	-	-
frequency	number	NO	-	-

# # getConnectedWifi Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
4.4.4	3.7.0	3.9.0	9.0	3.7.7	3.9.0

# # See also

getConnectedWifi

Related Bug

# uni.onWifiConnected(UniWifiCallback)

监听连接上 Wi-Fi 的事件

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

# # Parameters

name	type	required	default	description
callback	() => void	YES	-	-

# # onWifiConnected Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
4.4.4	3.7.0	3.9.0	9.0	3.7.7	3.9.0

# # See also

onWifiConnected

Related Bug

# uni.onWifiConnectedWithPartialInfo(UniWifiCallback)

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

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

# # Parameters

name	type	required	default	description
callback	() => void	YES	-	-

# # onWifiConnectedWithPartialInfo Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
4.4.4	3.7.0	3.9.0	9.0	3.7.7	3.9.0

# # See also

onWifiConnectedWithPartialInfo

Related Bug

# uni.offWifiConnected(callback?)

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

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

# # Parameters

name	type	required	default	description
callback	() => void	NO	-	-

# # offWifiConnected Compatibility

Android version	Android uni-app	Android uni-app-x	iOS version	iOS uni-app	iOS uni-app-x
4.4.4	3.7.0	3.9.0	9.0	3.7.7	3.9.0

# # See also

offWifiConnected

Related Bug

# # General type

# # GeneralCallbackResult

name	type	optinal	default	description
errMsg	string	YES	-	错误信息

products

HBuilderX uni-app uniCloud uniMPsdk 5+Runtime uni-id uni-search uniPay uniPush uni-verify sms uni-starter uni-admin uni-upgrade-center uni-im uni-ai uni-cms

Operating services

uni-AD uni-stat uni-portal Safety topic

Developer Services

forum dashboard

Docs

uni-app uniCloud native-support HBuilderX

Ecosystem

Marketplace OAuth

About： DCloud Jobs Terms of service Privacy policy acceptable use policy

# uni.startWifi(option)

# # Parameters

# # WifiOption Values

# # UniWifiResult Values

# # UniWifiInfo Values

# # startWifi Compatibility

# # See also

# uni.stopWifi(option)

# # Parameters

# # WifiOption Values

# # UniWifiResult Values

# # UniWifiInfo Values

# # stopWifi Compatibility

# # See also

# uni.connectWifi(option)

# # Parameters

# # WifiConnectOption Values

# # UniWifiResult Values

# # UniWifiInfo Values

# # connectWifi Compatibility

# # See also

# uni.getWifiList(option)

# # Parameters

# # WifiOption Values

# # UniWifiResult Values

# # UniWifiInfo Values

# # getWifiList Compatibility

# # See also

# uni.onGetWifiList(UniWifiCallback)

# # Parameters

# # onGetWifiList Compatibility

# # See also

# uni.offGetWifiList(UniWifiCallback)

# # Parameters

# # offGetWifiList Compatibility

# # See also

# uni.getConnectedWifi(option)

# # Parameters

# # GetConnectedWifiOptions Values

# # UniWifiResult Values

# # UniWifiInfo Values

# # getConnectedWifi Compatibility

# # See also

# uni.onWifiConnected(UniWifiCallback)

# # Parameters

# # onWifiConnected Compatibility

# # See also

# uni.onWifiConnectedWithPartialInfo(UniWifiCallback)

# # Parameters

# # onWifiConnectedWithPartialInfo Compatibility

# # See also

# uni.offWifiConnected(callback?)

# # Parameters

# # offWifiConnected Compatibility

# # See also

# # General type

# # GeneralCallbackResult

On This Page