summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Brad Ebinger <breadley@google.com> 2019-04-15 17:10:26 -0700
committer Brad Ebinger <breadley@google.com> 2019-04-16 13:47:46 -0700
commita298e676779f390f2754ba8c53d3521f2a4a7916 (patch)
tree4a346bd7b4cecc76a00c115cdf320aa1a9cb0e2b
parenta49f1b725f60949ca4321efe5a09631772450561 (diff)
Modify docs to reflect operational changes in overrideConfig
Bug: 130372397 Test: Manual Change-Id: I8958cb04d734ddd3dc8a9b5812dca265c008225b
-rwxr-xr-xtelephony/java/android/telephony/CarrierConfigManager.java16
1 files changed, 10 insertions, 6 deletions
diff --git a/telephony/java/android/telephony/CarrierConfigManager.java b/telephony/java/android/telephony/CarrierConfigManager.java
index 0dd661413dfd..fa5ae06e58cd 100755
--- a/telephony/java/android/telephony/CarrierConfigManager.java
+++ b/telephony/java/android/telephony/CarrierConfigManager.java
@@ -3028,17 +3028,21 @@ public class CarrierConfigManager {
/**
* Overrides the carrier config of the provided subscription ID with the provided values.
*
- * Any further queries to carrier config from any process will return
- * the overriden values after this method returns. The overrides are effective for the lifetime
- * of the phone process.
+ * Any further queries to carrier config from any process will return the overridden values
+ * after this method returns. The overrides are effective for the lifetime of the phone process
+ * until the user passes in {@code null} for {@code overrideValues}. This removes all previous
+ * overrides and sets the carrier config back to production values.
*
* May throw an {@link IllegalArgumentException} if {@code overrideValues} contains invalid
* values for the specified config keys.
*
+ * NOTE: This API is meant for testing purposes only and may only be accessed from the shell UID
+ * during instrumentation testing.
+ *
* @param subscriptionId The subscription ID for which the override should be done.
- * @param overrideValues Key-value pairs of the values that are to be overriden. If null,
- * all previous overrides will be disabled and the config reset back to
- * its initial state.
+ * @param overrideValues Key-value pairs of the values that are to be overridden. If set to
+ * {@code null}, this will remove all previous overrides and set the
+ * carrier configuration back to production values.
* @hide
*/
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)