Recents

Native Mobile Applications Development

Page Id

Introduction
Look & Feel
User Experience
Security
Monetizing
- In-App Purchase
  - What is In-App purchase?
  - Setting In-App purchase
    - For Android
  - Making purchases from the application
  - Coding examples
    - In-App Purchase Sample - Classified Ads
    - In-App Purchase Sample - My Kitchen
- Ads
  - What are Ads?
  - Ads (Advertising)
Notifications
- What are Notifications?
- Push Notifications
  - Registering
    - For Android
    - For iOS
  - HowTo: Push Notifications using an External Provider
  - Settings
  - Sending push notifications
    - By using external provider
- Local Notifications
- Proximity Alerts Notifications
Geolocation
- Geolocation control
- Geolocation external object
- Maps external object
  - Methods
    - General
    - Location
Timezone
- What the TimeZone problem is?
- TimeZone Support
Cache Management
- What is Caching?
- Native Mobile caching
- Enable Data Caching property
- Check For New Data property
- Smart Devices Cache Management property
Extensibility
Troubleshooting
- Behavior differences between Native Mobile platforms
- Smart Devices Troubleshooting tools
Online resources

Geolocation external object

This documentation is valid for:

Warning: The Maps external object is newer than the Geolocation external object. Many of the methods and properties provided by both external objects are similar. The difference consists in the fact that the Maps external object uses the Geography data type while the Geolocation external object uses the Geolocation domain (which is deprecated). In addition, the Maps external object includes more functionalities. The use of the Maps external object and the Geography data type is highly recommended.

This API enables you to provide several Location Services on their Native Mobile Applications by interacting with the GPS on the device where the app is running.

The scenarios that this API resolves are described in the Geolocation API - Scenarios article. To enable the use of this API many methods, such as GetMyLocation, GetLatitude, GetAddress, etc have been defined and also a new Structure Data Type has been defined, the GeoLocationInfo.

Properties

AuthorizationStatus

Returns the current authorization status. This can be useful when you are using an API that requires a higher authorization level than the one the user gave. You can warn the user and ask him to go to the settings and add the necessary permission if he currently has a minor permission (WhenInUse or Denied). This property is based on APIAuthorizationStatus domain. Note: This value is not available for Android apps.

Methods

Note: Those methods marked with an asterisk (*) only work on the device (not simulator nor web environment).

GetMyLocation method *

Returns the current location of the device.

Return value	GeolocationInfo
Parameters	minAccuracy:Numeric(8.0), timeout:Numeric(8.0), IncludeHeadingAndSpeed:Boolean [, ignoreErrors:Boolean ]

Authorized method *

Indicates whether the application has been given permission to use location services.

Return value	Boolean
Parameters	None

ServiceEnabled method *

Indicates whether location services are enabled in the device.

Return value	Boolean
Parameters	None

StartTracking method *

Starts generating tracking information. Check Tracking article.

Return value	None
Parameters	changeInterval:Numeric(8.0), distance:Numeric(8.0), action:Character(20), actionTimeInterval:Numeric(8.0) [, accuracy:Numeric(8.0) ]

EndTracking method *

Stops the generation of tracking information. Check Tracking article.

Return value	None
Parameters	None

GetLocationHistory method

Returns a collection of location information generated by the tracking methods. Check Tracking article.

Return value	GeolocationInfo
Parameters	startTime:DateTime

ClearLocationHistory method

Removes all previous location information generated by the tracking methods. Check Tracking article.

Return value	None
Parameters	None

GetLatitude method *

Returns the latitude of the given location.

Return value	Numeric(9.5)
Parameters	location:Geolocation

GetLongitude method *

Returns the longitude of the given location.

Return value	Numeric(9.5)
Parameters	location:Geolocation

GetDistance method

Returns the distance between the two locations given.

Return value	GeolocationInfo
Parameters	fromLocation:Geolocation, toLocation:Geolocation

GetAddress method

Returns a collection of addresses for the given location.

Return value	Collection( Address )
Parameters	location:Geolocation domain

In order to work properly, you must configure a valid Google API Key in Google API Key property (at Environment level)

GetLocation method

Returns a collection of locations for the given address.

Return value	Collection( Geolocation )
Parameters	address:Address

In order to work properly, you must configure a valid Google API Key in Google API Key property (at Environment level)

SetProximityAlerts method *

Sets a set of proximity alerts and returns the success status of the operation. Check HowTo: Use Geolocation Proximity Alerts article.

Return value	Boolean
Parameters	proximityAlerts: Collection(GeolocationProximityAlerts)

GetProximityAlerts method *

Get the list of proximity alerts set. Check HowTo: Use Geolocation Proximity Alerts article.

Return value	proximityAlerts: Collection( GeolocationProximityAlerts )
Parameters	None

GetCurrentProximityAlert method *

Get the information of the current proximity alert. Check HowTo: Use Geolocation Proximity Alerts article.

Return value	GeolocationProximityAlerts
Parameters	None

ClearProximityAlerts method *

Clear the list of proximity alerts set. Check HowTo: Use Geolocation Proximity Alerts article.

Return value	None
Parameters	None

PickLocation Method

Picks (or select) a location.

Return value	None
Parameters	GeolocationPickerParameters:GeolocationPickerParameters

Proximity Alerts methods are only available for iOS.
In iOS, the Tracking and Proximity Alerts methods need permissions to work in background mode. This can be done by adding the 'location' value to the Background Modes property. Also, Deferring Location Updates are available, reducing battery usage.
In iOS 8.0 or later, a value for Location Always Usage Description or Location When In Use Usage Description properties is required when you use location services.