儲存網路和 Passpoint 設定

在 Android 11 (SDK 級別 30) 以上版本中，應用程式可以使用 android.provider.Settings.ACTION_WIFI_ADD_NETWORKS 意圖，引導使用者新增一或多個已儲存的網路或 Passpoint 設定。這個 API 也能用於修改現有的已儲存設定。

注意： 此 API 的功能最接近已淘汰 WifiManager.addNetwork(WifiConfiguration config) API 的功能，會將產生的設定加入面向使用者並代管的已儲存網路和訂閱清單。

如要儲存網路或 Passpoint 設定，請按照下列步驟操作：

1. 建立 ACTION_WIFI_ADD_NETWORKS 意圖。

2. 使用 WifiNetworkSuggestion.Builder 建立一或多個設定。請注意，即使您使用 WifiNetworkSuggestion，這個 Intent API 與 Suggestion API 無關。

3. 建立可分割的設定陣列清單，並透過 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 額外資料，其中包含結果碼陣列，用於指出是否已成功儲存個別設定。可能的結果代碼如下：

   • ADD_WIFI_RESULT_SUCCESS：已新增或已成功更新設定。
   • ADD_WIFI_RESULT_ADD_OR_UPDATE_FAILED：嘗試新增設定時失敗，例如因設定格式不正確而失敗。
   • ADD_WIFI_RESULT_ALREADY_EXISTS：已存在要求的設定，因此無須採取任何行動。

6. 如果要求成功，平台會觸發與其中一個新儲存網路的連線。

程式碼範例

以下程式碼範例說明如何儲存網路或無線基地台設定。

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
        }
    }
}