跳过内容

@capgo/capacitor-wifi

WiFi插件,用于管理设备WiFi连接。

WiFi 插件用于管理设备 WiFi 连接。

核心能力

核心能力部分
  • addNetwork - 在设备上显示一个系统对话框,添加一个Wi-Fi网络。 在Android SDK 30+上,这会打开系统Wi-Fi设置,网络预填充。 在iOS上,这会直接连接到网络。
  • connect - 连接到一个Wi-Fi网络。 在Android上,这会创建一个临时连接,除非设置autoRouteTraffic为true,否则不会将流量路由到网络。 对于Android上的持久连接,请使用addNetwork()方法。 在iOS上,这会创建一个持久连接。
  • disconnect - 从当前Wi-Fi网络断开连接。 在iOS上,只断开通过此插件添加的网络。
  • getAvailableNetworks - 获取上一次扫描后可用的Wi-Fi网络列表。 只在Android上可用。

Public API

公共API
方法描述
addNetwork在设备上显示一个系统对话框,添加一个Wi-Fi网络。 在Android SDK 30+上,这会打开系统Wi-Fi设置,网络预填充。 在iOS上,这会直接连接到网络。
connect连接到一个Wi-Fi网络。 在Android上,这会创建一个临时连接,除非设置autoRouteTraffic为true,否则不会将流量路由到网络。 对于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 用于在使用 @capgo/capacitor-wifi 中的原生能力 Capgo 插件目录 为产品工作流程在 Capgo 插件目录 Capacitor 插件由 Capgo 为实现细节在 Capacitor 插件由 Capgo 添加或更新插件 为实现细节在添加或更新插件,并 Ionic 企业插件替代品 为产品工作流程在 Ionic 企业插件替代品。