net.rim.device.api.system
Class WLANInfo

java.lang.Object
  net.rim.device.api.system.WLANInfo

public class WLANInfo
extends Object

Contains Wireless Local Area Network (WLAN) radio information.

Since:

BlackBerry API 4.3.0

Nested Class Summary
static class	WLANInfo.WLANAPInfo Encapsulates information for a Wireless Local Area Network (WLAN) access point.

Field Summary
static int	WLAN_BAND_A Represents the 802.11a radio band.
static int	WLAN_BAND_B Represents the 802.11b radio band.
static int	WLAN_BAND_BG Represents the 802.11b/g radio band.
static int	WLAN_BAND_N Represents the 802.11n radio band.
static int	WLAN_STATE_CONNECTED Represents the WLAN "connected" radio state.
static int	WLAN_STATE_DISCONNECTED Represents the WLAN "disconnected" radio state.

Method Summary
static void	addListener(WLANListener listener) Adds the provided WLAN listener to the calling application.
static WLANInfo.WLANAPInfo	getAPInfo() Retrieves a WLANInfo.WLANAPInfo object containing information on the AP the WLAN radio is currently connected to, or null if the WLAN radio is not currently connected to an AP.
static String	getMACAddress() Retrieves the MAC address of the WLAN radio.
static int	getWLANState() Retrieves the current state of the WLAN radio.
static void	removeListener(WLANListener listener) Removes the provided WLAN listener from the calling application.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

WLAN_BAND_A

public static final int WLAN_BAND_A

Represents the 802.11a radio band.

See Also:

Constant Field Values

Since:

BlackBerry API 4.3.0

WLAN_BAND_B

public static final int WLAN_BAND_B

Represents the 802.11b radio band.

See Also:

Constant Field Values

Since:

BlackBerry API 4.3.0

WLAN_BAND_BG

public static final int WLAN_BAND_BG

Represents the 802.11b/g radio band.

See Also:

Constant Field Values

Since:

BlackBerry API 4.3.0

WLAN_BAND_N

public static final int WLAN_BAND_N

Represents the 802.11n radio band.

See Also:

Constant Field Values

Since:

BlackBerry API 6.0.0

WLAN_STATE_CONNECTED

public static final int WLAN_STATE_CONNECTED

Represents the WLAN "connected" radio state.

See Also:

Constant Field Values

Since:

BlackBerry API 4.3.0

WLAN_STATE_DISCONNECTED

public static final int WLAN_STATE_DISCONNECTED

Represents the WLAN "disconnected" radio state.

See Also:

Constant Field Values

Since:

BlackBerry API 4.3.0

Method Detail

addListener

public static void addListener(WLANListener listener)

Adds the provided WLAN listener to the calling application. Currently, only WLANConnectionListeners are supported.

Parameters:

listener - The WLAN listener to add to the calling application.

Throws:

NullPointerException - if listener is null.

Since:

BlackBerry API 4.3.0

removeListener

public static void removeListener(WLANListener listener)

Removes the provided WLAN listener from the calling application. Currently, only WLANConnectionListeners are supported.

Parameters:

listener - The WLAN listener to remove from the calling application.

Since:

BlackBerry API 4.3.0

getWLANState

public static int getWLANState()

Retrieves the current state of the WLAN radio.

Returns:

One of the WLAN_STATE_* constants.

Since:

BlackBerry API 4.3.0

getMACAddress

public static String getMACAddress()

Retrieves the MAC address of the WLAN radio.

Returns:

The WLAN Radio's MAC address as a string with bytes delimited by : and bytes less than 16 padded with leading zeros or null if WLAN radio is not supported.

Since:

BlackBerry API 7.1.0

getAPInfo

public static WLANInfo.WLANAPInfo getAPInfo()

Retrieves a WLANInfo.WLANAPInfo object containing information on the AP the WLAN radio is currently connected to, or null if the WLAN radio is not currently connected to an AP.

Returns:

A WLANInfo.WLANAPInfo object, or null if the WLAN radio is not currently connected to an AP.

Since:

BlackBerry API 4.3.0