GetGeoLocation

(Windows and macOS only) Will retrieve the geographical location for the device. Because this method is using CoreLocation API, user will need to grant access to location services for your application. On Windows, there is a known issue where the call may return the error WAAPI_ERROR_NO_DATA. If this occurs, retrying the invoke is recommended to resolve the problem.

Syntax

Method ID

#define WAAPI_MID_GET_GEOLOCATION 30011

JSON Input Structure

{
  "input": {
    "method": 30011,
    "timeout": number
  }
}

Input Properties

Parameter	Type	Description
`timeout`	number	(optional) Timeout to get location (ms). By default, timeout will be set at 5000 milliseconds.

JSON Output Structure

{
  "result": {
    "method": 30011,
    "code": number,
    "timing": number,
    "timestamp": string,
    "country": {
      "friendly_name": string,
      "iso2_code": string
    },
    "coordinates": {
      "latitude": string,
      "longitude": string
    }
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.country`	object	Information about the country where the device is located
`result.coordinates`	object	Coordinates related information.
`result.coordinates.latitude`	string	Latitude expressed in decimal degrees.
`result.coordinates.longitude`	string	Longitude expressed in decimal degrees.
`result.country.friendly_name`	string	The friendly name of the country
`result.country.iso2_code`	string	The country code (ISO2) of the country

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​