ngtinn59 / community-capacitor-wifi

API

• getIP()
• getSSID()
• connect(...)
• connectPrefix(...)
• disconnect()
• getScanResults(...)
• addListener('wifiStatusChange', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

getIP()

getIP() => Promise<{ ip: string | null; }>

Returns: Promise<{ ip: string | null; }>

---

getSSID()

getSSID() => Promise<{ ssid: string | null; }>

Returns: Promise<{ ssid: string | null; }>

---

connect(...)

connect(options: { ssid: string; password?: string; joinOnce?: boolean; isHiddenSsid?: boolean; }) => Promise<{ ssid: string | null; }>

Param	Type
options	{ ssid: string; password?: string; joinOnce?: boolean; isHiddenSsid?: boolean; }

Returns: Promise<{ ssid: string | null; }>

---

connectPrefix(...)

connectPrefix(options: { ssid: string; password?: string; joinOnce?: boolean; }) => Promise<{ ssid: string | null; }>

Param	Type
options	{ ssid: string; password?: string; joinOnce?: boolean; }

Returns: Promise<{ ssid: string | null; }>

---

disconnect()

disconnect() => Promise<void>

---

getScanResults(...)

getScanResults(filter?: string | undefined) => Promise<{ ssids: any[]; }>

Param	Type
filter	string

Returns: Promise<{ ssids: any[]; }>

---

addListener('wifiStatusChange', ...)

addListener(eventName: "wifiStatusChange", listenerFunc: WifiStatusChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Param	Type
eventName	'wifiStatusChange'
listenerFunc	WifiStatusChangeListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

---

removeAllListeners()

removeAllListeners() => Promise<void>

---

Interfaces

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

WifiStatus

Prop	Type
connected	boolean

Type Aliases

WifiStatusChangeListener

(status: WifiStatus): void