Skip to content
Capgo - Capacitor アプリのリアルタイム更新 Capgo

@capgo/capacitor-wifi

デバイスのWi-Fi接続性を管理するためのWi-Fiプラグイン。
はじめに GitHub

概要

「概要」のセクション

デバイスのWi-Fi接続性を管理するためのWi-Fiプラグイン。

基本機能

「基本機能」のセクション
  • addNetwork - Android デバイスに Wi-Fi ネットワークを追加するシステムダイアログを表示します。Android SDK 30+ では、システム Wi-Fi 設定を開き、ネットワークを事前に埋め込むことで、ネットワークを事前に埋め込むことでシステム Wi-Fi 設定を開きます。iOS では、直接ネットワークに接続します。
  • connect - Wi-Fi ネットワークに接続します。Android では、デフォルトではネットワークを経由してトラフィックをルーティングしない一時的な接続を作成します。autoRouteTraffic を true に設定すると、接続されたネットワークにアプリのトラフィックをバインドできます (ローカル/デバイスホスト AP の場合に便利)。Android では、持続的な接続を作成するには addNetwork() を使用してください。iOS では、持続的な接続を作成します。
  • disconnect - 現在の Wi-Fi ネットワークから切断します。iOS では、このプラグインを介して追加されたネットワークのみから切断します。
  • getAvailableNetworks - 最近のスキャンから利用可能な Wi-Fi ネットワークの一覧を取得します。Android でのみ利用可能です。

Public API

「Public API」というタイトルのセクション
MethodDescription
addNetworkAndroid デバイスに Wi-Fi ネットワークを追加するシステムダイアログを表示します。Android SDK 30+ では、システム Wi-Fi 設定を開き、ネットワークを事前に埋め込むことで、ネットワークを事前に埋め込むことでシステム Wi-Fi 設定を開きます。iOS では、直接ネットワークに接続します。
connectWi-Fi ネットワークに接続します。Android では、デフォルトではネットワークを経由してトラフィックをルーティングしない一時的な接続を作成します。autoRouteTraffic を true に設定すると、接続されたネットワークにアプリのトラフィックをバインドできます (ローカル/デバイスホスト AP の場合に便利)。Android では、持続的な接続を作成するには addNetwork() を使用してください。iOS では、持続的な接続を作成します。
disconnectWi-Fi ネットワークから切断します。iOS では、このプラグインを介して追加されたネットワークのみから切断します。
getAvailableNetworks__CAPGO_KEEP_0__のWi-Fi ネットワークのリストを取得します。Androidのみで利用可能です。
getIpAddress__CAPGO_KEEP_0__の現在のIPアドレスを取得します。AndroidとiOS両方で利用可能です。
getRssi__CAPGO_KEEP_0__の現在のネットワークの受信信号強度（RSSI）を取得します。Androidのみで利用可能です。
getSsid__CAPGO_KEEP_0__の現在のネットワークのサービスセット識別子（SSID）を取得します。AndroidとiOS両方で利用可能です。
getWifiInfo__CAPGO_KEEP_0__の現在接続しているWi-Fi ネットワークの詳細情報を取得します。このメソッドでは、SSID、BSSID、IPアドレス、周波数、リンクスピード、信号強度などの詳細情報を1つの呼び出しで取得できます。iOSでは、あるフィールドが利用できない場合、undefinedになります。
isEnabled__CAPGO_KEEP_0__のWi-Fi が有効かどうかを確認します。Androidのみで利用可能です。
startScan__CAPGO_KEEP_0__のWi-Fi ネットワークをスキャンします。Androidのみで利用可能です。結果は‘networksScanned’イベントリスナー経由で提供されます。注意：システムのトラッキングやハードウェアの問題により失敗する可能性があります。
checkPermissions__CAPGO_KEEP_0__の現在の位置許可状況を確認します。位置許可は、両方のプラットフォームでWi-Fi オペレーションに必要です。
requestPermissions__CAPGO_KEEP_0__の位置許可をユーザーに要求します。位置許可は、両方のプラットフォームでWi-Fi オペレーションに必要です。
addListener__CAPGO_KEEP_0__の‘networksScanned’イベントリスナーを追加します。Androidのみで利用可能です。このイベントは、Wi-Fi スキャン結果が利用可能になったときに発生します。
removeAllListeners__CAPGO_KEEP_0__のすべてのリスナーを削除します。
getPluginVersion__CAPGO_KEEP_0__のネイティブ プラグインのバージョンを取得します。

真実の源

「真実の源」というセクション

__CAPGO_KEEP_0__から同期されたこのリファレンスは src/definitions.ts で capacitor-wifi.