net.rim.device.api.wlan.hotspot
Class AuthenticationStatusEvent

java.lang.Object
  extended by net.rim.device.api.wlan.hotspot.AuthenticationStatusEvent

public final class AuthenticationStatusEvent
extends Object

An event object used to update HotspotStatusListener through HotspotAuthenticationAgent during any hotspot process.

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

Constructor Summary
Category: Signed AuthenticationStatusEvent(int status)
          Creates an authentication status event to update hotspot status listeners.
Category: Signed AuthenticationStatusEvent(int status, int applicationCode, String message)
          Creates an authentication status event to update hotspot status listeners.
 
Method Summary
Category: Signed  int getApplicationCode()
          Retrieves this authentication status event's application code.
Category: Signed  String getMessage()
          Retrieves this authentication status event's message to the user.
Category: Signed  int getStatus()
          Retrieves this authentication status event's status.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

AuthenticationStatusEvent

public AuthenticationStatusEvent(int status)
Creates an authentication status event to update hotspot status listeners. Authentication status events created using this constructor have their application code set to 0 and their message for to the user set to null.

Parameters:
status - one of the STATUS_ constants from HotspotStatusListener.
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

AuthenticationStatusEvent

public AuthenticationStatusEvent(int status,
                                 int applicationCode,
                                 String message)
Creates an authentication status event to update hotspot status listeners. Authentication events created with this constructor can be given an application-specific code and a text message to display to the user.

Parameters:
status - one of the STATUS_ constants from HotspotStatusListener.
applicationCode - application-specific code.
message - text message for the user.
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

getStatus

public int getStatus()
Retrieves this authentication status event's status.

Returns:
status the STATUS_ constant from HotspotStatusListener.
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

getApplicationCode

public int getApplicationCode()
Retrieves this authentication status event's application code.

Returns:
application code set in the constructor.
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

getMessage

public String getMessage()
Retrieves this authentication status event's message to the user.

Returns:
message set in the constructor.
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.