Skip to content

U
uni-api

DCloud / uni-api

通知 670
Star 23
Fork 12
U
uni-api
提交 1d7178b1 编写于 作者: DCloud-yyl's avatar DCloud-yyl
浏览文件
操作

update uni-wifi configuration

上级 43c11c75
显示空白变更内容
内联 并排
Showing with 65 addition and 198 deletion
uni_modules/uni-wifi/changelog.md
浏览文件 @ 1d7178b1
## 1.0.0（2022-12-5） ## 1.0.0（2022-12-05）
实现Android/iOS平台Wi-Fi功能模块 实现Android/iOS平台Wi-Fi功能模块
注：iOS平台仅支持获取已连接的 Wi-Fi 信息 注：iOS平台仅支持获取已连接的 Wi-Fi 信息
uni_modules/uni-wifi/package.json
浏览文件 @ 1d7178b1
...@@ -24,9 +24,9 @@ ...@@ -24,9 +24,9 @@
"qq": "" "qq": ""
}, },
"declaration": { "declaration": {
"ads": "", "ads": "无",
"data": "", "data": "插件不采集任何数据",
"permissions": "" "permissions": "Android平台：\n<uses-permission android:name=\"android.permission.ACCESS_WIFI_STATE\"/>\n<uses-permission android:name=\"android.permission.CHANGE_WIFI_STATE\"/>\n<uses-permission android:name=\"android.permission.ACCESS_FINE_LOCATION\"/>\n<uses-permission android:name=\"android.permission.ACCESS_COARSE_LOCATION\"/>\niOS平台：\niOS13及以上平台获取Wifi信息需要定位权限"
}, },
"npmurl": "" "npmurl": ""
}, },
...@@ -50,45 +50,49 @@ ...@@ -50,45 +50,49 @@
"encrypt": [], "encrypt": [],
"platforms": { "platforms": {
"cloud": { "cloud": {
"tcb": "u", "tcb": "y",
"aliyun": "u" "aliyun": "y"
}, },
"client": { "client": {
"Vue": { "Vue": {
"vue2": "u", "vue2": "y",
"vue3": "u" "vue3": "y"
}, },
"App": { "App": {
"app-android": "u", "app-android": {
"app-ios": "u" "minVersion": "19"
},
"app-ios": {
"minVersion": "9"
}
}, },
"H5-mobile": { "H5-mobile": {
"Safari": "u", "Safari": "n",
"Android Browser": "u", "Android Browser": "n",
"微信浏览器(Android)": "u", "微信浏览器(Android)": "n",
"QQ浏览器(Android)": "u" "QQ浏览器(Android)": "n"
}, },
"H5-pc": { "H5-pc": {
"Chrome": "u", "Chrome": "n",
"IE": "u", "IE": "n",
"Edge": "u", "Edge": "n",
"Firefox": "u", "Firefox": "n",
"Safari": "u" "Safari": "n"
}, },
"小程序": { "小程序": {
"微信": "u", "微信": "n",
"阿里": "u", "阿里": "n",
"百度": "u", "百度": "n",
"字节跳动": "u", "字节跳动": "n",
"QQ": "u", "QQ": "n",
"钉钉": "u", "钉钉": "n",
"快手": "u", "快手": "n",
"飞书": "u", "飞书": "n",
"京东": "u" "京东": "n"
}, },
"快应用": { "快应用": {
"华为": "u", "华为": "n",
"联盟": "u" "联盟": "n"
} }
} }
} }
......
uni_modules/uni-wifi/readme.md
浏览文件 @ 1d7178b1
...@@ -19,92 +19,32 @@ Wi-Fi功能模块 ...@@ -19,92 +19,32 @@ Wi-Fi功能模块
``` ```
### 公共错误代码 ###uni.startWifi(OBJECT)
|错误码 |错误信息 |说明 |
|--- |---- |------ |
|0 |ok |正常 |
|12000 |not init |未先调用 startWifi 接口 |
|12001 |system not support |当前系统不支持相关能力 |
|12002 |password error Wi-Fi |密码错误 |
|12005 |wifi not turned on |Android 特有，未打开 Wi-Fi 开关 |
|12013 |wifi config may be expired |系统保存的 Wi-Fi 配置过期，建议忘记 Wi-Fi 后重试，仅 Android 支持 |
### uni.startWifi
初始化Wi-Fi模块。 初始化Wi-Fi模块。
> 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#startwifi](https://uniapp.dcloud.net.cn/api/system/wifi.html#startwifi)
#### 参数
Object object
|属性|类型|默认值|必填|说明|
|---|----|------|----|---|
|success|function|否|接口调用成功的回调函数|
|fail|function|否|接口调用失败的回调函数|
|complete|function|否|接口调用结束的回调函数（调用成功、失败都会执行）|
### uni.stopWifi(OBJECT)
### uni.stopWifi
关闭 Wi-Fi 模块。 关闭 Wi-Fi 模块。
> 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#stopwifi](https://uniapp.dcloud.net.cn/api/system/wifi.html#stopwifi)
#### 参数
Object object
|属性|类型|默认值|必填|说明|
|---|----|------|----|---|
|success|function|否|接口调用成功的回调函数|
|fail|function|否|接口调用失败的回调函数|
|complete|function|否|接口调用结束的回调函数（调用成功、失败都会执行）|
### uni.getConnectedWifi
获取已连接的 Wi-Fi 信息。
#### 参数
Object object ### uni.getConnectedWifi(OBJECT)
|属性 |类型 |默认值 |必填 |说明 | 获取已连接的 Wi-Fi 信息
|--- |---- |------ |---- |--- |
|partialInfo|boolean |false |否 |是否需要返回部分 Wi-Fi 信息|
|success |function | |否 |接口调用成功的回调函数 |
|fail |function | |否 |接口调用失败的回调函数 |
|complete |function | |否 |接口调用结束的回调函数（调用成功、失败都会执行）|
> 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#getconnectedwifi](https://uniapp.dcloud.net.cn/api/system/wifi.html#getconnectedwifi)
### uni.getWifiList(OBJECT)
### uni.getWifiList
请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。 请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。
> 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#getWifiList](https://uniapp.dcloud.net.cn/api/system/wifi.html#getWifiList)
#### 参数
Object object
|属性|类型|默认值|必填|说明|
|---|----|------|----|---|
|success|function||否|接口调用成功的回调函数|
|fail|function||否|接口调用失败的回调函数|
|complete|function||否|接口调用结束的回调函数（调用成功、失败都会执行）|
**平台差异说明** **平台差异说明**
...@@ -113,26 +53,11 @@ Object object ...@@ -113,26 +53,11 @@ Object object
|√|x| |√|x|
### uni.onGetWifiList ### uni.onGetWifiList(CALLBACK)
监听获取到 Wi-Fi 列表数据事件。 监听获取到 Wi-Fi 列表数据事件。
#### 参数 > 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#onGetWifiList](https://uniapp.dcloud.net.cn/api/system/wifi.html#onGetWifiList)
function listener
获取到 Wi-Fi 列表数据事件的监听函数
#### 参数
Object res
|属性 |类型 |说明 |
|-- |--- |-- |
|wifiList |Array<WifiInfo> |Wi-Fi 列表数据 |
**平台差异说明** **平台差异说明**
...@@ -141,16 +66,11 @@ Object res ...@@ -141,16 +66,11 @@ Object res
|√|x| |√|x|
### uni.offGetWifiList ### uni.offGetWifiList(CALLBACK)
移除获取到 Wi-Fi 列表数据事件的监听函数。 移除获取到 Wi-Fi 列表数据事件的监听函数。
#### 参数 > 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#offGetWifiList](https://uniapp.dcloud.net.cn/api/system/wifi.html#offGetWifiList)
function listener
onGetWifiList 传入的监听函数。不传此参数则移除所有监听函数。
**平台差异说明** **平台差异说明**
...@@ -159,24 +79,11 @@ onGetWifiList 传入的监听函数。不传此参数则移除所有监听函数 ...@@ -159,24 +79,11 @@ onGetWifiList 传入的监听函数。不传此参数则移除所有监听函数
|√|x| |√|x|
### uni.connectWifi ### uni.connectWifi(OBJECT)
连接 Wi-Fi。若已知 Wi-Fi 信息，可以直接利用该接口连接。 连接 Wi-Fi。若已知 Wi-Fi 信息，可以直接利用该接口连接。
#### 参数 > 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#connectWifi](https://uniapp.dcloud.net.cn/api/system/wifi.html#connectWifi)
Object object
|属性 |类型 |默认值 |必填 |说明 |最低版本 |
|--- |--- |--- |--- |--- |----- |
|SSID |string | |是 |Wi-Fi 设备 SSID| |
|BSSID |string | |否 |Wi-Fi 设备 BSSID| |
|password |string | |是 |Wi-Fi 设备密码| |
|maunal |boolean |false |否 |跳转到系统设置页进行连接|2.12.0 |
|partialInfo |boolean |false |否 |是否需要返回部分 Wi-Fi 信息，仅安卓生效|2.22.0 |
|success |function | |否 |接口调用成功的回调函数| |
|fail |function | |否 |接口调用失败的回调函数| |
|complete |function | |否 |接口调用结束的回调函数（调用成功、失败都会执行） |
**平台差异说明** **平台差异说明**
...@@ -185,26 +92,11 @@ Object object ...@@ -185,26 +92,11 @@ Object object
|√|x| |√|x|
### uni.onWifiConnected ### uni.onWifiConnected(CALLBACK)
监听连接上 Wi-Fi 的事件。 监听连接上 Wi-Fi 的事件。
#### 参数 > 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnected](https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnected)
function listener
连接上 Wi-Fi 的事件的监听函数
#### 参数
Object res
|属性 |类型 |说明 |
|--- |--- |--- |
|wifi |WifiInfo |Wi-Fi 信息 |
**平台差异说明** **平台差异说明**
...@@ -213,17 +105,11 @@ Object res ...@@ -213,17 +105,11 @@ Object res
|√|x| |√|x|
### uni.offWifiConnected ### uni.offWifiConnected(CALLBACK)
移除连接上wifi的事件的监听函数，不传此参数则移除所有监听函数。
#### 参数
function listener 移除连接上 Wi-Fi 的事件的监听函数。
onWifiConnected 传入的监听函数。不传此参数则移除所有监听函数。
> 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#offWifiConnected](https://uniapp.dcloud.net.cn/api/system/wifi.html#offWifiConnected)
**平台差异说明** **平台差异说明**
...@@ -232,16 +118,11 @@ onWifiConnected 传入的监听函数。不传此参数则移除所有监听函 ...@@ -232,16 +118,11 @@ onWifiConnected 传入的监听函数。不传此参数则移除所有监听函
|√|x| |√|x|
### uni.onWifiConnectedWithPartialInfo ### uni.onWifiConnectedWithPartialInfo(CALLBACK)
监听连接上 Wi-Fi 的事件， wifiInfo仅包含SSID。
#### 参数
function listener
onWifiConnectedWithPartialInfo 传入的监听函数。不传此参数则移除所有监听函数。 监听连接上 Wi-Fi 的事件。
> 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnectedWithPartialInfo](https://uniapp.dcloud.net.cn/api/system/wifi.html#onWifiConnectedWithPartialInfo)
**平台差异说明** **平台差异说明**
...@@ -250,33 +131,15 @@ onWifiConnectedWithPartialInfo 传入的监听函数。不传此参数则移除 ...@@ -250,33 +131,15 @@ onWifiConnectedWithPartialInfo 传入的监听函数。不传此参数则移除
|√|x| |√|x|
### uni.offWifiConnectedWithPartialInfo(CALLBACK)
### WifiInfo 移除连接上 Wi-Fi 的事件的监听函数。
Wifi 信息
#### 属性
+ string SSID
Wi-Fi 的 SSID
+ string BSSID
Wi-Fi 的 BSSID
+ boolean secure
Wi-Fi 是否安全
+ number signalStrength
Wi-Fi 信号强度, 安卓取值 0 ～ 100
+ number frequency
Wi-Fi 频段单位 MHz
> 使用文档：[https://uniapp.dcloud.net.cn/api/system/wifi.html#offWifiConnectedWithPartialInfo](https://uniapp.dcloud.net.cn/api/system/wifi.html#offWifiConnectedWithPartialInfo)
**平台差异说明**
|App-Android|App-iOS|
|:-:|:-:|
|√|x|
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或