net.rim.device.api.wlan.hotspot
Interface HotspotStatusListener


public interface HotspotStatusListener

A listener interface for hotspot authentication status events. Implementations of this listener can register with HotspotAuthenticationAgent to recieve status updates.

Once a client has been successfully associated with a network, the system will add a a listener of this type to client's authentication agent. The listener implementation is updated when the authentication agent calls HotspotAuthenticationAgent.notifyListeners (client is expected to update status using this method).

For more information, please refer to API overview section provided in HotspotClientRegistry.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

Field Summary
Category: Signed static int STATUS_ERROR_APPLICATION_SPECIFIC
          Application error specific.
Category: Signed static int STATUS_ERROR_AUTHENTICATION_SERVER
          An error occurred in the authentication server.
Category: Signed static int STATUS_ERROR_GATEWAY_ERROR
          An error occurred while trying to reach gateway or gateway timed out.
Category: Signed static int STATUS_ERROR_INVALID_CREDENTIALS
          Invalid user credentials error.
Category: Signed static int STATUS_PROBE_CANCELLED
          Probing network was successfully cancelled (using cancelProbeNetwork).
Category: Signed static int STATUS_PROBE_FAILED
          Probing network failed (client does not support network).
Category: Signed static int STATUS_PROBE_SUCCEED
          Probing network was successful (client supports the network).
Category: Signed static int STATUS_SUCCESS_CANCEL
          Cancellation was successful.
Category: Signed static int STATUS_SUCCESS_LOGGED_IN
          Login was successful.
Category: Signed static int STATUS_SUCCESS_LOGGED_OUT
          Logout was successful.
 
Method Summary
Category: Signed  void updateStatus(AuthenticationStatusEvent event)
          This method is used to update the listener during any hotspot process.
 



Field Detail

STATUS_ERROR_APPLICATION_SPECIFIC

static final int STATUS_ERROR_APPLICATION_SPECIFIC
Application error specific. If the client application has its own error status update then it can use this status flag and then pass its own error status as the second and/or third parameter in the updateStatus method.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

STATUS_ERROR_AUTHENTICATION_SERVER

static final int STATUS_ERROR_AUTHENTICATION_SERVER
An error occurred in the authentication server.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

STATUS_ERROR_GATEWAY_ERROR

static final int STATUS_ERROR_GATEWAY_ERROR
An error occurred while trying to reach gateway or gateway timed out.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

STATUS_ERROR_INVALID_CREDENTIALS

static final int STATUS_ERROR_INVALID_CREDENTIALS
Invalid user credentials error.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

STATUS_PROBE_FAILED

static final int STATUS_PROBE_FAILED
Probing network failed (client does not support network).

This status constant is not supported in the Hotspot API version 1.0. Use HotspotClientRegistry.isFeatureSupported(byte) to check if probing feature is supported.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

STATUS_SUCCESS_LOGGED_IN

static final int STATUS_SUCCESS_LOGGED_IN
Login was successful.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

STATUS_SUCCESS_LOGGED_OUT

static final int STATUS_SUCCESS_LOGGED_OUT
Logout was successful.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

STATUS_SUCCESS_CANCEL

static final int STATUS_SUCCESS_CANCEL
Cancellation was successful.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

STATUS_PROBE_SUCCEED

static final int STATUS_PROBE_SUCCEED
Probing network was successful (client supports the network).

This status constant is not supported in the Hotspot API version 1.0. Tip: Use HotspotClientRegistry.isFeatureSupported(byte) to check if probing feature is supported.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

STATUS_PROBE_CANCELLED

static final int STATUS_PROBE_CANCELLED
Probing network was successfully cancelled (using cancelProbeNetwork).

This status constant is not supported in the Hotspot API version 1.0. Use HotspotClientRegistry.isFeatureSupported(byte) to check if probing feature is supported.

See Also:
Constant Field Values
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0


Method Detail

updateStatus

void updateStatus(AuthenticationStatusEvent event)
This method is used to update the listener during any hotspot process.

Parameters:
event - update with this new AuthenticationStatusEvent.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0





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.