Merge "Modify docs to reflect operational changes in overrideConfig"

This commit is contained in:
Brad Ebinger
2019-04-17 20:25:32 +00:00
committed by Gerrit Code Review

View File

@@ -3048,17 +3048,21 @@ public class CarrierConfigManager {
/** /**
* Overrides the carrier config of the provided subscription ID with the provided values. * Overrides the carrier config of the provided subscription ID with the provided values.
* *
* Any further queries to carrier config from any process will return * Any further queries to carrier config from any process will return the overridden values
* the overriden values after this method returns. The overrides are effective for the lifetime * after this method returns. The overrides are effective for the lifetime of the phone process
* 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 * May throw an {@link IllegalArgumentException} if {@code overrideValues} contains invalid
* values for the specified config keys. * 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 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, * @param overrideValues Key-value pairs of the values that are to be overridden. If set to
* all previous overrides will be disabled and the config reset back to * {@code null}, this will remove all previous overrides and set the
* its initial state. * carrier configuration back to production values.
* @hide * @hide
*/ */
@RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE) @RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE)