---
name: "onGetWifiList"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.4.3" }
platform:
  - "iOS"
  - "Android"
async: true
---

## onGetWifiList

> [VERSION] BaseKit >= 2.4.3

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Wi-Fi list retrieved event

### Parameters

`(listener: Function)`

| Parameter | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `listener` | `(params: WifiListResponse) => void` | Yes | - | Event listener callback function |

### Referenced Types

##### `interface` WifiListResponse

| Property | Type | Required | Since | Description |
| --- | --- | --- | --- | --- |
| `wifiList` | `WifiInfo[]` | Yes | `2.4.3` | Wi‑Fi list |

##### `type` WifiInfo

| Property | Type | Required | Since | Description |
| --- | --- | --- | --- | --- |
| `SSID` | `string` | Yes | `2.4.3` | Wi‑Fi SSID |
| `BSSID` | `string` | Yes | `2.4.3` | Wi‑Fi BSSID |
| `signalStrength` | `number` | Yes | `2.4.3` | Wi‑Fi signal strength. Android: 0–100; iOS: 0–1. Higher values indicate stronger signal |
| `secure` | `boolean` | Yes | `2.4.3` | Wi‑Fi security status Android: Supported from Android 12 |
| `frequency` | `number` | Yes | `2.4.3` | Wi‑Fi frequency band, unit: MHz |


### Examples

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