From 134ff877e700dc6617fdd133cb6c3f63486e43bd Mon Sep 17 00:00:00 2001 From: Brad Ebinger Date: Wed, 17 Apr 2019 15:27:13 -0700 Subject: [PATCH] Modify docs to reflect operational changes in overrideConfig Bug: 130372397 Test: Manual Merged-In: Iff2a6e2cf867ab2e8677ac67f31d87e0365ec9fa Change-Id: Iff2a6e2cf867ab2e8677ac67f31d87e0365ec9fa (cherry picked from commit ddad44d41a32c7fbad33745c4542ce2931d627f4) --- .../android/telephony/CarrierConfigManager.java | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/telephony/java/android/telephony/CarrierConfigManager.java b/telephony/java/android/telephony/CarrierConfigManager.java index d2f88bbda6544..33d5c04a8e5c9 100755 --- a/telephony/java/android/telephony/CarrierConfigManager.java +++ b/telephony/java/android/telephony/CarrierConfigManager.java @@ -3280,17 +3280,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)