- The Command-line Interface
- Platform Guides
- Configuration Reference
- Embedding WebViews
- Plugin Development Guide
- Privacy Guide
- Domain Whitelist Guide
geolocationobject provides access to location data based on the device's GPS sensor or inferred from network signals.
Geolocation provides information about the device's location, such as
latitude and longitude. Common sources of location information include
Global Positioning System (GPS) and location inferred from network
signals such as IP address, RFID, WiFi and Bluetooth MAC addresses,
and GSM/CDMA cell IDs. There is no guarantee that the API returns the
device's actual location.
This API is based on the W3C Geolocation API Specification, and only executes on devices that don't already provide an implementation.
Accessing the Feature
As of version 3.0, Cordova implements device-level APIs as plugins.
Use the CLI's
plugin command, described in The Command-line
Interface, to add or remove this feature for a project:
$ cordova plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-geolocation.git $ cordova plugin rm org.apache.cordova.core.geolocation
These commands apply to all targeted platforms, but modify the platform-specific configuration settings described below:
(in app/res/xml/config.xml) <feature name="Geolocation"> <param name="android-package" value="org.apache.cordova.GeoBroker" /> </feature> (in app/AndroidManifest.xml) <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /> <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
(in www/plugins.xml) <feature name="Geolocation"> <param name="blackberry-package" value="org.apache.cordova.geolocation.Geolocation" /> </feature> (in www/config.xml) <rim:permissions> <rim:permit>read_geolocation</rim:permit> </rim:permissions>
<feature name="Geolocation"> <param name="ios-package" value="CDVLocation" /> </feature>
Windows Phone (in
<Capabilities> <Capability Name="ID_CAP_LOCATION" /> </Capabilities>
Reference: Application Manifest for Windows Phone
Some platforms may support this feature without requiring any special configuration. See Platform Support for an overview.