From 2fc81693c0ba507b50af1de7506d088bddeae4d4 Mon Sep 17 00:00:00 2001 From: Tyler Gunn Date: Tue, 23 Apr 2019 08:55:56 -0700 Subject: [PATCH] Update API docs for country ISO APIs. Updating to make it more clear the format of the returned country ISO codes. Test: Build Fixes: 131154060 Change-Id: I10c00c1a48e36e00720f50e85d6bb931756f1085 --- .../java/android/telephony/TelephonyManager.java | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/telephony/java/android/telephony/TelephonyManager.java b/telephony/java/android/telephony/TelephonyManager.java index e1425b9755256..f41b641b3101e 100644 --- a/telephony/java/android/telephony/TelephonyManager.java +++ b/telephony/java/android/telephony/TelephonyManager.java @@ -2276,12 +2276,15 @@ public class TelephonyManager { } /** - * Returns the ISO country code equivalent of the MCC (Mobile Country Code) of the current + * Returns the ISO-3166 country code equivalent of the MCC (Mobile Country Code) of the current * registered operator or the cell nearby, if available. - * . + *

+ * The ISO-3166 country code is provided in lowercase 2 character format. *

* Note: Result may be unreliable on CDMA networks (use {@link #getPhoneType()} to determine * if on a CDMA network). + *

+ * @return the lowercase 2 character ISO-3166 country code, or empty string if not available. */ public String getNetworkCountryIso() { return getNetworkCountryIsoForPhone(getPhoneId()); @@ -3140,7 +3143,10 @@ public class TelephonyManager { } /** - * Returns the ISO country code equivalent for the SIM provider's country code. + * Returns the ISO-3166 country code equivalent for the SIM provider's country code. + *

+ * The ISO-3166 country code is provided in lowercase 2 character format. + * @return the lowercase 2 character ISO-3166 country code, or empty string is not available. */ public String getSimCountryIso() { return getSimCountryIsoForPhone(getPhoneId());