upWifiModule Wifi模块

模块概述

为H5页面提供获取当前链接的wifi信息、跳转Android系统wifi设置界面等功能,ios跳转系统wifi设置界面使用vdn插件 提供的goToPage方法跳转


方法列表

  • getCurrentRouterInfo (获取当前链接的wifi信息)
  • jumpSystemWifiSetting(跳转系统wifi设置界面,仅限Android)
  • getScanRouterList(获取扫描到的wifi列表信息,仅限Android)

公共数据

所有数据均以JSON结构返回,由代码,信息和数据三部分组成

{
    "retCode": "000000", //接口状态标识码,错误标识码以14开头
    "retInfo": "执行成功",//接口信息说明
    "retData": null //业务数据
}

具体定义:返回数据通用


模块变更记录

  • V4.0.0-quickbind2
    • 初始化提交
  • V4.0.0-quickbind7
    • 增加getScanRouterList(获取扫描到的wifi列表信息,仅限Android)方法

方法说明

  • getCurrentRouterInfo

适用性
容器 cordova APICloud Nebula
支持情况
APP版本 - - 7.5.0 及以上
params 输入参数

错误返回 retCode说明
retCode编码 retInfo说明
160001 当前wifi不可用
160002 获取位置权限失败
000001 操作失败
正确返回 retData说明
属性名 数据类型 说明
ssid String wifi名称
bssid String wifi的Mac地址
is5G String 是否是5G热点(Android独有)
isNeedPassWord String 是否是开放式(无需密码)wifi (Android独有)
示例
upWifiModule.getCurrentRouterInfo().then((result) => {
  console.log('result',result);
},(err)=>{
  console.log('err',err);
})
  • jumpSystemWifiSetting(仅限Android,ios使用vdn插件的goToPage方法跳转)

使用说明

调用该接口会跳转系统wifi设置页面,由于Android机型兼容性问题,部分机型可能会跳转失败

适用性
容器 cordova APICloud Nebula
支持情况
APP版本 - - 7.5.0 及以上
params 输入参数

错误返回 retCode说明
retCode编码 retInfo说明
000001 操作失败
示例
upWifiModule.jumpSystemWifiSetting().then((res) => {
  console.log('result',res);
},(err)=>{
  console.log('err',err);
});

成功返回数据

{
    "retCode":"000000",
    "retInfo":"执行成功",
    "retData": null
}
  • getScanRouterList(仅限Android)

适用性
容器 cordova APICloud Nebula
支持情况
APP版本 - - 7.5.0 及以上
params 输入参数
属性名 数据类型 是否必填 默认值 说明
timeout Number 超时时间单位s,默认值10s
错误返回 retCode说明
retCode编码 retInfo说明
160003 扫描超时
160004 扫描wifi需要位置权限
160005 未扫描到相关wifi列表信息
000001 操作失败
正确返回 retData说明
属性名 数据类型 说明
ssid String wifi名称
is5G boolean 是否是5G热点
isNeedPassWord boolean 是否是开放式(无需密码)wifi
signalLevel number 信号强度取值范围(0-3),0最弱3最强
示例
upWifiModule.getScanRouterList().then((result) => {
  console.log('result',result);
},(err)=>{
  console.log('err',err);
})

results matching ""

    No results matching ""