Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
没有积善却想登上天堂
unidocs-zh
提交
b5059b3a
U
unidocs-zh
项目概览
没有积善却想登上天堂
/
unidocs-zh
与 Fork 源项目一致
Fork自
DCloud / unidocs-zh
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
b5059b3a
编写于
12月 05, 2022
作者:
DCloud-yyl
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update wifi.md
上级
7b4fbd92
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
229 addition
and
7 deletion
+229
-7
docs/api/system/wifi.md
docs/api/system/wifi.md
+229
-7
未找到文件。
docs/api/system/wifi.md
浏览文件 @
b5059b3a
#### Wi-Fi
**Wi-Fi功能模块**
仅部分平台支持,各平台开发方式暂未统一,使用时需注意用
[
条件编译
](
https://uniapp.dcloud.io/platform
)
调用不同平台的代码。
> App平台由 [uni ext api](https://uniapp.dcloud.net.cn/api/extapi.html) 实现,需下载插件:[uni-WiFi](https://ext.dcloud.net.cn/plugin?id=10337)
> uni ext api 需 HBuilderX 3.6.8+
其它平台开发方式暂未统一,使用时需注意用
[
条件编译
](
https://uniapp.dcloud.io/platform
)
调用不同平台的代码。
微信小程序平台实现参考:
[
规范详情
](
https://developers.weixin.qq.com/miniprogram/dev/api/wx.startWifi.html
)
...
...
@@ -8,10 +13,227 @@
字节跳动小程序的wifi API参考:
[
规范详情
](
https://developer.toutiao.com/dev/cn/mini-app/develop/api/device/wi-fi/getconnectedwifi
)
App 平台实现参考
**安卓:**
-
[
获取WIFI列表
](
https://ask.dcloud.net.cn/question/12113
)
### uni.startWifi(OBJECT)
初始化Wi-Fi模块
**OBJECT 参数说明**
|参数名|类型|必填|说明|
|---|----|----|---|
|success|function|否|接口调用成功的回调函数|
|fail|function|否|接口调用失败的回调函数|
|complete|function|否|接口调用结束的回调函数(调用成功、失败都会执行)|
### uni.stopWifi(OBJECT)
关闭 Wi-Fi 模块
**OBJECT 参数说明**
|参数名|类型|必填|说明|
|---|----|----|---|
|success|function|否|接口调用成功的回调函数|
|fail|function|否|接口调用失败的回调函数|
|complete|function|否|接口调用结束的回调函数(调用成功、失败都会执行)|
### uni.getConnectedWifi(OBJECT)
获取已连接的 Wi-Fi 信息
**OBJECT 参数说明**
|属性 |类型 |默认值 |必填 |说明 |
|--- |---- |------ |---- |--- |
|partialInfo|boolean |false |否 |是否需要返回部分 Wi-Fi 信息|
|success |function | |否 |接口调用成功的回调函数 |
|fail |function | |否 |接口调用失败的回调函数 |
|complete |function | |否 |接口调用结束的回调函数(调用成功、失败都会执行)|
**success 返回参数说明**
|参数|类型|说明|
|:-|:-|:-|
|wifi|WifiInfo|Wi-Fi 信息|
### uni.getWifiList(OBJECT)
请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回。
**OBJECT 参数说明**
|属性|类型|必填|说明|
|---|----|----|---|
|success|function|否|接口调用成功的回调函数|
|fail|function|否|接口调用失败的回调函数|
|complete|function|否|接口调用结束的回调函数(调用成功、失败都会执行)|
**平台差异说明**
|App-Android|App-iOS|
|:-:|:-:|
|√|x|
### uni.onGetWifiList(CALLBACK)
监听获取到 Wi-Fi 列表数据事件。
**CALLBACK 参数说明**
获取到 Wi-Fi 列表数据事件的监听函数
**CALLBACK 返回参数**
|属性 |类型 |说明 |
|-- |--- |-- |
|wifiList |Array
<
[
WifiInfo
](
#WifiInfo
)
>
|Wi-Fi 列表数据 |
**平台差异说明**
|App-Android|App-iOS|
|:-:|:-:|
|√|x|
### uni.offGetWifiList(CALLBACK)
移除获取到 Wi-Fi 列表数据事件的监听函数。
**CALLBACK 参数说明**
onGetWifiList 传入的监听函数。不传此参数则移除所有监听函数。
**平台差异说明**
|App-Android|App-iOS|
|:-:|:-:|
|√|x|
### uni.connectWifi(OBJECT)
连接 Wi-Fi。若已知 Wi-Fi 信息,可以直接利用该接口连接。
**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 | |否 |接口调用结束的回调函数(调用成功、失败都会执行) |
**平台差异说明**
|App-Android|App-iOS|
|:-:|:-:|
|√|x|
### uni.onWifiConnected(CALLBACK)
监听连接上 Wi-Fi 的事件。
**CALLBACK 参数说明**
连接上 Wi-Fi 的事件的监听函数
**CALLBACK 返回参数**
|属性 |类型 |说明 |
|--- |--- |--- |
|wifi |
[
WifiInfo
](
#WifiInfo
)
|Wi-Fi 信息 |
**平台差异说明**
|App-Android|App-iOS|
|:-:|:-:|
|√|x|
### uni.offWifiConnected(CALLBACK)
移除连接上 Wi-Fi 的事件的监听函数。
**CALLBACK 参数说明**
onWifiConnected 传入的监听函数。不传此参数则移除所有监听函数。
**平台差异说明**
|App-Android|App-iOS|
|:-:|:-:|
|√|x|
### uni.onWifiConnectedWithPartialInfo(CALLBACK)
监听连接上 Wi-Fi 的事件。
**CALLBACK 参数说明**
连接上 Wi-Fi 的事件的监听函数
**CALLBACK 返回参数**
|属性 |类型 |说明 |
|--- |--- |--- |
|wifi |
[
WifiInfo
](
#WifiInfo
)
|只包含 SSID 属性的 WifiInfo 对象 |
**平台差异说明**
|App-Android|App-iOS|
|:-:|:-:|
|√|x|
### uni.offWifiConnectedWithPartialInfo(CALLBACK)
移除连接上 Wi-Fi 的事件的监听函数。
**CALLBACK 参数说明**
onWifiConnectedWithPartialInfo 传入的监听函数。不传此参数则移除所有监听函数。
**平台差异说明**
|App-Android|App-iOS|
|:-:|:-:|
|√|x|
### WifiInfo
Wifi 信息
|属性 |类型 |说明 |
|--- |--- |--- |
|SSID |string |Wi-Fi 的 SSID |
|BSSID |string |Wi-Fi 的 BSSID |
|secure |boolean|Wi-Fi 是否安全 |
|signalStrength |number |Wi-Fi 信号强度, 安卓取值 0 ~ 100|
|frequency |number |Wi-Fi 频段单位 MHz |
### 错误码
|错误码 |错误信息 |说明 |
|--- |---- |------ |
|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 支持 |
**ios:**
-
[
打开ios的WIFI设置页面
](
https://ask.dcloud.net.cn/question/7797
)
### 参考
-
[
Android平台获取WIFI列表
](
https://ask.dcloud.net.cn/question/12113
)
-
[
iOS平台打开系统WIFI设置页面
](
https://ask.dcloud.net.cn/question/7797
)
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录