@capgo/capacitor-wifi

概要

Capacitor アプリのWiFi接続を管理

まずはこちらから addNetwork() および以下に示すその他のコアメソッド。

プラットフォーム対応

プラットフォーム	サポート	備考
iOSと	はい	ネイティブ
Android	はい	ネイティブ
Web	いいえ	Capacitor.getPlatform() でガード

コア機能

• addNetwork - システムダイアログを表示して、デバイスにWi-Fiネットワークを追加します。Android SDK 30+ では、ネットワーク情報が入力された状態でシステム設定が開きます。iOS では、ネットワークに直接接続します。
• connect - Wi-Fiネットワークに接続します。Android では、デフォルトでトラフィックをルーティングしない一時的な接続を作成します。アプリの通信を接続中のネットワークにバインドする場合は、autoRouteTraffic を true に設定してください（ローカル/デバイスホストの AP に便利です）。Android で永続的な接続が必要な場合は、代わりに addNetwork() を使用してください。iOS では、永続的な接続を作成します。
• disconnect - 現在のWi-Fiネットワークから切断します。iOS では、このプラグイン経由で追加されたネットワークのみ切断されます。
• getAvailableNetworks - 前回のスキャンによる利用可能なWi-Fiネットワークの一覧を取得します。Android でのみ利用可能です。

公開 API

メソッド	説明
addNetwork	デバイスにWi-Fiネットワークを追加するシステムダイアログを表示します。Android SDK 30以上では、ネットワークが入力済みの状態でシステムのWi-Fi設定が開きます。iOSでは、そのネットワークに直接接続します。
connect	Wi-Fiネットワークに接続します。Androidでは、デフォルトではそのネットワークにトラフィックを流さない一時的な接続を作成します。アプリの通信を接続先のネットワークにバインドするには、autoRouteTrafficをtrueに設定してください（ローカルAPやデバイス上の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アドレス、周波数、リンク速度、信号強度などの詳細なネットワーク情報を1回の呼び出しで提供します。iOSでは、一部のフィールドは利用できない場合があり、undefinedになります。
isEnabled	デバイスのWi-Fiが有効かどうかを確認します。Androidでのみ利用可能です。
startScan	Wi-Fiネットワークのスキャンを開始します。Androidのみ利用可能です。結果は‘networksScanned’イベントリスナー経由で受け取ります。注意：システムのスロットリングやハードウェアの問題で失敗する場合があります。
checkPermissions	位置情報アクセスの現在の権限状態を確認します。両プラットフォームとも、Wi-Fiの操作には位置情報の権限が必要です。
requestPermissions	ユーザーに位置情報の権限をリクエストします。両プラットフォームとも、Wi-Fiの操作には位置情報の権限が必要です。
addListener	‘networksScanned’イベントのリスナーを追加します。Androidのみ利用可能です。このイベントはWi-Fiのスキャン結果が利用可能になったときに発生します。
removeAllListeners	このプラグインのすべてのリスナーを削除します。
getPluginVersion	ネイティブプラグインのバージョンを取得します。

Source of Truth

このリファレンスは以下から同期されています： src/definitions.ts における capacitor-wifi.

@capgo/capacitor-wifi から続ける

使用している場合 @capgo/capacitor-wifi ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-wifi の使用方法 「@capgo/capacitor-wifi の使い方」のネイティブ機能について、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。