Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update javadoc of the newly introduced CarrirConfigManager APIs

Browse Source 
This CL updates the javadoc of the newly introduced carrier config
subset retrieval APIs to support keys without default values.

For historical reasons, some AOSP public or OEMs/carriers private
carrier config keys didn't provide default values. When retrieving
configs with such key, the current implementation return empty
bundle which may break those user cases.

The right behavior is that keys without default values will be filtered
out, but other valid keys/values will be kept as is in the returned bundle.

Bug: 244087782
Test: atest CarrirConfigManagerTest
Change-Id: I0f5593f8b5ba54bcd679be26a9a8db31ac33b461
This commit is contained in:
rambowang
2022-12-13 18:08:36 -06:00
parent 1d63e4f91b
commit afc9665161
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
telephony/java/android/telephony/CarrierConfigManager.java
View File

@@ -9986,7 +9986,8 @@ public class CarrierConfigManager {
* Gets the configuration values of the specified keys for a particular subscription. * Gets the configuration values of the specified keys for a particular subscription.
* *
* <p>If an invalid subId is used, the returned configuration will contain default values for * <p>If an invalid subId is used, the returned configuration will contain default values for
* the specified keys. * the specified keys. If the value for the key can't be found, the returned configuration will
* filter the key out.
* *
* <p>After using this method to get the configuration bundle, * <p>After using this method to get the configuration bundle,
* {@link #isConfigForIdentifiedCarrier(PersistableBundle)} should be called to confirm whether * {@link #isConfigForIdentifiedCarrier(PersistableBundle)} should be called to confirm whether
@@ -10004,8 +10005,8 @@ public class CarrierConfigManager {
* @param subId The subscription ID on which the carrier config should be retrieved. * @param subId The subscription ID on which the carrier config should be retrieved.
* @param keys The carrier config keys to retrieve values. * @param keys The carrier config keys to retrieve values.
* @return A {@link PersistableBundle} with key/value mapping for the specified configuration * @return A {@link PersistableBundle} with key/value mapping for the specified configuration
* on success, or an empty (but never null) bundle on failure (for example, when no value for * on success, or an empty (but never null) bundle on failure (for example, when the calling app
* the specified key can be found). * has no permission).
*/ */
@RequiresPermission(anyOf = { @RequiresPermission(anyOf = {
Manifest.permission.READ_PHONE_STATE, Manifest.permission.READ_PHONE_STATE,
@@ -10123,6 +10124,8 @@ public class CarrierConfigManager {
* Gets the configuration values of the specified config keys applied for the default * Gets the configuration values of the specified config keys applied for the default
* subscription. * subscription.
* *
* <p>If the value for the key can't be found, the returned bundle will filter the key out.
*
* <p>After using this method to get the configuration bundle, {@link * <p>After using this method to get the configuration bundle, {@link
* #isConfigForIdentifiedCarrier(PersistableBundle)} should be called to confirm whether any * #isConfigForIdentifiedCarrier(PersistableBundle)} should be called to confirm whether any
* carrier specific configuration has been applied. * carrier specific configuration has been applied.