diff --git a/uni_modules/uni-wifi/readme.md b/uni_modules/uni-wifi/readme.md index 6883a39fc2e49304049046cc557ac9accbf3ff72..6900c696461a2e5343aec29f1e9da49ad8e85a5c 100644 --- a/uni_modules/uni-wifi/readme.md +++ b/uni_modules/uni-wifi/readme.md @@ -1,84 +1,114 @@ -# uni-wifi +## 使用说明 -WiFi信息相关 +Wi-Fi功能模块 -### uni.getConnectedWifi - -获取当前设备连接的WiFi信息。 - -> iOS使用此接口注意事项: -> 1.iOS使用此接口需要添加Access WiFi information的Capabilities, 此能力不需要开发者手动配置,但是需要在苹果开发者后台,对开发及发布证书勾选相应能力,再生成podfile文件。 -> 2.在iOS13及以上系统,获取当前连接的WiFi信息需要先获取系统定位权限,因此在iOS13及以上系统使用此接口时,会触发定位权限申请的弹窗。 +### App-iOS平台注意事项 +- iOS平台App获取Wi-Fi信息需要开启“Access WiFi information”能力 + 登录苹果开发者网站,在“Certificates, Identifiers & Profiles”页面选择“Identifiers”中选择对应的App ID,确保开启“Access WiFi information”,保存后重新生成profile文件 +- iOS13及以上系统,获取当前连接的Wi-Fi信息需要先获取系统定位权限,因此在iOS13及以上系统使用此接口时,会触发定位权限申请的弹窗 ### uni.startWifi -初始化WiFi模块。 +初始化Wi-Fi模块。 -**注意平台差异:iOS暂不支持此接口** ### uni.stopWifi -停止WiFi模块。 +关闭 Wi-Fi 模块。 + + +### uni.getConnectedWifi -**注意平台差异:iOS暂不支持此接口** +获取已连接的 Wi-Fi 信息。 ### uni.getWifiList -获取WiFi列表。 +请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。 + +**平台差异说明** + +|App-Android|App-iOS| +|:-:|:-:| +|√|x| -**注意平台差异:iOS暂不支持此接口** ### uni.onGetWifiList -获取WiFi列表的回调。 +监听获取到 Wi-Fi 列表数据事件。 + +**平台差异说明** + +|App-Android|App-iOS| +|:-:|:-:| +|√|x| -**注意平台差异:iOS暂不支持此接口** ### uni.offGetWifiList -注销获取WiFi列表的回调。 +移除获取到 Wi-Fi 列表数据事件的监听函数。 + +**平台差异说明** + +|App-Android|App-iOS| +|:-:|:-:| +|√|x| -**注意平台差异:iOS暂不支持此接口** ### uni.connectWifi -连接指定WiFi。 +连接 Wi-Fi。若已知 Wi-Fi 信息,可以直接利用该接口连接。 -**注意平台差异:iOS暂不支持此接口** +**平台差异说明** + +|App-Android|App-iOS| +|:-:|:-:| +|√|x| -### uni.onWifiConnected -连上wifi事件的监听函数。 +### uni.onWifiConnected -**注意平台差异:iOS暂不支持此接口** +监听连接上 Wi-Fi 的事件。 -### uni.onWifiConnectedWithPartialInfo +**平台差异说明** -连上wifi事件的监听函数, wifiInfo仅包含SSID。 +|App-Android|App-iOS| +|:-:|:-:| +|√|x| -**注意平台差异:iOS暂不支持此接口** ### uni.offWifiConnected 移除连接上wifi的事件的监听函数,不传此参数则移除所有监听函数。 -**注意平台差异:iOS暂不支持此接口** +**平台差异说明** +|App-Android|App-iOS| +|:-:|:-:| +|√|x| -### uni.onOffWifiConnectedWithPartialInfo -移除连接上wifi的事件的监听函数,不传参数则移除所有监听函数。 +### uni.onWifiConnectedWithPartialInfo + +监听连接上 Wi-Fi 的事件, wifiInfo仅包含SSID。 + +**平台差异说明** -**注意平台差异:iOS暂不支持此接口** +|App-Android|App-iOS| +|:-:|:-:| +|√|x| -### uni.setWifiList +### uni.onOffWifiConnectedWithPartialInfo + +移除连接上 Wi-Fi 的事件的监听函数,不传参数则移除所有监听函数。 -设置 wifiList 中 AP 的相关信息。在 onGetWifiList 回调后调用,iOS特有接口。 +**平台差异说明** -**注意平台差异:iOS特有接口,目前暂未支持** +|App-Android|App-iOS| +|:-:|:-:| +|√|x|