From a26b5100cdcc1bee236c11bc46ceae83c71fb5a1 Mon Sep 17 00:00:00 2001
From: Website Deployment Script import it.
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 react-native init.
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 react-native init.
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.
+'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 AndroidManifest.xml:
To request access to location, you need to add the following line to your app's
+AndroidManifest.xml:
<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 >= 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. + the PermissionsAndroid API. Failure to do so may result in a hard crash.
skipPermissionRequests - defaults to false, if true you must request permissions
-before using Geolocation APIs.skipPermissionRequests - defaults to false, if true you must request
+permissions before using Geolocation APIs.requestAuthorization()static requestAuthorization()
-Request suitable Location permission based on the key configured on pList. -If NSLocationAlwaysUsageDescription is set, it will request Always authorization, +
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.
getCurrentPosition()static getCurrentPosition(geo_success, geo_error?, geo_options?)
-Invokes the success callback once with the latest location info. Supported -options: timeout (ms), maximumAge (ms), 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.
+Invokes the success callback once with the latest location info. Supported +options: timeout (ms), maximumAge (ms), 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.
watchPosition()static watchPosition(success, error?, options?)
-Invokes the success callback whenever the location changes. Supported -options: timeout (ms), maximumAge (ms), enableHighAccuracy (bool), distanceFilter(m), useSignificantChanges (bool)
+Invokes the success callback whenever the location changes. Supported options: +timeout (ms), maximumAge (ms), enableHighAccuracy (bool), distanceFilter(m), +useSignificantChanges (bool)
clearWatch()static clearWatch(watchID)
diff --git a/docs/geolocation.html b/docs/geolocation.html
index 05a728adb7a..cd2a76954d5 100644
--- a/docs/geolocation.html
+++ b/docs/geolocation.html
@@ -20,22 +20,22 @@ global - you do not need to import it.
iOS
-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 react-native init.
+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 react-native init.
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.
+'NSLocationAlwaysUsageDescription' key in Info.plist and add location as a
+background mode in the 'Capabilities' tab in Xcode.
Android
-To request access to location, you need to add the following line to your
-app's AndroidManifest.xml:
+To request access to location, you need to add the following line to your app's
+AndroidManifest.xml:
<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 >= 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.
+ the PermissionsAndroid API.
Failure to do so may result in a hard crash.
Methods
@@ -57,31 +57,32 @@ was created from a mock provider.
Options
iOS
-skipPermissionRequests - defaults to false, if true you must request permissions
-before using Geolocation APIs.
+skipPermissionRequests - defaults to false, if true you must request
+permissions before using Geolocation APIs.
requestAuthorization()
static requestAuthorization()
-Request suitable Location permission based on the key configured on pList.
-If NSLocationAlwaysUsageDescription is set, it will request Always authorization,
+
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.
getCurrentPosition()
static getCurrentPosition(geo_success, geo_error?, geo_options?)
-Invokes the success callback once with the latest location info. Supported
-options: timeout (ms), maximumAge (ms), 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.
+Invokes the success callback once with the latest location info. Supported
+options: timeout (ms), maximumAge (ms), 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.
watchPosition()
static watchPosition(success, error?, options?)
-Invokes the success callback whenever the location changes. Supported
-options: timeout (ms), maximumAge (ms), enableHighAccuracy (bool), distanceFilter(m), useSignificantChanges (bool)
+Invokes the success callback whenever the location changes. Supported options:
+timeout (ms), maximumAge (ms), enableHighAccuracy (bool), distanceFilter(m),
+useSignificantChanges (bool)
clearWatch()
static clearWatch(watchID)