Skip to content

Latest commit

 

History

History
905 lines (883 loc) · 29.2 KB

changelog.md

File metadata and controls

905 lines (883 loc) · 29.2 KB

Ubudu-SDK Changelog:

Version Date Author Modifications
1.0 2013-10-01 PJB Created.
1.0.1 2013-10-02 PJB Integred FK's comments.
1.0.2 2013-10-04 PJB Integred answers to questions.
1.0.3 2013-10-07 PJB Added iBeacon Advertisement Messages section.
1.0.4 2013-10-09 PJB Use java.util.Date instead of java.util.Calendar.
1.0.5 2013-10-09 PJB Added context parameter to start and stop on android.
1.0.6 2013-10-23 PJB Split out UbuduIOSSDK, and changes to the server section.
1.0.7 2013-11-04 PJB Updated and precised the rule/action specification.
1.0.8 2013-11-08 PJB Added UbuduSDK displayWebPage and openPassbook/SamsungWallet utility methods. Refined description of user notifications processing.
1.0.9 2013-11-21 PJB Changed the schedule data structure to match the Ruby library used on the server.
1.0.10 2013-11-25 PJB
  • renamed version field to api_version in the request.
  • changed the structure of timezone field.
  • Added algorithm for opening time schedule.
1.0.11 2013-12-30 PJB
  • added the udid field to api requests.
1.0.12 2014-04-24 PJB
  • added specification of JSON payload in notification message.
1.0.13 2014-08-13 PJB
  • added the UbuduUser interface.
1.1.0 2014-08-25 PJB Added UbuduUser interface.
1.1.1 2014-08-26 PJB Added anti hacking protocol configuration from the server.
1.1.2 2014-08-28 PJB Added statusChange() delegate method.
1.2.0 2014-09-16 TZ Added setFileLogEnabled flag for enabling getting / clearing logs.
1.2.1 2014-09-18 TZ Added support for custom baseURL.
1.2.3 2014-10-06 TZ Fix for WiFi & BLE issues.
1.2.5 2014-10-17 TZ Support for continous proximities.
1.3.0 2014-11-06 TZ Added setWifiBleFixDisabled for disabling fix for wifi & ble ble issue. Fix bug with user's tags.
1.4.0 2014-11-13 Tomasz Ziolkowski

Add setRegionExitMinDelay setter to set delay after which delegate get notified about exiting region.

Regions are defined by proximiy UUID. That means all beacons with the same proximityUUID and different major/minor belongs to same region.
1.4.1 2014-11-19 TZ Bug fixes
1.4.2 2014-12-09 TZ Proximity accuracy improved
1.4.3 2014-12-23 TZ Add min/max events count/periods for rules and for the app. Add some more log events.
1.4.5 2015-01-13 JBQ
Bug due to Dexguard config which was making

the SDK unusable.
1.4.6 2015-02-09 TZ Fix a bug causes reset limit counters. Fix region behaviour.
1.4.7 2015-02-12 TZ Fix group and regions behaviour. Update for log events.
1.4.8 2015-03-17 TZ
  • Improve stability of the SDK.
  • Add mediumFar and highFar proximities
1.4.9 2015-04-02 TZ
  • Improve rsi measurements.
  • Fix bug with starting sdk.
1.4.10 2015-04-09 TZ Fix getting native device from UbuduBeacon.
1.5.0 2015-04-17 TZ Stability improvements and bug fixes Reduced verbosity of logcat/logs. Lower frequency to send async logged event to server. Deep linking actions. Optimisation of user tags management tags management.
1.6.0 2015-05-12 TZ

Fix bug while working with secured beacons.

Add API for between log setting period events.

Improve rssi averaging.

Fix for relative proximity.

Add API for reseting global event counter.

Reduced battery consumption.
1.7.0 2015-05-19 TZ

Multiline notifications.

Mesh (beta).

Indoor Location (beta).

Bug fixes.
1.7.1 2015-05-29 TZ

No toasts from ubudu sdk.

Custom alertTitle for notification.

Minor fixes.
1.7.2 2015-05-29 TZ

Bug fixes.
1.7.3 2015-06-09 TZ

Fix for uuid bug.

Restart Ubudu service after app killing.

Fix UI freeze while starting the beacon manager.

Other bug fixes.
1.8.0 2015-06-30 MG

