ネットワークと Passpoint の構成を保存する

Android 11（SDK レベル 30）以降では、アプリは android.provider.Settings.ACTION_WIFI_ADD_NETWORKS インテントを使用して、1 つ以上の新しい保存済みネットワークまたは Passpoint 構成を追加する手順をユーザーに案内できます。この API は、既存の保存済み構成を変更するためにそのまま使用することもできます。

ネットワークまたは Passpoint の構成を保存するには、次の操作を行います。

  1. ACTION_WIFI_ADD_NETWORKS インテントを作成します。

  2. WifiNetworkSuggestion.Builder を使用して 1 つ以上の構成を作成します。WifiNetworkSuggestion を使用している場合でも、この Intent API は Suggestion API とは関係ありません。

  3. 構成の Parcelable 配列リストを作成し、EXTRA_WIFI_NETWORK_LIST エクストラを使用してインテントにアタッチします。

  4. インテントを渡して Activity.startActivityForResult() を実行します。

  5. Activity.onActivityResult() コールバックを使用して結果をリッスンします。

    resultCode は、以下のいずれかになります。

    • Activity.RESULT_OK: ユーザーが提案されたネットワークを承認して保存したことを示します。
    • Activity.RESULT_CANCELED: ユーザーが提案されたネットワークを拒否したことを示します。

    resultCode が RESULT_OK の場合、データ Intent には EXTRA_WIFI_NETWORK_RESULT_LIST エクストラが含まれます。これには、個々の構成が正常に保存されたかどうかを示す結果コードの配列が含まれます。結果コードは次のとおりです。

  6. リクエストが成功すると、プラットフォームは新しく保存されたネットワークのいずれかへの接続をトリガーします。

コードサンプル

次のコードサンプルは、ネットワークまたは Passpoint 構成を保存する方法を示しています。

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        ...
    }

    fun startOperation() {
        val suggestions = ArrayList<WifiNetworkSuggestion>()

        // WPA2 configuration
        suggestions.add(
                WifiNetworkSuggestion.Builder()
                        .setSsid("test111111")
                        .setWpa2Passphrase("test123456")
                        .build()
        )

        // Open configuration
        suggestions.add(
                WifiNetworkSuggestion.Builder()
                        .setSsid("test222222")
                        .build()
        )

        // Passpoint configuration
        val config = PasspointConfiguration()
        config.credential = Credential().apply {
            realm = "realm.example.com"
            simCredential = Credential.SimCredential().apply {
                eapType = 18
                imsi = "123456*"
            }
        }
        config.homeSp = HomeSp().apply {
            fqdn = "test1.example.com"
            friendlyName = "Some Friendly Name"
        }
        suggestions.add(
                WifiNetworkSuggestion.Builder()
                        .setPasspointConfig(config)
                        .build())

        // Create intent
        val bundle = Bundle()
        bundle.putParcelableArrayList(EXTRA_WIFI_NETWORK_LIST, suggestions)
        val intent = Intent(ACTION_WIFI_ADD_NETWORKS)
        intent.putExtras(bundle)

        // Launch intent
        startActivityForResult(intent, 0)
    }

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)
        if(resultCode == RESULT_OK) {
            // user agreed to save configurations: still need to check individual results
            if (data != null && data.hasExtra(EXTRA_WIFI_NETWORK_RESULT_LIST)) {
                for (code in data.getIntegerArrayListExtra(EXTRA_WIFI_NETWORK_RESULT_LIST)) {
                    when (code) {
                        ADD_WIFI_RESULT_SUCCESS ->
                            ... // Configuration saved or modified
                        ADD_WIFI_RESULT_ADD_OR_UPDATE_FAILED ->
                            ... // Something went wrong - invalid configuration
                        ADD_WIFI_RESULT_ALREADY_EXISTS ->
                            ... // Configuration existed (as-is) on device, nothing changed
                        else ->
                            ... // Other errors
                    }
                }
            }
        } else {
            // User refused to save configurations
        }
    }
}