@capacitor/network

網路 API 提供網路和連線資訊。

安裝

npm install @capacitor/network
npx cap sync

範例

import { Network } from '@capacitor/network';

Network.addListener('networkStatusChange', status => {
  console.log('Network status changed', status);
});

const logCurrentNetworkStatus = async () => {
  const status = await Network.getStatus();

  console.log('Network status:', status);
};

API

• getStatus()
• addListener('networkStatusChange', ...)
• removeAllListeners()
• 介面
• 類型別名

getStatus()

getStatus() => Promise<ConnectionStatus>

查詢目前網路連線狀態。

回傳： Promise<ConnectionStatus>

自 1.0.0

---

addListener('networkStatusChange', ...)

addListener(eventName: 'networkStatusChange', listenerFunc: ConnectionStatusChangeListener) => Promise<PluginListenerHandle>

監聽網路連線的變更。

參數	類型
eventName	'networkStatusChange'
listenerFunc	ConnectionStatusChangeListener

回傳： Promise<PluginListenerHandle>

自 1.0.0

---

removeAllListeners()

removeAllListeners() => Promise<void>

移除此外掛程式的所有監聽器（包括網路狀態變更）。

自 1.0.0

---

介面

ConnectionStatus

代表網路連線的狀態和類型。

屬性	類型	描述	自
connected	boolean	是否有作用中的連線。	1.0.0
connectionType	ConnectionType	目前使用的網路連線類型。如果沒有作用中的網路連線，則 connectionType 將為 'none'。	1.0.0

PluginListenerHandle

屬性	類型
remove	() => Promise<void>

類型別名

ConnectionType

裝置可能具有的網路連線類型。

'wifi' | 'cellular' | 'none' | 'unknown'

ConnectionStatusChangeListener

接收狀態變更通知的回呼。

(status: ConnectionStatus): void