Performance improvements for namespaces with high number of interaction rules.

Other bug fixes.
1.8.1 2015-07-01 MG

Fixed matching regions to beacon.
1.8.2 2015-07-08 MG

Fix scanning periods custom settings

Added methods to customize rules fetching period

Fixed custom notification mechanism after app is killed
1.8.3 2015-07-14 MG

Custom notification fix when the app is killed

Minor API update for indoor location and mesh
1.8.4 2015-07-23 MG

Fix for rare issue with fetching rules

Fix stopping a beacon manager

Minor Indoor Location improvements

Minor API updates
1.8.5 2015-08-05 MG

Fix of Indoor Location not always starting

Stability improvements
1.9.0 2015-09-07 MG

New beacon service updated for Lollipop

Updated indoor location delegate

Geofences updated for Google Play Services v7.8

Improved and updated ubudu mesh

Enhance manager logs handling

Improved rules triggering after latch time

Fixed bug of rules not always being fetched when Ubudu SDK was initially started in offline mode

Bug fixes and stability improvements
1.9.1 2015-09-09 MG

Indoor Location Georeference functionality

Indoor Location delegate methods fixes

Bug fixes and stability improvements
1.9.2 2015-09-10 TZ

Mesh fix while for sending message without ACK
1.9.3 2015-09-29 MG

Indoor Location:

* polygon zones handling

* public path finding method

* enhanced location accuracy and stability

* geographical coordinates are now returned in degrees

* map overlay image url is available from within json
1.9.4 2015-09-29 MG

Indoor Location:

* polygon distance calculation fix
1.9.5 2015-10-19 MG

Added motion filtering for indoor location stability

Added ranged beacon notifier API method for both proximity and indoor location that allows to see beacons currently being ranged by the SDK

Added API method allowing to get a JSONObject of indoor location map for saving purpose

Added API methods for customizing ranging/monitoring scan periods within indoor location manager

Bug fixes and stability improvements
1.9.6 2015-10-19 MG

Android manifest fix
1.9.7 2015-11-06 MG

Contextual Interactions SDK:

* added support for new maximum distance medium-far feature available in the manager platform

* active regions are now cleared after SDK has been stopped

* added public method `com.ubudu.sdk.UbuduSDK.resetAllEventsCounters()` that allows to reset all events counters

Indoor Location SDK:

* indoor location map data processing before start is now much faster

* delegate methods are called also after the very first position calculation

Other:

* fixed release .pom file notes

* bugs and stability improvements
1.9.8 2015-11-09 MG

Fixed an issue of Contextual Interactions SDK start being delayed in case when Indoor Location SDK has been started short moment before
1.9.9 2015-11-10 MG

Indoor Location:

* Fixed a bug of map fetching retry mechanism
1.9.10 2015-11-12 MG

Fixed an issue of server notification title not being overriden.
1.10.0 2015-12-01 MG

Issues fixed:

* doubled contextual rules fetching

* server notification title not being set

* receiving double mesh messages

Improvements:

* removed `com.google.android.gms.permission.ACTIVITY_RECOGNITION` from the manifest. If developer wants to take advantage of the additional motion sensor filtering within the Indoor Location SDK (improves position stability) this permission must be manually added to the app's manifest.

Features added:

* new API method for decrementing and reseting rule counter when the developer does not want to perform action to the user during custom event handling

* logic alignments with the new features related to contextual rules introduced in the manager platform

* Changed `UbuduAreaDelegate` method `notifyUserForEvent(UbuduEvent event)` from void type to boolean.

* Added new `UbuduAreaDelegate` method `void notifyUserForEvent(UbuduEvent event, UbuduAreaDelegateEventHandlingResponseListener responseListener)` for custom event handling in which the decision about performing action to the user is to be delayed.
2.0.0 2016-01-06 MG

Improvements:

* greatly improved SDK init time

* bug fixes and stability improvements

Features added:

* removed Indoor Location API and Mesh API. These packages are now available at separate repositories
2.0.1 2016-01-15 MG

Features added:

* changed public API pattern so the methods parameters names are understandable,

* added API for adding custom http request headers for server notification

Issues addressed:

* UbuduService is now properly destroyed and removed from the application processes when stop is called from beacon/geofence managers
2.0.2 2016-02-10 MG

Issues addressed:

