net.rim.device.api.gps
Class GPSSettings

java.lang.Object
  extended by net.rim.device.api.gps.GPSSettings

public class GPSSettings
extends Object

Provides access to the device's Global Positioning System receiver (if equipped).

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 4.2.0

Field Summary
Category: Signed static int AUTH_LIFETIME_ERROR
          Internal error when retrieving the Authentication Life Time value
Category: Signed static int AUTH_LIFETIME_UNSET
          Authentication Life Time value has not been set by the network
 
Method Summary
Category: Signed static int getAuthLifeTime()
          Returns the authentication life time value received from the network This method should only be called after the setPDEInfo(String ip, int port, int authLifeTime ) method.
Category: Signed static boolean isPDEInfoRequired(int mode)
          Allows an application to determine whether it is required to set the PDE information in order to get assisted GPS position.
Category: Signed static boolean setPDEInfo(String ip, int port)
          Set the given PDE IP and port for the device.
Category: Signed static boolean setPDEInfo(String ip, int port, int authLifeTime)
          Set the given PDE IP, port and authentication life time for the device.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Field Detail

AUTH_LIFETIME_ERROR

public static final int AUTH_LIFETIME_ERROR

Internal error when retrieving the Authentication Life Time value

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 4.7.0

AUTH_LIFETIME_UNSET

public static final int AUTH_LIFETIME_UNSET

Authentication Life Time value has not been set by the network

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 4.7.0


Method Detail

isPDEInfoRequired

public static boolean isPDEInfoRequired(int mode)
Allows an application to determine whether it is required to set the PDE information in order to get assisted GPS position.

Parameters:
mode - - GPS mode requested
Returns:
true if the application needs to set the PDE, false otherwise.
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

setPDEInfo

public static boolean setPDEInfo(String ip,
                                 int port)
                          throws IllegalArgumentException
Set the given PDE IP and port for the device. Some carriers require the third party appilications to call this method with correct ip and port values before they can use the Location API. Third party application developers are expected to contact the carrier to obtain the PDE IP and port values.

Parameters:
ip - address to be set for PDE
port - to be set for the PDE
Returns:
true if the ip and port values are valid, false otherwise.
Throws:
UnsupportedOperationException - if a non-CDMA device tries to invoke this method. This exception is also thrown if the application is not allowed to use internal GPS.

IllegalArgumentException - If the ip address string is not in correct format
NullPointerException - If ip is null
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 4.2.0

setPDEInfo

public static boolean setPDEInfo(String ip,
                                 int port,
                                 int authLifeTime)
                          throws IllegalArgumentException
Set the given PDE IP, port and authentication life time for the device. Some carriers require the third party applications to call this method with correct ip, port and authentication life time values before they can use the Location API. Third party application developers are expected to contact the carrier to obtain the PDE IP and port values.

Parameters:
ip - address to set for PDE
port - to set for the PDE
authLifeTime - to set authentication life time (in seconds) for the PDE.
Returns:
true if the ip, port and authentication life time values are valid, false otherwise.
Throws:
UnsupportedOperationException - if a non-CDMA device tries to invoke this method. This exception is also thrown if the application is not allowed to use internal GPS.

IllegalArgumentException - If the ip address string is not in correct format
NullPointerException - If ip is null
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 4.7.0

getAuthLifeTime

public static int getAuthLifeTime()
                           throws UnsupportedOperationException
Returns the authentication life time value received from the network This method should only be called after the setPDEInfo(String ip, int port, int authLifeTime ) method.

Returns:
AUTH_LIFETIME_ERROR if this process has not invoked the setPDEInfo(String ip, int port, int authLifeTime ) method.

AUTH_LIFETIME_UNSET if the authentication life time value has not been set by the network yet.

Integer value representing the authentication life time value set by the network in seconds.

Throws:
UnsupportedOperationException - if a non-CDMA device tries to invoke this method or a a CDMA device invokes it on an unsupported carrier.
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 4.7.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.