uni.startWifi(option)
初始化Wi-Fi模块
本 API 是 uni ext api，需下载插件：uni-wifi
参数
| 名称 | 类型 | 必填 | 默认值 | 描述 |
|---|
| option | WifiOption | 是 | - | |
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| success | (res: UniWifiResult) => void | 否 | - | - | | fail | (res: UniError) => void | 否 | - | - | | complete | (res: any) => void | 否 | - | - |
|
UniWifiResult 的属性值
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| errCode | number | 是 | - | - |
| errSubject | string | 是 | - | - |
| errMsg | string | 是 | - | - |
| wifi | UniWifiInfo | null | 否 | - | |
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| SSID | string | 是 | - | - | | BSSID | string | 否 | - | - | | secure | boolean | 否 | - | - | | signalStrength | number | 否 | - | - | | frequency | number | 否 | - | - |
|
startWifi 兼容性
| Android | iOS | web |
|---|
| 3.9.0 | 4.11 | - |
参见
相关 Bug
uni.stopWifi(option)
关闭 Wi-Fi 模块
本 API 是 uni ext api，需下载插件：uni-wifi
参数
| 名称 | 类型 | 必填 | 默认值 | 描述 |
|---|
| option | WifiOption | 是 | - | |
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| success | (res: UniWifiResult) => void | 否 | - | - | | fail | (res: UniError) => void | 否 | - | - | | complete | (res: any) => void | 否 | - | - |
|
UniWifiResult 的属性值
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| errCode | number | 是 | - | - |
| errSubject | string | 是 | - | - |
| errMsg | string | 是 | - | - |
| wifi | UniWifiInfo | null | 否 | - | |
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| SSID | string | 是 | - | - | | BSSID | string | 否 | - | - | | secure | boolean | 否 | - | - | | signalStrength | number | 否 | - | - | | frequency | number | 否 | - | - |
|
stopWifi 兼容性
参见
相关 Bug
uni.connectWifi(option)
参数
| 名称 | 类型 | 必填 | 默认值 | 描述 |
|---|
| 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 | null | 否 | - | |
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| SSID | string | 是 | - | - | | BSSID | string | 否 | - | - | | secure | boolean | 否 | - | - | | signalStrength | number | 否 | - | - | | frequency | number | 否 | - | - |
|
connectWifi 兼容性
| Android 系统版本 | Android | iOS | web |
|---|
| >=4.4 && <10.0 | 3.9.0 | 4.11 | - |
参见
相关 Bug
uni.getWifiList(option)
请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。
本 API 是 uni ext api，需下载插件：uni-wifi
参数
| 名称 | 类型 | 必填 | 默认值 | 描述 |
|---|
| option | WifiOption | 是 | - | |
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| success | (res: UniWifiResult) => void | 否 | - | - | | fail | (res: UniError) => void | 否 | - | - | | complete | (res: any) => void | 否 | - | - |
|
UniWifiResult 的属性值
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| errCode | number | 是 | - | - |
| errSubject | string | 是 | - | - |
| errMsg | string | 是 | - | - |
| wifi | UniWifiInfo | null | 否 | - | |
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| SSID | string | 是 | - | - | | BSSID | string | 否 | - | - | | secure | boolean | 否 | - | - | | signalStrength | number | 否 | - | - | | frequency | number | 否 | - | - |
|
getWifiList 兼容性
| Android | iOS | web |
|---|
| 3.9.0 | 4.11 | - |
参见
相关 Bug
uni.onGetWifiList(UniWifiCallback)
监听获取到 Wi-Fi 列表数据事件。
本 API 是 uni ext api，需下载插件：uni-wifi
参数
| 名称 | 类型 | 必填 | 默认值 | 描述 |
|---|
| callback | (wifiInfo: any) => void | 是 | - | |
onGetWifiList 兼容性
| Android | iOS | web |
|---|
| 3.9.0 | 4.11 | - |
参见
相关 Bug
uni.offGetWifiList(UniWifiCallback)
移除获取到 Wi-Fi 列表数据事件的监听函数。
本 API 是 uni ext api，需下载插件：uni-wifi
参数
| 名称 | 类型 | 必填 | 默认值 | 描述 |
|---|
| callback | () => void | 是 | - | |
offGetWifiList 兼容性
| Android | iOS | web |
|---|
| 3.9.0 | 4.11 | - |
参见
相关 Bug
uni.getConnectedWifi(option)
获取已连接的 Wi-Fi 信息
本 API 是 uni ext api，需下载插件：uni-wifi
参数
| 名称 | 类型 | 必填 | 默认值 | 描述 |
|---|
| 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 | null | 否 | - | |
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| SSID | string | 是 | - | - | | BSSID | string | 否 | - | - | | secure | boolean | 否 | - | - | | signalStrength | number | 否 | - | - | | frequency | number | 否 | - | - |
|
getConnectedWifi 兼容性
| Android | iOS | web |
|---|
| 3.9.0 | 4.11 | - |
参见
相关 Bug
uni.onWifiConnected(UniWifiCallback)
监听连接上 Wi-Fi 的事件
本 API 是 uni ext api，需下载插件：uni-wifi
参数
UniWifiResult 的属性值
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| errCode | number | 是 | - | - |
| errSubject | string | 是 | - | - |
| errMsg | string | 是 | - | - |
| wifi | UniWifiInfo | null | 否 | - | |
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| SSID | string | 是 | - | - | | BSSID | string | 否 | - | - | | secure | boolean | 否 | - | - | | signalStrength | number | 否 | - | - | | frequency | number | 否 | - | - |
|
onWifiConnected 兼容性
| Android | iOS | web |
|---|
| 3.9.0 | 4.11 | - |
参见
相关 Bug
uni.onWifiConnectedWithPartialInfo(UniWifiCallback)
监听连接上 Wi-Fi 的事件。
本 API 是 uni ext api，需下载插件：uni-wifi
参数
UniWifiInfoWithPartialInfo 的属性值
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| SSID | string | 是 | - | - |
onWifiConnectedWithPartialInfo 兼容性
| Android | iOS | web |
|---|
| 3.9.0 | 4.11 | - |
参见
相关 Bug
uni.offWifiConnected(callback?)
移除连接上 Wi-Fi 的事件的监听函数。
本 API 是 uni ext api，需下载插件：uni-wifi
参数
| 名称 | 类型 | 必填 | 默认值 | 描述 |
|---|
| callback | () => void | null | 否 | - | |
offWifiConnected 兼容性
| Android | iOS | web |
|---|
| 3.9.0 | 4.11 | - |
参见
相关 Bug
通用类型
GeneralCallbackResult
| 名称 | 类型 | 必备 | 默认值 | 描述 |
|---|
| errMsg | string | 是 | - | 错误信息 |
