---
name: "offGetWifiList"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.4.3" }
  - { name: "@ray-js/ray", version: "0.5.9" }
platform:
  - "iOS"
  - "Android"
async: true
---

## offGetWifiList

> [VERSION] BaseKit >= 2.4.3 | @ray-js/ray >= 0.5.9

> [PLATFORM] iOS, Android

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

### Description

Wi‑Fi list received event

### Parameters

`(listener: Function)`

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

### Referenced Types

##### `interface` WifiListResponse

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

##### `interface` WifiInfo

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `ssid` | `string` | `4.17.0` | Wi‑Fi name |
| `password` | `string` | `4.17.0` | Password |


### Examples

#### Demo

```tsx
import { onGetWifiList, offGetWifiList } from '@ray-js/ray'

const listener = function (res) { console.log(res) }
onGetWifiList(listener)
offGetWifiList(listener)
```