跳过内容

@capgo/capacitor-wifi

设备WiFi连接管理插件

用于管理设备Wi-Fi连接的WiFi插件。

  • addNetwork - 在设备上显示一个系统对话框,添加一个Wi-Fi网络。 在Android SDK 30+上,这会打开系统Wi-Fi设置,并将网络预填充。 在iOS上,这会直接连接到网络。
  • connect - 连接到Wi-Fi网络。 在Android上,这会创建一个临时连接,除非设置autoRouteTraffic为true,否则不会将流量绑定到连接的网络(对于本地/设备托管AP有用)。 在Android上使用addNetwork()来创建一个持久连接。 在iOS上,这会创建一个持久连接。
  • disconnect - 从当前Wi-Fi网络断开连接。 在iOS上,只断开了通过此插件添加的网络。
  • getAvailableNetworks - 获取上一次扫描后可用的Wi-Fi网络列表。 只在Android上可用。
MethodDescription
addNetworkShow a system dialog to add a Wi-Fi network to the device. On Android SDK 30+, this opens the system Wi-Fi settings with the network pre-filled. On iOS, this connects to the network directly.
connect连接到 Wi-Fi 网络。 在 Android 上,创建一个临时连接,流量不通过网络。 设置 autoRouteTraffic 为 true,绑定应用流量到连接的网络(适用于本地/设备托管 AP)。 在 Android 上,使用 addNetwork() 代替创建持久连接。 在 iOS 上,创建持久连接。
disconnect断开当前 Wi-Fi 网络连接。 在 iOS 上,只断开通过此插件添加的网络。
getAvailableNetworks获取上一次扫描后可用的 Wi-Fi 网络列表。 只在 Android 上可用。
getIpAddress获取设备的当前 IP 地址。 在 Android 和 iOS 上都可用。
getRssi获取当前网络的接收信号强度指标(RSSI)值,单位为 dBm。 只在 Android 上可用。
getSsid获取当前网络的服务集标识符(SSID)。 在 Android 和 iOS 上都可用。
getWifiInfo获取当前连接的 Wi-Fi 网络的详细信息。 此方法提供 SSID、BSSID、IP 地址、频率、链路速度和信号强度等信息。 在 iOS 上,某些字段可能不可用,会返回 undefined。
isEnabled检查设备是否启用了 Wi-Fi。 只在 Android 上可用。
startScan开始扫描Wi-Fi网络。仅在Android上可用。结果通过‘networksScanned’事件监听器传递。注意:可能由于系统限制或硬件问题而失败。
checkPermissions检查当前位置访问权限的状态。位置权限在两种平台上都需要,用于Wi-Fi操作。
requestPermissions向用户请求位置权限。位置权限在两种平台上都需要,用于Wi-Fi操作。
addListener添加‘networksScanned’事件的监听器。仅在Android上可用。该事件在Wi-Fi扫描结果可用时触发。
removeAllListeners移除此插件的所有监听器。
getPluginVersion获取本地插件版本。

此参考是从 src/definitions.tscapacitor-wifi.

如果您正在使用 @capgo/capacitor-wifi 来规划原生插件工作,连接它与 使用 @capgo/capacitor-wifi 来实现原生能力的 Using @capgo/capacitor-wifi, Capgo 插件目录 来实现产品工作流程的 Capgo 插件目录, Capacitor 由 Capgo 的插件 来实现细节的 Capacitor 由 Capgo 的插件, 添加或更新插件 来实现细节的添加或更新插件,和 Ionic 企业版插件替代品 为 Ionic 企业版插件替代品中的产品工作流程