1.0.7 • Published 8 months ago

capacitorjs-plugin-wifi v1.0.7

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

capacitor-plugin-wifi

Capacitor JS plugin that work as wrapper of WifiManager of Android

Install

npm install capacitor-plugin-wifi
npx cap sync

API

checkPermission()

checkPermission() => Promise<{ status: string; }>

Returns: Promise<{ status: string; }>


requestPermission()

requestPermission() => void

wifiScan()

wifiScan() => Promise<{ networks: ScanResult[]; error: string | undefined; }>

Returns: Promise<{ networks: ScanResult[]; error: string; }>


getWifiStatus()

getWifiStatus() => Promise<{ status: boolean; }>

Returns: Promise<{ status: boolean; }>


getSupportedBands()

getSupportedBands() => Promise<SupportedBands>

Returns: Promise<SupportedBands>


changeWifiStatus()

changeWifiStatus() => Promise<{ status: boolean; }>

Returns: Promise<{ status: boolean; }>


disconnect()

disconnect() => Promise<{ status: boolean; }>

Returns: Promise<{ status: boolean; }>


getCurrentNetworkConfiguration()

getCurrentNetworkConfiguration() => Promise<Wifi>

Returns: Promise<Wifi>


getDHCPInfo()

getDHCPInfo() => Promise<DhcpInfo>

Returns: Promise<DhcpInfo>


isP2PSupported()

isP2PSupported() => Promise<{ p2p_supported: boolean; }>

Returns: Promise<{ p2p_supported: boolean; }>


Interfaces

ScanResult

PropType
BSSIDstring
SSIDstring
capabilitiesstring
centerFreq0number | null
centerFreq1number | null
frequencynumber
levelnumber
timestampnumber

SupportedBands

PropType
WiFi24boolean
WiFi5boolean
WiFi6boolean
WiFi60boolean

Wifi

PropType
ssidstring
bssidstring
frequencynumber
hiddenboolean
ip_addressnumber
link_speednumber
mac_addressstring
network_idnumber
rssinumber
current_rx_speednumber | null
current_tx_speednumber | null
fqdnstring | null
passpoint_provider_friendly_namestring | null
max_rx_speedstring | null
max_tx_speedstring | null
wifi_standardnumber | null
securitynumber | null
mlo_linksRecord<string, unknown>[] | null
mldstring | null
mlo_idnumber | null
associated_mlo_linksRecord<string, unknown>[] | null

DhcpInfo

PropType
dns1number
dns2number
gatewaynumber
ipAddressnumber
leaseDurationnumber
netmasknumber
serverAddressnumber

Type Aliases

Record

Construct a type with a set of properties K of type T

{

}

Check example for more information.

1.0.2

10 months ago

1.0.1

10 months ago

1.0.7

8 months ago

1.0.6

8 months ago

1.0.5

8 months ago

1.0.4

8 months ago

1.0.3

8 months ago

1.0.0

11 months ago