跳到主要内容
版本:v2

Network

网络 API 提供用于监听网络状态变化的事件,并支持查询当前的网络状态。

示例

import { Plugins } from '@capacitor/core';

const { Network } = Plugins;

let handler = Network.addListener('networkStatusChange', (status) => {
console.log("网络状态已变更", status);
});
// 停止监听:
// handler.remove();

// 获取当前网络状态
let status = await Network.getStatus();

// 输出示例:
{
"connected": true,
"connectionType": "wifi"
}

Android 注意事项

网络 API 需要在你的 AndroidManifest.xml 中添加以下权限:

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

此权限允许应用访问当前网络的信息,例如是否连接到 Wi-Fi 或蜂窝网络。

API

getStatus()

getStatus() => Promise<NetworkStatus>

查询当前网络状态

返回值:

Promise<NetworkStatus>


addListener(...)

addListener(eventName: 'networkStatusChange', listenerFunc: (status: NetworkStatus) => void) => PluginListenerHandle

监听网络状态变更事件

参数类型
eventName"networkStatusChange"
listenerFunc
(status: NetworkStatus) => void

返回值:

PluginListenerHandle


removeAllListeners()

removeAllListeners() => void

移除此插件的所有原生监听器


接口

NetworkStatus

属性类型
connectedboolean
connectionType"none" | "unknown" | "wifi" | "cellular"

PluginListenerHandle

属性类型
remove() => void