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

Merge "Update javadoc of the newly introduced CarrirConfigManager APIs"

Browse Source
This commit is contained in:
Rambo Wang
2023-03-09 22:00:34 +00:00
committed by Gerrit Code Review
parent e1cd25ae2c 26f4c5d2c3
commit 756cf6254c
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

@@ -9377,7 +9377,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
@@ -9395,8 +9396,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,
@@ -9514,6 +9515,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.