uni.startWifi(option) @startwifi

展示全部

# uni.startWifi(option)

初始化Wi-Fi模块

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

# startWifi 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	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

否

# 参见

# uni.stopWifi(option)

关闭 Wi-Fi 模块

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

# stopWifi 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	x	4.11	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

否

# 参见

# uni.connectWifi(option)

# connectWifi 兼容性

Web	微信小程序	Android 系统版本	Android	iOS	HarmonyOS
-	-	>=4.4 && <10.0	3.9.0	4.11	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

否

# 参见

# uni.getWifiList(option)

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

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

# getWifiList 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	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

否

# 参见

# uni.onGetWifiList(UniWifiCallback)

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

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

# onGetWifiList 兼容性

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

# 参数

名称

类型

必填

默认值

兼容性

描述

callback

(wifiInfo: Record<string, any>) => void

是

# 参见

# uni.offGetWifiList(UniWifiCallback)

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

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

# offGetWifiList 兼容性

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

# 参数

名称

类型

必填

默认值

兼容性

描述

callback

() => void

是

# 参见

# uni.getConnectedWifi(option)

获取已连接的 Wi-Fi 信息

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

# getConnectedWifi 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
-	-	3.9.0	4.11	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

否

# 参见

# uni.onWifiConnected(UniWifiCallback)

监听连接上 Wi-Fi 的事件

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

# onWifiConnected 兼容性

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

# 参数

名称

类型

必填

默认值

兼容性

描述

callback

(wifiInfo: UniWifiResult) => void

是

# UniWifiResult 的属性值

名称

类型

必备

默认值

兼容性

描述

errCode

number

是

errSubject

string

是

errMsg

string

是

wifi

UniWifiInfo

否

名称

类型

必备

默认值

兼容性

描述

SSID

string

是

BSSID

string

否

secure

boolean

否

signalStrength

number

否

frequency

number

否

# 参见

# uni.onWifiConnectedWithPartialInfo(UniWifiCallback)

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

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

# onWifiConnectedWithPartialInfo 兼容性

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

# 参数

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

# UniWifiInfoWithPartialInfo 的属性值

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

# 参见

# uni.offWifiConnected(callback?)

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

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

# offWifiConnected 兼容性

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

# 参数

名称

类型

必填

默认值

兼容性

描述

callback

() => void

否

# 参见

# 通用类型

# GeneralCallbackResult

名称

类型

必备

默认值

兼容性

描述

errMsg

string

是

错误信息

运营产品

uni-ad uni统计 uni发行 uni安全专题

开发者服务

问答社区开发者后台

技术文档

uni-app文档 uniCloud文档原生开发者支持文档 HBuilder文档

生态服务

插件市场 OAuth用户开放平台

关于我们： DCloud官网案例需求墙许可协议加入我们赞助我们

联系我们：商务合作：bd@dcloud.io 广告合作：uniad@dcloud.io

DCloud.io 数字天堂（北京）网络技术有限公司是

HTML5中国产业联盟发起单位

京公网安备：11010802035340号

国家信息安全等级保护三级，证书编号：11010813802-20001