Update javadoc for TelephonyManager.getNetwork* for CDMA.

These are unreliable for CDMA, so note it in the javadoc. Also update
for the corresponding TelephonyProperties.
This commit is contained in:
jsh
2009-07-13 12:36:04 -07:00
parent ea5c044412
commit aa4593706e
2 changed files with 19 additions and 10 deletions

View File

@@ -322,7 +322,9 @@ public class TelephonyManager {
/**
* Returns the alphabetic name of current registered operator.
* <p>
* Availability: Only when user is registered to a network
* Availability: Only when user is registered to a network. Result may be
* unreliable on CDMA networks (use {@link #getPhoneType()} to determine if
* on a CDMA network).
*/
public String getNetworkOperatorName() {
return SystemProperties.get(TelephonyProperties.PROPERTY_OPERATOR_ALPHA);
@@ -331,7 +333,9 @@ public class TelephonyManager {
/**
* Returns the numeric name (MCC+MNC) of current registered operator.
* <p>
* Availability: Only when user is registered to a network
* Availability: Only when user is registered to a network. Result may be
* unreliable on CDMA networks (use {@link #getPhoneType()} to determine if
* on a CDMA network).
*/
public String getNetworkOperator() {
return SystemProperties.get(TelephonyProperties.PROPERTY_OPERATOR_NUMERIC);
@@ -341,7 +345,7 @@ public class TelephonyManager {
* Returns true if the device is considered roaming on the current
* network, for GSM purposes.
* <p>
* Availability: Only when user registered to a network
* Availability: Only when user registered to a network.
*/
public boolean isNetworkRoaming() {
return "true".equals(SystemProperties.get(TelephonyProperties.PROPERTY_OPERATOR_ISROAMING));
@@ -351,7 +355,9 @@ public class TelephonyManager {
* Returns the ISO country code equivilent of the current registered
* operator's MCC (Mobile Country Code).
* <p>
* Availability: Only when user is registered to a network
* Availability: Only when user is registered to a network. Result may be
* unreliable on CDMA networks (use {@link #getPhoneType()} to determine if
* on a CDMA network).
*/
public String getNetworkCountryIso() {
return SystemProperties.get(TelephonyProperties.PROPERTY_OPERATOR_ISO_COUNTRY);

View File

@@ -40,14 +40,16 @@ public interface TelephonyProperties
//****** Current Network
/** Alpha name of current registered operator.
* Availability: when registered to a network
/** Alpha name of current registered operator.<p>
* Availability: when registered to a network. Result may be unreliable on
* CDMA networks.
*/
static final String PROPERTY_OPERATOR_ALPHA = "gsm.operator.alpha";
//TODO: most of these proprieties are generic, substitute gsm. with phone. bug 1856959
/** Numeric name (MCC+MNC) of current registered operator.
* Availability: when registered to a network
/** Numeric name (MCC+MNC) of current registered operator.<p>
* Availability: when registered to a network. Result may be unreliable on
* CDMA networks.
*/
static final String PROPERTY_OPERATOR_NUMERIC = "gsm.operator.numeric";
@@ -64,8 +66,9 @@ public interface TelephonyProperties
static final String PROPERTY_OPERATOR_ISROAMING = "gsm.operator.isroaming";
/** The ISO country code equivalent of the current registered operator's
* MCC (Mobile Country Code)
* Availability: when registered to a network
* MCC (Mobile Country Code)<p>
* Availability: when registered to a network. Result may be unreliable on
* CDMA networks.
*/
static final String PROPERTY_OPERATOR_ISO_COUNTRY = "gsm.operator.iso-country";