* fixed db issues when migrating from version 1.9.+ to version >=2.0.0

* fixed ANR when calling resetAllEventsCounters() method

* fixed rare crash when using a dump json log file feature

* fixed rare issue when beacon monitoring was not started when another scanning Ubudu library was working in paralel

* fixed issue when log "uBeacon monitoring started." was shown after asking manager to stop
2.0.3 2016-02-12 MG

Improvements:

* stripped down google-play-services dependency

Issues addressed:

* fixed some migration issues
2.0.6 2016-02-17 MG

Improvements:

* Got rid of unnecessary permissions

Issues addressed:

* minor bug fixes related to switching between applications (namespaces)

* minor fixes related to BLE scanning
2.0.7 2016-02-25 MG

Features added:

* added big icon style automatic notifications handling ( http://developer.android.com/reference/android/app/Notification.BigPictureStyle.html ). Big icon url must be defined in the rule in the Ubudu Manager Platform. Example:

Issues addressed:

* fix few NPE crashes

* fix lack of permissions related crashes on Android M
2.0.10 2016-03-05 MG

Features added:

* added timestamp to UbuduBeacon object

Improvements:

* stabilized ranged beacon notifier output. Beacons do not dissapear immediately if they are not detected in a single scan

Issues addressed:

* fixed issue with switching between namespaces when sometimes the SDK stopped responding and could not be restarted
2.1.2 2016-03-17 MG

Features added:

* model specific distance estimation that improves the accuracy of device-beacon distance estimation

Improvements:

* improved custom event handling by adding additional UbuduCustomEventHandlingAreaDelegate interface that is an extension of the default UbuduAreaDelegate

Issues addressed:

* fixed triggering rules at medium-far and high-far proximities with custom distance treshold
2.2.0 2016-03-22 MG

API changes (details can be found in the updated manual) :

* Changed the API for custom handling the events.

* removed UbuduGeofenceDelegate interface. UbuduAreaDelegate is the interface to be used both for geofences and beacons.

* removed context argument from area managers start/stop methods

Improvements:

* updated documentation and JavaDoc

Issues addressed:

* fixed geofences not triggering events

* open_notif type logs missing in the application statistics when custom handling the events
2.2.1 2016-03-22 MG

Improvements:

* UbuduEvent and few other API interfaces are now parcelable to improve the event custom handling in an Android app (from one activity to another etc)
2.2.2 2016-04-13 MG

Issues addressed:

* Fixed beacon distance calculation when distance was sometimes < 0m
2.2.3 2016-04-17 MG

Features added:

* added new methods to beacon/geofence manager which allow to execute actions of a particular event (like opening a web url in the default WebView) or just notify the SDK about event being custom handled on the app's side so proper statistic logs are posted to the back office. Please check the manual for details.

Issues addressed:

* Fixed SDK crashing on init because of an java.lang.NoClassDefFoundError
2.2.4 2016-04-22 MG

Issues addressed:

* Fixed a very serious bug that caused a significant growth of the app's total usage of internal memory over time
2.2.5 2016-04-29 MG

Features added:

* added Advertising ID support

* added support for new analytics logs related to device bluetooth state and location/notifications permissions

Improvements:

* removed Context argument from SDK's release method

* changed the deprecated `android.text.format.Time` class to java.util.Date object in the UbuduSDK `nextFetchTime()` and `setNextFetchTime` methods

* minor fixes and improvements

Issues addressed:

* fixed an issue with Ormlite's OpenHelperManager that could not be used in the app using Ubudu SDK

* fixed crashes occuring when app using Ubudu SDK is installed on pre API 18 devices
2.2.6 2016-05-24 MG

Issues addressed:

* fixed issues causing problems when building the final app with proguard
2.2.7 2016-08-09 MG

Issues addressed:

* fixed ANRs happening on Android M when scanning is triggered while app does not have geolocation permissions
2.2.8 2016-09-12 MG

Improvements:

* added callback to com.ubudu.sdk.UbuduSDK#setUserInformation method so the app can be notified about the result

* full UbuduArea object is passed into areaEntered delegate method

* WebSettings.MIXED_CONTENT_COMPATIBILITY_MODE is now added to the SDK's default WebView so the pages with mixed content are properly displayed

Issues addressed:

* fixed crash occuring when com.ubudu.sdk.UbuduBeaconRegion toString() method was called

* fixed user tags not being properly passed to web api

* fixed rare crash happening on some Samsung devices related to lack of android.permission.BLUETOOTH permission

* delegate's methods areaEnterd and areaExited are now called on a main thread (now there is no need to create separate Handler on the app's side)
2.3.0 2016-11-15 MG

