net.rim.device.api.system
Class CDMAInfo

java.lang.Object
  extended by net.rim.device.api.system.CDMAInfo

public final class CDMAInfo
extends Object

Contains CDMA (Code Division Multiple Access) radio information.

See Also:
CDMAInfo.CDMACellInfo
Since:
BlackBerry API 3.6.0

Nested Class Summary
static class CDMAInfo.CDMACellInfo
          Contains CDMA (Code Division Multiple Access) cell information.
 
Field Summary
static int CAPABILITY_GPS
          Indicates if the BlackBerry device radio is GPS enabled.
static int CAPABILITY_MIP
          Indicates if the BlackBerry device radio is MIP enabled.
static int CAPABILITY_SIP
          Indicates if the BlackBerry device radio is SIP enabled.
static int CAPABILITY_SMS
          Indicates if the BlackBerry device radio is SMS enabled.
static int CAPABILITY_VOICE
          Indicates if the BlackBerry device radio is voice enabled.
 
Method Summary
static int getBandClass()
          Returns the band class.
static int getCapabilities()
          Returns the radio capabilities.
static CDMAInfo.CDMACellInfo getCellInfo()
          Returns information on the current cell.
static int getChannelNumber()
          Returns the channel number of the acquired system.
static int getCurrentSID()
          Returns the current SID.
static String getDecimalMEID()
          If the device software supports MEID, return the decimal MEID.
static int getESN()
          Returns the electronic serial number (ESN) of the device.
static int getFirmwareVersion()
          Returns the firmware version reported OTA.
static int getHardwareVersion()
          Returns the hardware version reported OTA.
static String getHexMEID()
          If the device software supports MEID, return the hex MEID.
static int getHomeSID()
          Returns the home SID.
static short[] getHomeSystemNIDs()
          Returns the home system NIDs.
static short[] getHomeSystemSIDs()
          Returns the home system SIDs.
static byte[] getIMSI()
          Returns the International Mobile Station Identity (IMSI) Definition.
static int getModelNumber()
          Returns the mobile model number reported OTA.
static String getNAI(int profileIndex)
          Retrieves CDMA Network Address Identifier (NAI) for given Mobile IP profile.
static int getNVVersion()
          Returns the NV data version.
static int getPRLVersion()
          Returns the preferred roaming list version.
static String getRegistrationAddress()
          Deprecated. This function always returns null.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

CAPABILITY_VOICE

public static final int CAPABILITY_VOICE
Indicates if the BlackBerry device radio is voice enabled.

See Also:
Constant Field Values
Since:
BlackBerry API 3.6.0

CAPABILITY_SMS

public static final int CAPABILITY_SMS
Indicates if the BlackBerry device radio is SMS enabled.

See Also:
Constant Field Values
Since:
BlackBerry API 3.6.0

CAPABILITY_SIP

public static final int CAPABILITY_SIP
Indicates if the BlackBerry device radio is SIP enabled.

See Also:
Constant Field Values
Since:
BlackBerry API 3.6.0

CAPABILITY_MIP

public static final int CAPABILITY_MIP
Indicates if the BlackBerry device radio is MIP enabled.

See Also:
Constant Field Values
Since:
BlackBerry API 3.6.0

CAPABILITY_GPS

public static final int CAPABILITY_GPS
Indicates if the BlackBerry device radio is GPS enabled.

See Also:
Constant Field Values
Since:
BlackBerry API 3.6.0


Method Detail

getESN

public static int getESN()
Returns the electronic serial number (ESN) of the device.

Every CDMA device must have a unique ESN.

Returns:
An integer representing the ESN.
Since:
BlackBerry API 3.6.0

getDecimalMEID

public static String getDecimalMEID()
If the device software supports MEID, return the decimal MEID.

Returns:
a string representing the decimal MEID; returns null if the device software does not support MEID.
Since:
BlackBerry API 5.0.0

getHexMEID

public static String getHexMEID()
If the device software supports MEID, return the hex MEID.

Returns:
a string representing the hex MEID; returns null if the device software does not support MEID.
Since:
BlackBerry API 5.0.0

getRegistrationAddress

public static String getRegistrationAddress()
Deprecated. This function always returns null.

Returns the registration address.

Returns:
The registration address.
Since:
BlackBerry API 3.6.0

getIMSI

public static byte[] getIMSI()
Returns the International Mobile Station Identity (IMSI) Definition.

The IMSI uniquely identifies personal mobile stations.

Returns:
A byte array containing the IMSI.
Since:
BlackBerry API 3.6.0

getHardwareVersion

public static int getHardwareVersion()
Returns the hardware version reported OTA.

Returns:
The hardware version reported OTA
Since:
BlackBerry API 3.6.0

getFirmwareVersion

public static int getFirmwareVersion()
Returns the firmware version reported OTA.

Returns:
The firmware version reported OTA
Since:
BlackBerry API 3.6.0

getPRLVersion

public static int getPRLVersion()
Returns the preferred roaming list version.

Returns:
The preferred roaming list version
Since:
BlackBerry API 3.6.0

getCurrentSID

public static int getCurrentSID()
Returns the current SID.

Returns:
The current SID
Since:
BlackBerry API 3.6.0

getHomeSID

public static int getHomeSID()
Returns the home SID.

Returns:
The home SID
Since:
BlackBerry API 3.6.0

getCapabilities

public static int getCapabilities()
Returns the radio capabilities.

Returns:
The radio capabilities
Since:
BlackBerry API 3.6.0

getChannelNumber

public static int getChannelNumber()
Returns the channel number of the acquired system.

Returns:
The channel number of the acquired system
Since:
BlackBerry API 3.6.0

getBandClass

public static int getBandClass()
Returns the band class.

Returns:
The band class
Since:
BlackBerry API 3.6.0

getModelNumber

public static int getModelNumber()
Returns the mobile model number reported OTA.

Returns:
The mobile model number reported OTA
Since:
BlackBerry API 3.6.0

getNVVersion

public static int getNVVersion()
Returns the NV data version. Major version is in bits 8-15, minor version is in bits 0-7.

Returns:
The NV data version
Since:
BlackBerry API 3.6.0

getHomeSystemSIDs

public static short[] getHomeSystemSIDs()
Returns the home system SIDs.

Returns:
The home system SIDs
Since:
BlackBerry API 3.6.0

getHomeSystemNIDs

public static short[] getHomeSystemNIDs()
Returns the home system NIDs.

Returns:
The home system NIDs
Since:
BlackBerry API 3.6.0

getCellInfo

public static CDMAInfo.CDMACellInfo getCellInfo()
Returns information on the current cell.

Returns:
The cell information.
Since:
BlackBerry API 3.6.0

getNAI

public static String getNAI(int profileIndex)
Retrieves CDMA Network Address Identifier (NAI) for given Mobile IP profile.

Parameters:
profileIndex - MIP profile index. MIP profile index value is zero for most of the carriers but it may be different for certain carriers.
Returns:
The NAI, or null if an error occurred.
Since:
BlackBerry API 4.2.1





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.