---
name: "onGetWifiList"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.4.3" }
platform:
  - "iOS"
  - "Android"
async: true
title: "onGetWifiList - 监听获取到 Wi-Fi 列表数据事件"
---

## onGetWifiList

> [VERSION] BaseKit >= 2.4.3

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

监听获取到 Wi-Fi 列表数据事件

### 参数

`(listener: Function)`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `listener` | `(params: WifiListResponse) => void` | 是 | - | 事件监听回调函数 |

### 引用对象

##### `interface` WifiListResponse

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `wifiList` | `WifiInfo[]` | `2.4.3` | Wi-Fi列表 |

##### `type` WifiInfo

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `SSID` | `string` | `2.4.3` | wifi的SSID |
| `BSSID` | `string` | `2.4.3` | wifi的BSSID |
| `signalStrength` | `number` | `2.4.3` | Wi-Fi 信号强度, 安卓取值 0 ～ 100 ，iOS 取值 0 ～ 1 ，值越大强度越大 |
| `secure` | `boolean` | `2.4.3` | Wi-Fi是否安全 Android：Android系统12开始支持。 |
| `frequency` | `number` | `2.4.3` | Wi-Fi 频段单位 MHz |


### 示例代码

```tsx
ty.onGetWifiList(e => {
  console.log(e);
});
```