跳转到正文

@capgo/capacitor-wifi

管理 Capacitor 应用的 WiFi 连接

管理 Capacitor 应用的 WiFi 连接

从 addNetwork() 以及下方列出的其他核心方法。

平台支持备注
iOS是原生
Android是原生
Web 端否使用 Capacitor.getPlatform() 做保护
  • 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 可用。
方法描述
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 可用。
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.ts 中的 capacitor-wifi.

继续从 @capgo/capacitor-wifi 开始

从 @capgo/capacitor-wifi 继续

如果你正在使用 @capgo/capacitor-wifi 要规划原生插件工作,请将其与 使用 @capgo/capacitor-wifi 关于使用 @capgo/capacitor-wifi 中的原生能力, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节, 添加或更新插件 关于“添加或更新插件”中的实现细节,以及 Ionic Enterprise 插件替代方案 关于“Ionic Enterprise 插件替代方案”中的产品工作流。