Improvements:

* updated REST API library

* replace palceholders also in alertTitle and custom payload

* updated Google Play Location Services to version 9.8.0

API changes:

* UbuduRegisteringUserCallback renamed to UbuduCompletionCallback
2.4.0 2016-11-24 MG

Features added:

  • rich notifications handling
  • notifications pop out effect to rich notifications and background notifications

Issues addressed:

  • fixed issue of logs not always being posted to server properly
  • fixed geofence rules not being triggered due to position updates being delayed to much
  • fixed pending status bar notifications not being cancelled when app is killed

API changes:

  • new delegate method: `void notificationActionTriggeredForEvent(UbuduEvent event, String actionIdentifier)` for handling rich notification action buttons click events
  • renamed beacon/geofence manager methods:
    - `executeActionsForEvent ` to `executeDefaultActionsForEvent`
    - `actionsCustomExecutedForEvent` to `defaultActionsExecutedForEvent`
2.4.1 2016-11-25 MG

Issues addressed:

  • fixed permissions and bluetooth state analytic logs syntax
2.4.2 2016-12-15 MG

Features added:

  • Way to handle rich notification actions after app has been killed. New intent called `com.ubudu.sdk.service.UbuduService.action.ACTION_SERVICE_RESTARTED_WITH_EVENT` is now broadcasted when rich notification custom action is clicked while the app is killed. Mobile app should register a broadcast receiver for this intent to process the custom action with developer's own logic. See wiki article for more details.

Improvements:

  • Advertising ID is now not posted for analytics until the app asks for it by calling `enableAdvertisingIdCollection(true)` method on `com.ubudu.UbuduSDK`instance

Issues addressed:

  • rich notificatios actions not being passed to the delegate properly
  • rare crash occuring when SDK release() method is called
  • multiple `returning user` log posted at the SDK start
2.5.0 2017-01-19 MG

Features added:

  • None

Improvements:

  • Analytics logs sending improved
  • When notification has no title and body the application name is used as a title of the background notification

Issues addressed:

  • Group rules limits not working properly
  • Crash related to BroadcastReceiver registration
  • Replacing placeholders in the rule custom payload
  • Issues related to controlling geofence and beacon managers auto restart
2.5.1 2017-01-23 MG

Issues addressed:

  • Rules limits not working properly
  • Crash related to BroadcastReceiver registration
2.5.3 2017-01-26 MG

Features added:

  • beacon battery level API

Issues addressed:

  • service auto restart not working
  • placeholders not filled for geofence rules
  • crashes
2.5.4 2017-02-01 MG

Issues addressed:

  • global limits being respected even if a rule is not to be counted for global limits
  • event counters limits not being updated properly in the local database after new data is fetched from cloud
2.6.0 2017-03-15 MG

Improvements:

  • cleaned API of UbuduBeacon objects
  • improved API for bluetooth scanning control

Issues addressed:

  • fixed too many bluetooth scans being launched on Android N
2.6.1 2017-04-13 MG

Issues addressed:

  • crash related to Bluetooth scanning
2.6.2 2017-05-03 MG

Issues addressed:

  • deeplink interactions triggering
  • Bluetooth scanning start/stop
2.7.0 2017-05-15 MG

API changes:

  • added BluetoothDevice getter to UBeacon object

Improvements:

  • Bluetooth scanning stability improvements
2.7.1 2017-07-05 MG

Improvements

  • Bluetooth scanning improvements

Issues addressed:

  • rules re-triggering
2.7.2 2017-08-16 MG

Improvements:

  • Plugged latest Ubudu BLE scanner module
2.7.3 2017-10-11 MG

Improvements:

  • Updated BLE scanner module with fixes for Android N

Issues addressed:

  • Fixed not all placeholders of server notification be handled
2.8.0 2018-07-20 MG

Improvements:

  • compatibile with Android 8 background operation

Issues addressed:

  • Status bar notification not working on Android 8
  • bluetooth scanning issues on Android 8
  • restart after reboot not working on Android 8

Authors: