|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.rim.device.api.system.RadioInfo
public final class RadioInfo
Provides access to information about the status of the device radio.
Field Summary | ||
---|---|---|
static int |
BAND_CDMA_1900
Represents the 1900 MHz CDMA band. |
|
static int |
BAND_CDMA_800
Represents the 800 MHz CDMA band. |
|
static int |
BAND_DATATAC_800
Deprecated. DataTAC is no longer supported. |
|
static int |
BAND_GSM_1800
Represents the 1800 MHz GSM band. |
|
static int |
BAND_GSM_1900
Represents the 1900 MHz GSM band. |
|
static int |
BAND_GSM_850
Represents the 850 MHz GSM band. |
|
static int |
BAND_GSM_900
Represents the 900 MHz GSM band. |
|
static int |
BAND_IDEN_800
Represents the 800 MHz iDEN band. |
|
static int |
BAND_MOBITEX_900
Deprecated. Mobitex is no longer supported. |
|
static int |
BAND_UMTS_2100
Represents the 2100 MHz UMTS band. |
|
static int |
LEVEL_NO_COVERAGE
Radio has no coverage. |
|
static int |
NETWORK_802_11
802.11 network. |
|
static int |
NETWORK_CDMA
CDMA network. |
|
static int |
NETWORK_DATATAC
Deprecated. DataTAC is no longer supported. |
|
static int |
NETWORK_GPRS
GPRS network. |
|
static int |
NETWORK_IDEN
iDEN network. |
|
static int |
NETWORK_MOBITEX
Deprecated. Mobitex is no longer supported. |
|
static int |
NETWORK_NONE
No radio network supported. |
|
static int |
NETWORK_SERVICE_DATA
Network is providing data service. |
|
static int |
NETWORK_SERVICE_DIRECT_CONNECT
Network is providing direct connect service. |
|
static int |
NETWORK_SERVICE_E911_CALLBACK_MODE
Device is in E911 callback mode. |
|
static int |
NETWORK_SERVICE_EDGE
Device is in EDGE coverage. |
|
static int |
NETWORK_SERVICE_EMERGENCY_ONLY
Network is providing emergency service only. |
|
static int |
NETWORK_SERVICE_EVDO
Deprecated. NETWORK_SERVICE_EVDO is no longer supported. NETWORK_SERVICE_EVDO is replaced by NETWORK_SERVICE_EVDO_REV0. |
|
static int |
NETWORK_SERVICE_EVDO_ONLY
Deprecated. NETWORK_SERVICE_EVDO_ONLY is no longer supported. NETWORK_SERVICE_EVDO_ONLY is replaced by NETWORK_SERVICE_EVDO_REV0_ONLY. |
|
static int |
NETWORK_SERVICE_EVDO_REV0
Device is in EV-DO coverage with 1X. |
|
static int |
NETWORK_SERVICE_EVDO_REV0_ONLY
Device is in EV-DO coverage only, No 1X |
|
static int |
NETWORK_SERVICE_EVDO_REVA
Device is in EV-DO coverage with 1X. |
|
static int |
NETWORK_SERVICE_EVDO_REVA_ONLY
Device is in EV-DO coverage only, No 1X |
|
static int |
NETWORK_SERVICE_GAN
Device is in GAN mode. |
|
static int |
NETWORK_SERVICE_IN_CITY_ZONE
Device is in the 'city' zone. |
|
static int |
NETWORK_SERVICE_IN_HOME_ZONE
Device is in the 'home' zone. |
|
static int |
NETWORK_SERVICE_MODEM_MODE_ENABLED
Device is in modem (only) mode. |
|
static int |
NETWORK_SERVICE_ROAMING
Device is roaming. |
|
static int |
NETWORK_SERVICE_ROAMING_OFF_CAMPUS
Device is roaming onto another network campus. |
|
static int |
NETWORK_SERVICE_SDGC
Network is providing SDGC service. |
|
static int |
NETWORK_SERVICE_SUPPRESS_ROAMING
The roaming indicator should be suppressed. |
|
static int |
NETWORK_SERVICE_UMTS
Device is in UMTS coverage. |
|
static int |
NETWORK_SERVICE_VOICE
Network is providing voice service. |
|
static int |
NETWORK_UMTS
UMTS network. |
|
static int |
STATE_LOWBATT
Radio is on but cannot function because of low battery. |
|
static int |
STATE_OFF
Radio is off. |
|
static int |
STATE_ON
Radio is on. |
|
static int |
STATE_RELOAD_REQUIRED
Deprecated. no longer used |
|
static int |
STATE_SERVICE_REQUIRED
Deprecated. no longer used |
|
static int |
STATE_TURNING_OFF
Deprecated. no longer used |
|
static int |
STATE_TURNING_ON
Deprecated. no longer used |
|
static int |
SUPPORTED_WAFS
The Wireless Access Families that are supported by the device. |
|
static int |
WAF_3GPP
3GPP Wireless Access Family. |
|
static int |
WAF_CDMA
CDMA Wireless Access Family. |
|
static int |
WAF_IDEN
iDEN Wireless Access Family. |
|
static int |
WAF_WLAN
WLAN Wireless Access Family. |
Method Summary | ||
---|---|---|
static boolean |
areWAFsSupported(int WAFs)
Determines if any of the provided Wireless Access Families are supported by the device. |
|
static int |
calculateNetworkId(int mcc,
int mnc)
Calculate the Cellular network ID value given the MCC and MNC in decimal value representation. |
|
static String |
getAccessPointName(int apnId)
Gets the access point name from the given identifier. |
|
static int |
getAccessPointNumber(String name)
Retrieves the access point number for the specified name. |
|
static int |
getAccessPointNumber(String data,
int offset,
int length)
Retrieves the access point number for the specified name. |
|
static int |
getActiveWAFs()
Retrieves the currently active Wireless Access Families. |
|
static int |
getCurrentNetworkIndex()
Retrieves the index of the current Cellular network. |
|
static String |
getCurrentNetworkName()
Retrieve the name of the carrier network on which the device is currently registered. |
|
static int |
getEnabledWAFs()
Retrieves the currently enabled Wireless Access Families. |
|
static byte[] |
getIPAddress(int apnId)
Retrieves the IP address for the specified access point name identifier. |
|
static int |
getMCC(int index)
Retrieves Mobile Country Code for the given Cellular network. |
|
static int |
getMNC(int index)
Retrieves Mobile Network Code for the specified Cellular network. |
|
static String |
getNetworkCountryCode(int index)
Retrieves the country code (i.e. country initials) of the specified Cellular network. |
|
static int |
getNetworkId(int index)
Retrieves the Id of the specified Cellular network. |
|
static String |
getNetworkName(int index)
Retrieves the name of the specified Cellular network. |
|
static int |
getNetworkService()
Retrieves currently available network services on the Cellular network. |
|
static int |
getNetworkService(int waf)
Retrieves currently available network services. |
|
static long |
getNetworkTime(long deviceTime)
Determine the current network time, as calculated using an offset from the current device time. |
|
static int |
getNetworkType()
Retrieves the network that the device is capable of operating on. |
|
static int |
getNumberOfNetworks()
Retrieves the number of available Cellular networks. |
|
static long |
getNumberOfPacketsReceived()
Retrieves the number of IP bytes received by the radio. |
|
static long |
getNumberOfPacketsSent()
Retrieves the number of IP bytes sent by the radio. |
|
static int |
getSignalLevel()
Retrieves current signal strength of the Cellular network. |
|
static int |
getSignalLevel(int WAF)
Retrieves current signal level for the specified Wireless Access Family. |
|
static int |
getState()
Checks the radio state. |
|
static int |
getSupportedBands()
Retrieves the Cellular network bands which are supported by the device. |
|
static int |
getSupportedWAFs()
Retrieves the Wireless Access Families (WAFs) that are supported by the device. |
|
static boolean |
isDataServiceOperational()
Indicates whether the radio can perform data services over Cellular network at this time. |
|
static boolean |
isDataServiceOperational(int wafs)
Indicates whether the radio can perform data services at this time over any of the given WAFs such as WAF_3GPP et al. |
|
static boolean |
isDataServiceSuspended()
Indicates whether data services are temporarily suspended at the present time. |
|
static boolean |
isPDPContextActive(int apnId)
Indicates if the PDP context for the specified APN is active. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int WAF_3GPP
public static final int WAF_CDMA
public static final int WAF_IDEN
public static final int WAF_WLAN
public static final int NETWORK_NONE
public static final int NETWORK_MOBITEX
public static final int NETWORK_DATATAC
public static final int NETWORK_GPRS
public static final int NETWORK_CDMA
public static final int NETWORK_IDEN
public static final int NETWORK_802_11
public static final int NETWORK_UMTS
public static final int STATE_OFF
public static final int STATE_ON
public static final int STATE_LOWBATT
public static final int STATE_SERVICE_REQUIRED
public static final int STATE_TURNING_OFF
public static final int STATE_TURNING_ON
public static final int STATE_RELOAD_REQUIRED
public static final int LEVEL_NO_COVERAGE
public static final int NETWORK_SERVICE_EMERGENCY_ONLY
public static final int NETWORK_SERVICE_VOICE
public static final int NETWORK_SERVICE_DATA
public static final int NETWORK_SERVICE_DIRECT_CONNECT
public static final int NETWORK_SERVICE_ROAMING
public static final int NETWORK_SERVICE_SUPPRESS_ROAMING
public static final int NETWORK_SERVICE_ROAMING_OFF_CAMPUS
public static final int NETWORK_SERVICE_IN_HOME_ZONE
public static final int NETWORK_SERVICE_IN_CITY_ZONE
public static final int NETWORK_SERVICE_E911_CALLBACK_MODE
public static final int NETWORK_SERVICE_EVDO
public static final int NETWORK_SERVICE_EVDO_REV0
public static final int NETWORK_SERVICE_EVDO_REVA
public static final int NETWORK_SERVICE_EVDO_ONLY
public static final int NETWORK_SERVICE_EVDO_REV0_ONLY
public static final int NETWORK_SERVICE_EVDO_REVA_ONLY
public static final int NETWORK_SERVICE_EDGE
public static final int NETWORK_SERVICE_MODEM_MODE_ENABLED
public static final int NETWORK_SERVICE_UMTS
public static final int NETWORK_SERVICE_GAN
public static final int NETWORK_SERVICE_SDGC
public static final int BAND_MOBITEX_900
public static final int BAND_DATATAC_800
public static final int BAND_GSM_900
public static final int BAND_GSM_1800
public static final int BAND_GSM_1900
public static final int BAND_CDMA_800
public static final int BAND_CDMA_1900
public static final int BAND_IDEN_800
public static final int BAND_GSM_850
public static final int BAND_UMTS_2100
public static final int SUPPORTED_WAFS
Method Detail |
---|
public static int getSupportedWAFs()
WAF_*
flags indicating the Wireless
Access Families supported by the device.public static boolean areWAFsSupported(int WAFs)
WAFs
- A bitfield of WAF_*
flags indicating the Wireless Access Families
to check for support.
public static int getActiveWAFs()
WAF_*
flags indicating the currently
active Wireless Access Families.public static int getEnabledWAFs()
Enabled WAFs are those permitted to be active on multiple WAF devices where not all WAFs are active at the same time.
E.g. Global mode enables CDMA and GSM but only one of these WAFs may be active depending on availability of network.
WAF_*
flags indicating the currently
enabled Wireless Access Families.public static int getNetworkType()
This method can be useful if the device only supports one network. If the device supports multiple Wireless Access Families,
use the Wireless Access Families methods instead.
For example, use getActiveWAFs()
to determine the network that is currently being used and
use getSupportedWAFs()
to determine the Wireless Access Families supported by the device.
RadioInfo.NETWORK_CDMA
if the device is capable of CDMA
RadioInfo.NETWORK_IDEN
if the device is capable of iDEN
RadioInfo.NETWORK_UMTS
if the device is none of the above and supports 3G
RadioInfo.NETWORK_GPRS
if the device is none of the above and supports 2G
RadioInfo.NETWORK_802_11
if the device is none of the above and supports WLAN
public static int getState()
Note: This checks the cellular WAFs except when WLAN is the primary WAF.
RadioInfo.STATE_ON
if the radio is on.
RadioInfo.STATE_OFF
if the radio is off or being turned off.
RadioInfo.STATE_LOWBATT
if the radio is on but the battery is too low
to allow its use.
RadioInfo.getActiveWAFs()
,
DeviceInfo.getBatteryStatus()
public static int getSignalLevel()
RadioInfo.LEVEL_NO_COVERAGE
if the radio is out of coverage.public static int getSignalLevel(int WAF)
WAF
is not one of the WAF_*
constants, then RadioInfo.WAF_3GPP
is assumed.
WAF
- The Wireless Access Family whose signal level is to be retrieved. Must be one
of the WAF_*
constants, otherwise WAF_3GPP
is assumed.
RadioInfo.LEVEL_NO_COVERAGE
if the radio is out of coverage.public static int getNetworkService()
NETWORK_SERVICE_*
flags.public static int getNetworkService(int waf)
the
- active RadioInfo.WAF_*(s) that you would like to query.
NETWORK_SERVICE_*
flags.public static int getSupportedBands()
public static long getNumberOfPacketsSent()
public static long getNumberOfPacketsReceived()
public static int getNumberOfNetworks()
public static int getCurrentNetworkIndex()
RadioInfo.getNumberOfNetworks()
- 1.public static int getNetworkId(int index)
index
- The network index, from 0 to getNumberOfNetworks() - 1.
IllegalArgumentException
- if index is less than zero or is greater than the number
of existing networks: (RadioInfo.getNumberOfNetworks() - 1).public static String getNetworkName(int index)
index
- The network index, from 0 to getNumberOfNetworks() - 1.
IllegalArgumentException
- if the index
is not within a valid range based on getNumberOfNetworks()public static String getNetworkCountryCode(int index)
index
- The network index, from 0 to getNumberOfNetworks() - 1.
IllegalArgumentException
- if the index
parameter is out of bounds.public static int calculateNetworkId(int mcc, int mnc)
If the provided values are out of range, such as negative numbers or greater than 0xFFF, then the returned value is undefined.
For example, after the code below executes the variable hexNetworkId will have value 0x02600310.
int mcc = 310 int mnc = 260 int hexNetworkId = RadioInfo.calculateNetworkId(mcc, mnc);
mcc
- Decimal value of MCCmnc
- Decimal value of MNC
public static int getMNC(int index)
index
- The network index, from 0 to RadioInfo.getNumberOfNetworks()
- 1.
IllegalArgumentException
- if the index is out of boundspublic static int getMCC(int index)
index
- The network index, from 0 to RadioInfo.getNumberOfNetworks()
- 1.
IllegalArgumentException
- if the index is out of boundspublic static boolean isPDPContextActive(int apnId)
apnId
- The access point name identifier.
true
if the PDP context for the specified APN is active.public static String getAccessPointName(int apnId) throws RadioException
apnId
- The access point name identifier.
RadioException
- If a radio error occurs or if the provided value for
apnId
is invalid.public static int getAccessPointNumber(String name) throws RadioException
name
- The access point name.
RadioException
- If a radio error occurs.public static int getAccessPointNumber(String data, int offset, int length) throws RadioException
data
- The String containing the access point name.offset
- The start offset of the access point name.length
- The length of the access point name.
RadioException
- If a radio error occurs or if invalid parameters passed.public static byte[] getIPAddress(int apnId)
apnId
- The access point name identifier.
public static long getNetworkTime(long deviceTime)
deviceTime
- current time in milliseconds
public static boolean isDataServiceOperational()
public static boolean isDataServiceOperational(int wafs)
WAF_3GPP
et al.
public static boolean isDataServiceSuspended()
public static String getCurrentNetworkName()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal