Further Clarify Scope of KEY_CARRIER_NAME_OVERRIDE
There is still confusion about the scope of the
KEY_CARRIER_NAME_OVERRIDE. This CL further clarifies
that the carrier, for purposes of this string, is the
service provider. Thus, the CARRIER_NAME_OVERRIDE will
still be subject to SPN display rules.
Note: to use this override in scenarios such as roaming
where the display rules may not choose the name of the
home operator (and thus not choose this override), a
service provider may choose to use other flags such as
KEY_FORCE_HOME_NETWORK_BOOL and
KEY_SPN_DISPLAY_RULE_USE_ROAMING_FROM_SERVICE_STATE_BOOL
to achieve the desired display behavior.
Bug: 77461054
Test: none (docstring-only change)
Change-Id: Id866df7ef9ce593de1f9d31d2556af4bfc766a8e
diff --git a/telephony/java/android/telephony/CarrierConfigManager.java b/telephony/java/android/telephony/CarrierConfigManager.java
index 288411a..511ba0f 100644
--- a/telephony/java/android/telephony/CarrierConfigManager.java
+++ b/telephony/java/android/telephony/CarrierConfigManager.java
@@ -1013,11 +1013,13 @@
/**
* Unconditionally override the carrier name string using #KEY_CARRIER_NAME_STRING.
*
- * If true, then the carrier display name will be #KEY_CARRIER_NAME_STRING, unconditionally.
+ * If true, then the carrier name string will be #KEY_CARRIER_NAME_STRING, unconditionally.
*
* <p>If false, then the override will be performed conditionally and the
* #KEY_CARRIER_NAME_STRING will have the lowest-precedence; it will only be used in the event
- * that the name string would otherwise be empty, allowing it to serve as a last-resort.
+ * that the name string would otherwise be empty, allowing it to serve as a last-resort. If
+ * used, this value functions in place of the SPN on any/all ICC records for the corresponding
+ * subscription.
*/
public static final String KEY_CARRIER_NAME_OVERRIDE_BOOL = "carrier_name_override_bool";