diff options
Diffstat (limited to 'StoneIsland/plugins/cordova-plugin-geolocation/README.md')
| -rw-r--r-- | StoneIsland/plugins/cordova-plugin-geolocation/README.md | 33 |
1 files changed, 20 insertions, 13 deletions
diff --git a/StoneIsland/plugins/cordova-plugin-geolocation/README.md b/StoneIsland/plugins/cordova-plugin-geolocation/README.md index 77a3c9a7..5fa8dee6 100644 --- a/StoneIsland/plugins/cordova-plugin-geolocation/README.md +++ b/StoneIsland/plugins/cordova-plugin-geolocation/README.md @@ -21,9 +21,9 @@ description: Access GPS data. # under the License. --> -|Android|iOS| Windows 8.1 Store | Windows 8.1 Phone | Windows 10 Store | Travis CI | -|:-:|:-:|:-:|:-:|:-:|:-:| -|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android,PLUGIN=cordova-plugin-geolocation/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-geolocation/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-store,PLUGIN=cordova-plugin-geolocation/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-phone,PLUGIN=cordova-plugin-geolocation/)|[](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-geolocation/)|[](https://travis-ci.org/apache/cordova-plugin-geolocation)| +|AppVeyor|Travis CI| +|:-:|:-:| +|[](https://ci.appveyor.com/project/ApacheSoftwareFoundation/cordova-plugin-geolocation)|[](https://travis-ci.org/apache/cordova-plugin-geolocation)| # cordova-plugin-geolocation @@ -71,7 +71,7 @@ are not available until after the `deviceready` event. } ``` -## <a id="reference"></a>Reference + ## Installation This requires cordova 5.0+ ( current stable 1.0.0 ) @@ -88,13 +88,8 @@ It is also possible to install via repo url directly ( unstable ) ## Supported Platforms -- Amazon Fire OS - Android -- BlackBerry 10 -- Firefox OS - iOS -- Tizen -- Windows Phone 7 and 8 - Windows ## Methods @@ -159,6 +154,22 @@ error, the `geolocationError` callback is passed a ``` +### iOS Quirks + + Since iOS 10 it's mandatory to provide an usage description in the `info.plist` if trying to access privacy-sensitive data. When the system prompts the user to allow access, this usage description string will displayed as part of the permission dialog box, but if you didn't provide the usage description, the app will crash before showing the dialog. Also, Apple will reject apps that access private data but don't provide an usage description. + + This plugins requires the following usage description: + + * `NSLocationWhenInUseUsageDescription` describes the reason that the app accesses the user's location. + + To add this entry into the `info.plist`, you can use the `edit-config` tag in the `config.xml` like this: + +``` +<edit-config target="NSLocationWhenInUseUsageDescription" file="*-Info.plist" mode="merge"> + <string>need location access to find things nearby</string> +</edit-config> +``` + ### Android Quirks If Geolocation service is turned off the `onError` callback is invoked after `timeout` interval (if specified). @@ -294,10 +305,6 @@ It contains a set of properties that describe the geographic coordinates of a po * __speed__: Current ground speed of the device, specified in meters per second. _(Number)_ -### Amazon Fire OS Quirks - -__altitudeAccuracy__: Not supported by Android devices, returning `null`. - ### Android Quirks __altitudeAccuracy__: Not supported by Android devices, returning `null`. |