@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