|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.rim.device.api.gps.GPSSettings
public class GPSSettings
Provides access to the device's Global Positioning System receiver (if equipped).
| Field Summary | ||
|---|---|---|
|
static int |
AUTH_LIFETIME_ERROR
Internal error when retrieving the Authentication Life Time value |
|
static int |
AUTH_LIFETIME_UNSET
Authentication Life Time value has not been set by the network |
| Method Summary | ||
|---|---|---|
|
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. |
|
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. |
|
static boolean |
setPDEInfo(String ip,
int port)
Set the given PDE IP and port for the device. |
|
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 |
|---|
public static final int AUTH_LIFETIME_ERROR
Internal error when retrieving the Authentication Life Time value
public static final int AUTH_LIFETIME_UNSET
Authentication Life Time value has not been set by the network
| Method Detail |
|---|
public static boolean isPDEInfoRequired(int mode)
mode - - GPS mode requested
public static boolean setPDEInfo(String ip,
int port)
throws IllegalArgumentException
ip - address to be set for PDEport - to be set for the PDE
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
public static boolean setPDEInfo(String ip,
int port,
int authLifeTime)
throws IllegalArgumentException
ip - address to set for PDEport - to set for the PDEauthLifeTime - to set authentication life time (in seconds) for the PDE.
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
public static int getAuthLifeTime()
throws UnsupportedOperationException
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.
UnsupportedOperationException - if a non-CDMA device tries to invoke this method or a
a CDMA device invokes it on an unsupported carrier.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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.