The Geolocation API extends the web spec: https://developer.mozilla.org/en-US/docs/Web/API/Geolocation
As a browser polyfill, this API is available through the
navigator.geolocation global - you do not need to
Configuration and Permissions
You need to include the
NSLocationWhenInUseUsageDescription key in Info.plist to enable geolocation when using the app. Geolocation is enabled by default when you create a project with
In order to enable geolocation in the background, you need to include the 'NSLocationAlwaysUsageDescription' key in Info.plist and add location as a background mode in the 'Capabilities' tab in Xcode.
To request access to location, you need to add the following line to your app's
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
Android API >= 18 Positions will also contain a
mocked boolean to indicate if position was created from a mock provider.
Android API >= 23 Requires an additional step to check for, and request the ACCESS_FINE_LOCATION permission using the PermissionsAndroid API. Failure to do so may result in a hard crash.
Sets configuration options that will be used in all location requests.
skipPermissionRequests- defaults to
trueyou must request permissions before using Geolocation APIs.
Request suitable Location permission based on the key configured on pList. If NSLocationAlwaysUsageDescription is set, it will request Always authorization, although if NSLocationWhenInUseUsageDescription is set, it will request InUse authorization.
static getCurrentPosition(geo_success, geo_error?, geo_options?)
Invokes the success callback once with the latest location info. Supported options: timeout (ms), maximumAge (ms, default - INFINITY), enableHighAccuracy (bool) On Android, if the location is cached this can return almost immediately, or it will request an update which might take a while.
static watchPosition(success, error?, options?)
Invokes the success callback whenever the location changes. Supported options: timeout (ms), maximumAge (ms, default - INFINITY), enableHighAccuracy (bool), distanceFilter(m), useSignificantChanges (bool)
Stops observing for device location changes. In addition, it removes all listeners previously registered.
Notice that this method has only effect if the
geolocation.watchPosition(successCallback, errorCallback) method was previously invoked.