|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gsm.oneapi.location.Locate
public class Locate
Field Summary | |
---|---|
static boolean |
dumpRequestAndResponse
|
Constructor Summary | |
---|---|
Locate(ServiceEndpoints endPoints,
java.lang.String authorisationHeader)
Creates a new instance of the Location API main interface. |
Method Summary | |
---|---|
LocationResponse |
locateMultipleTerminals(java.lang.String[] endUserId,
int requestedAccuracy)
Locate multiple specified mobile terminals to the specified level of accuracy |
LocationResponse |
locateTerminal(java.lang.String endUserId,
int requestedAccuracy)
Locate a single specified mobile terminal to the specified level of accuracy |
static void |
main(java.lang.String[] args)
|
void |
setAuthorisationHeader(java.lang.String authorisationHeader)
Can be used to update the service authorisation header |
void |
setEndpoints(ServiceEndpoints endPoints)
Can be used to update the service endpoints |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static boolean dumpRequestAndResponse
Constructor Detail |
---|
public Locate(ServiceEndpoints endPoints, java.lang.String authorisationHeader)
endPoints
- contains a set of service/ call specific endpointsauthorisationHeader
- Base 64 encoded username/ passwordServiceEndpoints
,
JSONRequest.getAuthorisationHeader(String, String)
Method Detail |
---|
public void setEndpoints(ServiceEndpoints endPoints)
endPoints
- contains a set of service/ call specific endpointsServiceEndpoints
public void setAuthorisationHeader(java.lang.String authorisationHeader)
authorisationHeader
- Base 64 encoded username/ passwordJSONRequest.getAuthorisationHeader(String, String)
public LocationResponse locateTerminal(java.lang.String endUserId, int requestedAccuracy)
endUserId
- The MSISDN or Anonymous Customer Reference of the mobile device to locate. The protocol and Ô+Õ identifier must be used for MSISDN. Do not URL escape prior to passing to the locateTerminal function as this will be done by the APIrequestedAccuracy
- The preferred accuracy of the result, in metres. Typically, when you request an accurate location it will take longer to retrieve than a coarse location. So requestedAccuracy=10 will take longer than requestedAccuracy=100LocationResponse
public LocationResponse locateMultipleTerminals(java.lang.String[] endUserId, int requestedAccuracy)
endUserId
- The MSISDN or Anonymous Customer Reference of the mobile device to locate. The protocol and Ô+Õ identifier must be used for MSISDN. Do not URL escape prior to passing to the locateMultipleTerminals function as this will be done by the API. Note that if any element of the address array is null it will not be sent to the OneAPI server.requestedAccuracy
- The preferred accuracy of the result, in metres. Typically, when you request an accurate location it will take longer to retrieve than a coarse location. So requestedAccuracy=10 will take longer than requestedAccuracy=100LocationResponse
public static void main(java.lang.String[] args)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |