---
description: Capacitor plugin to manage Wi-Fi connectivity, including adding, connecting, and disconnecting networks. Supports both Android and iOS.
title: Capacitor Wifi Plugin for Android & iOS - Capawesome
image: https://capawesome.io/docs/assets/images/social/plugins/wifi.png
---

[ Skip to content](#capawesome-teamcapacitor-wifi) 

[ 🎉 Introducing **Capawesome Platform** — one platform for Live Updates, Native Builds, App Store Publishing, and Insider SDKs.](https://capawesome.io) 

* [  Formbricks ](/docs/plugins/formbricks/)
* [  Geocoder ](/docs/plugins/geocoder/)
* [  Google Sign-In ](/docs/plugins/google-sign-in/)
* [  libSQL ](/docs/plugins/libsql/)
* [  Live Update ](/docs/plugins/live-update/)
* [  Managed Configurations ](/docs/plugins/managed-configurations/)
* [  Media Session ](/docs/plugins/media-session/)
* [  ML Kit ](/docs/plugins/mlkit/)
* [  NFC ](/docs/plugins/nfc/)
* [  OAuth ](/docs/plugins/oauth/)
* [  Pedometer ](/docs/plugins/pedometer/)
* [  Photo Editor ](/docs/plugins/photo-editor/)
* [  PostHog ](/docs/plugins/posthog/)
* [  Printer ](/docs/plugins/printer/)
* [  Purchases ](/docs/plugins/purchases/)
* [  RealtimeKit ](/docs/plugins/realtimekit/)
* [  Screen Orientation ](/docs/plugins/screen-orientation/)
* [  Screenshot ](/docs/plugins/screenshot/)
* [  Secure Preferences ](/docs/plugins/secure-preferences/)
* [  Speech Recognition ](/docs/plugins/speech-recognition/)
* [  Speech Synthesis ](/docs/plugins/speech-synthesis/)
* [  Share Target ](/docs/plugins/share-target/)
* [  Square Mobile Payments ](/docs/plugins/square-mobile-payments/)
* [  SQLite ](/docs/plugins/sqlite/)
* [  Superwall ](/docs/plugins/superwall/)
* [  Torch ](/docs/plugins/torch/)
* Wifi [  Wifi ](/docs/plugins/wifi/)
* [  iOS ](#ios)
* [  Configuration ](#configuration)
* [  Usage ](#usage)
* [  API ](#api)
* [  Type Aliases ](#type-aliases)
* [  Enums ](#enums)
* [  Changelog ](#changelog)
* [  Breaking Changes ](#breaking-changes)
* [  License ](#license)
* [  Zip ](/docs/plugins/zip/)
* [  Cloud ](/docs/cloud/)
* [  Live Updates ](/docs/cloud/live-updates/)
* Advanced
* Integrations
* [  Native Builds ](/docs/cloud/native-builds/)
* [  Configuration ](/docs/cloud/native-builds/configuration/)
* [  Environments ](/docs/cloud/native-builds/environments/)
* Guides
* [  Sample Projects ](/docs/cloud/native-builds/sample-projects/)
* [  Troubleshooting ](/docs/cloud/native-builds/troubleshooting/)
* [  Automations ](/docs/cloud/automations/)
* [  Assist ](/docs/cloud/assist/)
* Account
* Organizations
* [  Organization and User Management ](/docs/cloud/organizations/memberships/)
* [  Single Sign-On (SSO) ](/docs/cloud/organizations/sso/)
* [  Teams ](/docs/cloud/organizations/teams/)
* [  Two-Factor Authentication ](/docs/cloud/organizations/two-factor-authentication/)
* [  Integrations ](/docs/cloud/integrations/)
* [  License Keys ](/docs/cloud/license-keys/)
* [  Webhooks ](/docs/cloud/webhooks/)
* [  Pricing ](https://capawesome.io/pricing/)
* [  FAQ ](/docs/cloud/faq/)
* [  Support ](/docs/cloud/support/)
* [  Contributing ](/docs/contributing/)
* [  LLMs ](/docs/llms/)
* [  Insiders ](/docs/insiders/)
* [  License ](https://capawesome.io/legal/eula/)
* [  Support ](/docs/insiders/support/)
* [  FAQ ](/docs/insiders/faq/)
* [  Blog ](/blog/)
* Categories

* [  iOS ](#ios)
* [  Configuration ](#configuration)
* [  Usage ](#usage)
* [  API ](#api)
* [  Type Aliases ](#type-aliases)
* [  Enums ](#enums)
* [  Changelog ](#changelog)
* [  Breaking Changes ](#breaking-changes)
* [  License ](#license)

# @capawesome-team/capacitor-wifi[¶](#capawesome-teamcapacitor-wifi "Permanent link")

Capacitor plugin to manage Wi-Fi connectivity, including adding, connecting, and disconnecting networks. Supports both Android and iOS.

[ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) 

## Features[¶](#features "Permanent link")

We are proud to offer one of the most complete and feature-rich Capacitor plugins for Wi-Fi connectivity. Here are some of the key features:

* 🖥️ **Cross-platform**: Supports Android and iOS.
* 🌐 **Network Management**: Add, connect and disconnect networks.
* 🔍 **Network Scan**: Perform scans for available networks.
* 📟 **Device Info**: Retrieve essential device information like IP address.
* 🔁 **Up-to-date**: Always supports the latest Capacitor version.
* ⭐️ **Support**: Priority support from the Capawesome Team.
* ✨ **Handcrafted**: Built from the ground up with care and expertise, not forked or AI-generated.

Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!

## Newsletter[¶](#newsletter "Permanent link")

Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).

## Compatibility[¶](#compatibility "Permanent link")

| Plugin Version | Capacitor Version | Status         |
| -------------- | ----------------- | -------------- |
| 8.x.x          | \>=8.x.x          | Active support |
| 7.x.x          | 7.x.x             | Deprecated     |

## Demo[¶](#demo "Permanent link")

| Android                                                                                   | iOS                                                                               |
| ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| ![Android Demo](https://capawesome.io/docs/assets/images/gifs/capacitor-wifi-android.gif) | ![iOS Demo](https://capawesome.io/docs/assets/images/gifs/capacitor-wifi-ios.gif) |

## Installation[¶](#installation "Permanent link")

This plugin is only available to [Capawesome Insiders](https://capawesome.io/insiders/). First, make sure you have the Capawesome npm registry set up. You can do this by running the following commands:

`[](#%5F%5Fcodelineno-0-1)npm config set @capawesome-team:registry https://npm.registry.capawesome.io
[](#%5F%5Fcodelineno-0-2)npm config set //npm.registry.capawesome.io/:_authToken <YOUR_LICENSE_KEY>
`

**Attention**: Replace `<YOUR_LICENSE_KEY>` with the license key you received from Polar. If you don't have a license key yet, you can get one by becoming a [Capawesome Insider](https://capawesome.io/insiders/).

Next, you can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:

`[](#%5F%5Fcodelineno-1-1)npx skills add capawesome-team/skills --skill capacitor-plugins
`

Then use the following prompt:

`` [](#%5F%5Fcodelineno-2-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome-team/capacitor-wifi` plugin in my project.
 ``

If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below:

`[](#%5F%5Fcodelineno-3-1)npm install @capawesome-team/capacitor-wifi
[](#%5F%5Fcodelineno-3-2)npx cap sync
`

### Android[¶](#android "Permanent link")

#### Permissions[¶](#permissions "Permanent link")

This API requires the following elements be added to your `AndroidManifest.xml` before or after the `application` tag:

`[](#%5F%5Fcodelineno-4-1)<!-- Required if you want retrieve information about nearby Wi-Fi networks. -->
[](#%5F%5Fcodelineno-4-2)<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
`

#### Proguard[¶](#proguard "Permanent link")

If you are using Proguard, you need to add the following rules to your `proguard-rules.pro` file:

`[](#%5F%5Fcodelineno-5-1)-keep class io.capawesome.capacitorjs.plugins.** { *; }
`

### iOS[¶](#ios "Permanent link")

#### Entitlements[¶](#entitlements "Permanent link")

Ensure `Access Wi-Fi Information` and `Hotspot` capabilities have been enabled in your application in Xcode. See [Add a capability to a target](https://help.apple.com/xcode/mac/current/#/dev88ff319e7) for more information.

#### Privacy Descriptions[¶](#privacy-descriptions "Permanent link")

Add the `NSLocationWhenInUseUsageDescription` and `NSLocationAlwaysAndWhenInUseUsageDescription` keys to the `ios/App/App/Info.plist` file, which tells the user why your app is requesting location information:

`[](#%5F%5Fcodelineno-6-1)<key>NSLocationWhenInUseUsageDescription</key>
[](#%5F%5Fcodelineno-6-2)<string>We need your location to request Wi-Fi information.</string>
[](#%5F%5Fcodelineno-6-3)<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
[](#%5F%5Fcodelineno-6-4)<string>We need your location to request Wi-Fi information.</string>
`

## Configuration[¶](#configuration "Permanent link")

| Prop               | Type    | Description                                                                                                                                         | Default | Since |
| ------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ----- |
| **useWifiManager** | boolean | Whether or not to use the **deprecated** WifiManager API for connecting to Wi-Fi networks using the connect(...) method. Only available on Android. | false   | 6.3.0 |

### Examples[¶](#examples "Permanent link")

In `capacitor.config.json`:

`[](#%5F%5Fcodelineno-7-1){
[](#%5F%5Fcodelineno-7-2)  "plugins": {
[](#%5F%5Fcodelineno-7-3)    "Wifi": {
[](#%5F%5Fcodelineno-7-4)      "useWifiManager": undefined
[](#%5F%5Fcodelineno-7-5)    }
[](#%5F%5Fcodelineno-7-6)  }
[](#%5F%5Fcodelineno-7-7)}
`

In `capacitor.config.ts`:

`[](#%5F%5Fcodelineno-8-1)/// <reference types="@capawesome-team/capacitor-wifi" />
[](#%5F%5Fcodelineno-8-2)
[](#%5F%5Fcodelineno-8-3)import { CapacitorConfig } from '@capacitor/cli';
[](#%5F%5Fcodelineno-8-4)
[](#%5F%5Fcodelineno-8-5)const config: CapacitorConfig = {
[](#%5F%5Fcodelineno-8-6)  plugins: {
[](#%5F%5Fcodelineno-8-7)    Wifi: {
[](#%5F%5Fcodelineno-8-8)      useWifiManager: undefined,
[](#%5F%5Fcodelineno-8-9)    },
[](#%5F%5Fcodelineno-8-10)  },
[](#%5F%5Fcodelineno-8-11)};
[](#%5F%5Fcodelineno-8-12)
[](#%5F%5Fcodelineno-8-13)export default config;
`

## Usage[¶](#usage "Permanent link")

`[](#%5F%5Fcodelineno-9-1)import { Wifi } from '@capawesome-team/capacitor-wifi';
[](#%5F%5Fcodelineno-9-2)
[](#%5F%5Fcodelineno-9-3)const connect = async () => {
[](#%5F%5Fcodelineno-9-4)    await Wifi.connect({
[](#%5F%5Fcodelineno-9-5)        ssid: 'MyNetwork',
[](#%5F%5Fcodelineno-9-6)        password: 'MyPassword',
[](#%5F%5Fcodelineno-9-7)        isHiddenSsid: false
[](#%5F%5Fcodelineno-9-8)    });
[](#%5F%5Fcodelineno-9-9)}
[](#%5F%5Fcodelineno-9-10)
[](#%5F%5Fcodelineno-9-11)const disconnect = async () => {
[](#%5F%5Fcodelineno-9-12)    await Wifi.disconnect();
[](#%5F%5Fcodelineno-9-13)}
[](#%5F%5Fcodelineno-9-14)
[](#%5F%5Fcodelineno-9-15)const getAvailableNetworks = async () => {
[](#%5F%5Fcodelineno-9-16)    const result = await Wifi.getAvailableNetworks();
[](#%5F%5Fcodelineno-9-17)    return result.networks;
[](#%5F%5Fcodelineno-9-18)}
[](#%5F%5Fcodelineno-9-19)
[](#%5F%5Fcodelineno-9-20)const getIpAddress = async () => {
[](#%5F%5Fcodelineno-9-21)    const result = await Wifi.getIpAddress();
[](#%5F%5Fcodelineno-9-22)    return result.address;
[](#%5F%5Fcodelineno-9-23)}
[](#%5F%5Fcodelineno-9-24)
[](#%5F%5Fcodelineno-9-25)const getRssi = async () => {
[](#%5F%5Fcodelineno-9-26)    const result = await Wifi.getRssi();
[](#%5F%5Fcodelineno-9-27)    return result.rssi;
[](#%5F%5Fcodelineno-9-28)}
[](#%5F%5Fcodelineno-9-29)
[](#%5F%5Fcodelineno-9-30)const getSsid = async () => {
[](#%5F%5Fcodelineno-9-31)    const result = await Wifi.getSsid();
[](#%5F%5Fcodelineno-9-32)    return result.ssid;
[](#%5F%5Fcodelineno-9-33)}
[](#%5F%5Fcodelineno-9-34)
[](#%5F%5Fcodelineno-9-35)const isEnabled = async () => {
[](#%5F%5Fcodelineno-9-36)    const result = await Wifi.isEnabled();
[](#%5F%5Fcodelineno-9-37)    return result.enabled;
[](#%5F%5Fcodelineno-9-38)}
[](#%5F%5Fcodelineno-9-39)
[](#%5F%5Fcodelineno-9-40)const startScan = async () => {
[](#%5F%5Fcodelineno-9-41)    await Wifi.startScan();
[](#%5F%5Fcodelineno-9-42)}
`

## API[¶](#api "Permanent link")

* [addNetwork(...)](#addnetwork)
* [connect(...)](#connect)
* [disconnect(...)](#disconnect)
* [getAvailableNetworks()](#getavailablenetworks)
* [getIpAddress()](#getipaddress)
* [getRssi()](#getrssi)
* [getSsid()](#getssid)
* [isEnabled()](#isenabled)
* [startScan()](#startscan)
* [checkPermissions()](#checkpermissions)
* [requestPermissions(...)](#requestpermissions)
* [addListener('networksScanned', ...)](#addlistenernetworksscanned-)
* [removeAllListeners()](#removealllisteners)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
* [Enums](#enums)

### addNetwork(...)[¶](#addnetwork "Permanent link")

`[](#%5F%5Fcodelineno-10-1)addNetwork(options: AddNetworkOptions) => Promise<void>
`

Show a system dialog to add a Wi-Fi network to the device.

If the user accepts, the network will be added to the device's list of known networks and the traffic will be routed through it.

Only available on Android (SDK 30+) and iOS.

| Param       | Type                                    |
| ----------- | --------------------------------------- |
| **options** | [AddNetworkOptions](#addnetworkoptions) |

**Since:** 7.1.0

---

### connect(...)[¶](#connect "Permanent link")

`[](#%5F%5Fcodelineno-11-1)connect(options: ConnectOptions) => Promise<void>
`

Connect to a Wi-Fi network.

On **Android**, the network will NOT be added to the device's list of known networks and NO traffic will be routed through it. If you want to route traffic through the network, use `addNetwork(...)` instead.

On **iOS**, this is the same as `addNetwork()`.

Only available on Android and iOS.

| Param       | Type                              |
| ----------- | --------------------------------- |
| **options** | [ConnectOptions](#connectoptions) |

**Since:** 6.0.0

---

### disconnect(...)[¶](#disconnect "Permanent link")

`[](#%5F%5Fcodelineno-12-1)disconnect(options?: DisconnectOptions | undefined) => Promise<void>
`

Disconnect from a Wi-Fi network.

On **iOS**, you can only disconnect from networks that you connected to using the plugin. This also removes the Wi-Fi network from the list of known networks.

Only available on Android and iOS.

| Param       | Type                                    |
| ----------- | --------------------------------------- |
| **options** | [DisconnectOptions](#disconnectoptions) |

**Since:** 6.0.0

---

### getAvailableNetworks()[¶](#getavailablenetworks "Permanent link")

`[](#%5F%5Fcodelineno-13-1)getAvailableNetworks() => Promise<GetAvailableNetworksResult>
`

Get a list of Wi-Fi networks found during the last scan.

The returned networks are the most recently updated results, which may be from a previous scan if your current scan has not completed or succeeded.

Only available on Android.

**Returns:** `Promise<[GetAvailableNetworksResult](#getavailablenetworksresult)>`

**Since:** 6.0.0

---

### getIpAddress()[¶](#getipaddress "Permanent link")

`[](#%5F%5Fcodelineno-14-1)getIpAddress() => Promise<GetIpAddressResult>
`

Get the current IP address of the device.

Only available on Android and iOS.

**Returns:** `Promise<[GetIpAddressResult](#getipaddressresult)>`

**Since:** 6.0.0

---

### getRssi()[¶](#getrssi "Permanent link")

`[](#%5F%5Fcodelineno-15-1)getRssi() => Promise<GetRssiResult>
`

Get the received signal strength indicator (RSSI) of the current network in dBm.

Only available on Android.

**Returns:** `Promise<[GetRssiResult](#getrssiresult)>`

**Since:** 6.0.0

---

### getSsid()[¶](#getssid "Permanent link")

`[](#%5F%5Fcodelineno-16-1)getSsid() => Promise<GetSsidResult>
`

Get the service set identifier (SSID) of the current network.

Only available on Android and iOS.

**Returns:** `Promise<[GetSsidResult](#getssidresult)>`

**Since:** 6.0.0

---

### isEnabled()[¶](#isenabled "Permanent link")

`[](#%5F%5Fcodelineno-17-1)isEnabled() => Promise<IsEnabledResult>
`

Check if Wi-Fi is enabled.

Only available on Android.

**Returns:** `Promise<[IsEnabledResult](#isenabledresult)>`

**Since:** 6.0.0

---

### startScan()[¶](#startscan "Permanent link")

`[](#%5F%5Fcodelineno-18-1)startScan() => Promise<void>
`

Start a scan for Wi-Fi networks.

This call may fail for any of the following reasons: - Scan requests may be throttled because of too many scans in a short time. - The device is idle and scanning is disabled. - Wi-Fi hardware reports a scan failure.

Only available on Android.

**Since:** 6.0.0

---

### checkPermissions()[¶](#checkpermissions "Permanent link")

`[](#%5F%5Fcodelineno-19-1)checkPermissions() => Promise<PermissionStatus>
`

Check permissions for the plugin.

Only available on Android and iOS.

**Returns:** `Promise<[PermissionStatus](#permissionstatus)>`

**Since:** 6.0.0

---

### requestPermissions(...)[¶](#requestpermissions "Permanent link")

`[](#%5F%5Fcodelineno-20-1)requestPermissions(options?: RequestPermissionsOptions | undefined) => Promise<PermissionStatus>
`

Request permissions for the plugin.

Only available on Android and iOS.

| Param       | Type                                                    |
| ----------- | ------------------------------------------------------- |
| **options** | [RequestPermissionsOptions](#requestpermissionsoptions) |

**Returns:** `Promise<[PermissionStatus](#permissionstatus)>`

**Since:** 6.0.0

---

### addListener('networksScanned', ...)[¶](#addlistenernetworksscanned "Permanent link")

`[](#%5F%5Fcodelineno-21-1)addListener(eventName: 'networksScanned', listenerFunc: (event: NetworksScannedEvent) => void) => Promise<PluginListenerHandle>
`

Called when the scan results are available.

Only available on Android.

| Param            | Type                                                           |
| ---------------- | -------------------------------------------------------------- |
| **eventName**    | 'networksScanned'                                              |
| **listenerFunc** | (event: [NetworksScannedEvent](#networksscannedevent)) => void |

**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`

**Since:** 6.0.0

---

### removeAllListeners()[¶](#removealllisteners "Permanent link")

`[](#%5F%5Fcodelineno-22-1)removeAllListeners() => Promise<void>
`

Remove all listeners for this plugin.

**Since:** 6.0.0

---

### Interfaces[¶](#interfaces "Permanent link")

#### AddNetworkOptions[¶](#addnetworkoptions "Permanent link")

| Prop             | Type                                                                                               | Description                                                                                                                                                                                                           | Default                 | Since |
| ---------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ----- |
| **ssid**         | string                                                                                             | The SSID of the network to add.                                                                                                                                                                                       | 7.1.0                   |       |
| **isHiddenSsid** | boolean                                                                                            | Whether or not the SSID is hidden. Only available on Android.                                                                                                                                                         | false                   | 6.0.0 |
| **password**     | string                                                                                             | The password of the network to add.                                                                                                                                                                                   | 7.1.0                   |       |
| **securityType** | [NetworkSecurityType.PSK](#networksecuritytype) \| [NetworkSecurityType.SAE](#networksecuritytype) | The security type of the network to add. Use [NetworkSecurityType.PSK](#networksecuritytype) for WPA/WPA2 networks. Use [NetworkSecurityType.SAE](#networksecuritytype) for WPA3 networks. Only available on Android. | NetworkSecurityType.PSK | 7.1.0 |

#### ConnectOptions[¶](#connectoptions "Permanent link")

| Prop             | Type    | Description                                                   | Default | Since |
| ---------------- | ------- | ------------------------------------------------------------- | ------- | ----- |
| **ssid**         | string  | The SSID of the network to connect to.                        | 6.0.0   |       |
| **isHiddenSsid** | boolean | Whether or not the SSID is hidden. Only available on Android. | false   | 6.0.0 |
| **password**     | string  | The password of the network to connect to.                    | 6.0.0   |       |

#### DisconnectOptions[¶](#disconnectoptions "Permanent link")

| Prop     | Type   | Description                                                                                                                              | Since |
| -------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **ssid** | string | The SSID of the network to disconnect from. If not provided, the device will disconnect from the current network. Only available on iOS. | 6.0.0 |

#### GetAvailableNetworksResult[¶](#getavailablenetworksresult "Permanent link")

| Prop         | Type        | Description                                            | Since |
| ------------ | ----------- | ------------------------------------------------------ | ----- |
| **networks** | Network\[\] | The list of Wi-Fi networks found during the last scan. | 6.0.0 |

#### Network[¶](#network "Permanent link")

| Prop              | Type                    | Description                                                                            | Since |
| ----------------- | ----------------------- | -------------------------------------------------------------------------------------- | ----- |
| **rssi**          | number                  | The received signal strength indicator (RSSI) of the network in dBm.                   | 6.1.0 |
| **securityTypes** | NetworkSecurityType\[\] | The service set identifier (SSID) of the network. Only available on Android (SDK 33+). | 6.1.0 |
| **ssid**          | string                  | The service set identifier (SSID) of the network.                                      | 6.0.0 |

#### GetIpAddressResult[¶](#getipaddressresult "Permanent link")

| Prop        | Type   | Description                   | Since |
| ----------- | ------ | ----------------------------- | ----- |
| **address** | string | The IP address of the device. | 6.0.0 |

#### GetRssiResult[¶](#getrssiresult "Permanent link")

| Prop     | Type   | Description                                                                  | Since |
| -------- | ------ | ---------------------------------------------------------------------------- | ----- |
| **rssi** | number | The received signal strength indicator (RSSI) of the current network in dBm. | 6.0.0 |

#### GetSsidResult[¶](#getssidresult "Permanent link")

| Prop     | Type   | Description                                                                                                                                                                                                        | Since |
| -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
| **ssid** | string | The service set identifier (SSID) of the current network. On **iOS 14+**, the SSID can only be retrieved if the network was connected to using the plugin or if the app has permission to access precise location. | 6.0.0 |

#### IsEnabledResult[¶](#isenabledresult "Permanent link")

| Prop        | Type    | Description                      | Since |
| ----------- | ------- | -------------------------------- | ----- |
| **enabled** | boolean | Whether or not Wi-Fi is enabled. | 6.0.0 |

#### PermissionStatus[¶](#permissionstatus "Permanent link")

| Prop         | Type                                | Since |
| ------------ | ----------------------------------- | ----- |
| **location** | [PermissionState](#permissionstate) | 6.0.0 |

#### RequestPermissionsOptions[¶](#requestpermissionsoptions "Permanent link")

| Prop            | Type           | Description                 | Default        | Since |
| --------------- | -------------- | --------------------------- | -------------- | ----- |
| **permissions** | 'location'\[\] | The permissions to request. | \["location"\] | 6.0.0 |

#### PluginListenerHandle[¶](#pluginlistenerhandle "Permanent link")

| Prop       | Type                |
| ---------- | ------------------- |
| **remove** | () => Promise<void> |

#### NetworksScannedEvent[¶](#networksscannedevent "Permanent link")

| Prop         | Type        | Description                                       | Since |
| ------------ | ----------- | ------------------------------------------------- | ----- |
| **networks** | Network\[\] | The list of Wi-Fi networks found during the scan. | 6.0.0 |

### Type Aliases[¶](#type-aliases "Permanent link")

#### PermissionState[¶](#permissionstate "Permanent link")

`'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'`

#### PermissionType[¶](#permissiontype "Permanent link")

`'location'`

### Enums[¶](#enums "Permanent link")

#### NetworkSecurityType[¶](#networksecuritytype "Permanent link")

| Members                             | Value | Description                                                                                | Since |
| ----------------------------------- | ----- | ------------------------------------------------------------------------------------------ | ----- |
| **UNKNOWN**                         | \-1   | Unknown security type.                                                                     | 6.1.0 |
| **OPEN**                            | 0     | Open network.                                                                              | 6.1.0 |
| **WEP**                             | 1     | WEP network.                                                                               | 6.1.0 |
| **PSK**                             | 2     | PSK (Pre-Shared Key) network. This includes WPA/WPA2/WPA3-Personal networks.               | 6.1.0 |
| **EAP**                             | 3     | EAP (Extensible Authentication Protocol) network.                                          | 6.1.0 |
| **SAE**                             | 4     | SAE (Simultaneous Authentication of Equals) network.                                       | 6.1.0 |
| **EAP\_WPA3\_ENTERPRISE\_192\_BIT** | 5     | WPA3-Enterprise in 192-bit security network.                                               | 6.1.0 |
| **OWE**                             | 6     | OWE network.                                                                               | 6.1.0 |
| **WAPI\_PSK**                       | 7     | WAPI PSK network.                                                                          | 6.1.0 |
| **WAPI\_CERT**                      | 8     | WAPI Certificate network.                                                                  | 6.1.0 |
| **WPA3\_ENTERPRISE**                | 9     | WPA3-Enterprise network.                                                                   | 6.1.0 |
| **OSEN**                            | 10    | OSEN network.                                                                              | 6.1.0 |
| **PASSPOINT\_R1\_R2**               | 11    | Passpoint R1/R2 network, where TKIP and WEP are not allowed.                               | 6.1.0 |
| **PASSPOINT\_R3**                   | 12    | Passpoint R3 network, where TKIP and WEP are not allowed, and PMF must be set to Required. | 6.1.0 |
| **DPP**                             | 13    | Easy Connect (DPP) network.                                                                | 6.1.0 |

## Changelog[¶](#changelog "Permanent link")

See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/wifi/CHANGELOG.md).

## Breaking Changes[¶](#breaking-changes "Permanent link")

See [BREAKING.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/wifi/BREAKING.md).

## License[¶](#license "Permanent link")

See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/wifi/LICENSE).

May 17, 2026 

 Back to top 