From 4a960cba126ff7ab52adf5a5c24bfe88e2379717 Mon Sep 17 00:00:00 2001 From: peter Date: Wed, 24 Sep 2014 18:02:36 +0200 Subject: [PATCH] Bumping the release version to 3.1.0. Started to write a change log file to allow backtracking of API changes and added features. Added some info about iOS 8 permissions to the readme file. --- CHANGELOG.md | 22 ++++++++++++++++++++++ README.md | 11 +++++++++-- plugin.xml | 2 +- 3 files changed, 32 insertions(+), 3 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..185b4b8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,22 @@ +# 3.1.0 + +## Features + +* Two new methods were added to manage new permissions introduced by iOS 8 + +* ```BeaconRegion```s now support the parameter ```notifyEntryStateOnDisplay``` in their constructor. + +## Breaking Changes + +* On iOS 8, the beacon interaction won't work without explicitly asking for permission from the user. + + +# 3.0.0 + +## Breaking Changes + +* The plugin received a new ID. Previously it was ```org.apache.cordova.ibeacon``` and now it runs as +```com.unarin.cordova.beacon```. To perform an upgrade from earlier versions with the old ID, you'll have to remove +and add the plugin again with the cordova cli commands: ```cordova plugin rm org.apache.cordova.ibeacon``` and then +```cordova plugin add com.unarin.cordova.beacon``` to get the latest version. You can have a look at the PhoneGap Build +submission [here](https://build.phonegap.com/plugins/986). diff --git a/README.md b/README.md index 931cbc7..10c7284 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,12 @@ Since version 2, the main ```IBeacon``` facade of the DOM is called ```LocationM Another important change of version 2 is that it no longer pollutes the global namespace, instead all the model classes and utilities are accessible through the ```cordova.plugins.locationManager``` reference chain. +#### iOS 8 Permissions + +On iOS 8, you have to request permissions from the user of your app explicitly. You can do this through the plugin's API. +See the [LocationManager](https://github.com/petermetz/cordova-plugin-ibeacon/blob/master/www/LocationManager.js)'s +related methods: ```requestWhenInUseAuthorization``` and ```requestWhenInUseAuthorization``` for further details. + #### Standard [CLLocationManager](https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/CLLocationManager/CLLocationManager.html) functions @@ -287,7 +293,8 @@ cordova.plugins.locationManager.stopAdvertising() ## Contributions > Contributions are welcome at all times, please make sure that the tests are running without errors -> before submitting a pull request. +> before submitting a pull request. The current development branch that you should submit your pull requests against is +> "v3.x". ### How to execute the tests - OS X @@ -296,7 +303,7 @@ cordova.plugins.locationManager.stopAdvertising() * [NodeJS](http://nodejs.org/) * [NPM](https://www.npmjs.org/) * [Cordova NPM package](https://www.npmjs.org/package/cordova) (Tested with: 3.4.0-0.1.3) -* [XCode](https://developer.apple.com/xcode/) (Tested with 5.0.2) +* [XCode](https://developer.apple.com/xcode/) (Tested with 5.0.2 and 6.0) ``` diff --git a/plugin.xml b/plugin.xml index c58351a..1ebe322 100644 --- a/plugin.xml +++ b/plugin.xml @@ -1,5 +1,5 @@ - + Proximity Beacon Plugin Proximity Beacon Monitoring and Transmission Plugin (supporting iBeacons)