From 5be7c50c888cc86354b5501ac13c00955eca5e77 Mon Sep 17 00:00:00 2001 From: skykelsey Date: Fri, 12 Sep 2014 10:04:03 -0700 Subject: [PATCH] Update docs for 1.6.0 release. --- CHANGELOG.md | 19 +++++++++++++++++++ docs/APIChanges.md | 18 ++++++++++++++++++ docs/migrating_to_1.6.0.md | 13 +++++++++++++ 3 files changed, 50 insertions(+) create mode 100644 docs/migrating_to_1.6.0.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 140340dd4..cf4219eee 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,22 @@ +# 2014-09-12 skykelsey 1.6.0 + +#### Major changes + +* Refactored repo to be more Gradle friendly. See these instructions if you are upgrading from a previous release. +* Added Gradle support. +* Added legacy IntelliJ project files for those who do not yet use Gradle. +* Simplified the sample apps. +* Added ability to send CustomData and EventData with Events. +* Added Parse push notification support. +* Added ability to set initial user name through API. + +#### Bugs fixed: + +* Fixed Eclipse project files. +* Fixed JsonDiffer to handle zero value float diffing. + +If you were using a previous version, see [Migrating to 1.6.0](https://github.com/apptentive/apptentive-android/blob/master/docs/migrating_to_1.6.0.md) + # 2014-07-16 skykelsey 1.5.1 #### Major changes diff --git a/docs/APIChanges.md b/docs/APIChanges.md index 59153e531..9c0d63f62 100644 --- a/docs/APIChanges.md +++ b/docs/APIChanges.md @@ -1,5 +1,23 @@ This document tracks changes to the API between versions. +# 1.6.0 + +* Added ability to send custom data and EventData with Events. +* Added support for Parse push notifications. +* Added ability to set initial user name. +* The repo has been refactored to use a more Gradle friendly format. + +[Migrating to 1.6.0](https://github.com/apptentive/apptentive-android/blob/master/docs/migrating_to_1.6.0.md) + +| Added Methods | +| ------------- | +| [public static synchronized boolean engage(Activity activity, String event, Map customData)]() | +| [public static synchronized boolean engage(Activity activity, String event, Map customData, ExtendedData... extendedData)]() | +| [public static void addParsePushIntegration(Context context, String deviceToken)]() | +| [public static void setParsePushCallback(Class activity)]() | +| [public static void setInitialUserName(Context context, String name)]() | + + # 1.5.0 Refactored [Surveys](http://www.apptentive.com/docs/android/features/#surveys) to use the new Event framework. You should use [Apptentive.engage(Activity activity, String eventName)](http://www.apptentive.com/docs/android/api/com/apptentive/android/sdk/Apptentive.html#engage%28android.app.Activity,%20java.lang.String%29) instead of `Apptentive.showSurvey()`. diff --git a/docs/migrating_to_1.6.0.md b/docs/migrating_to_1.6.0.md new file mode 100644 index 000000000..9e2e05bd1 --- /dev/null +++ b/docs/migrating_to_1.6.0.md @@ -0,0 +1,13 @@ +# Migrating to 1.6.0 + +This release refactors our repo to be more Gradle friendly, cleans up our samples, adds Gradle support, and adds several new features. + +**Note:** If you were using an old version, you may also need to read [Migrating to 1.4.0](https://github.com/apptentive/apptentive-android/blob/master/docs/migrating_to_1.4.0.md) and [Migrating to 1.5.0](https://github.com/apptentive/apptentive-android/blob/master/docs/migrating_to_1.5.0.md). + + + +### Project Structure + +Our new project structure renames the Apptentive SDK directory from `apptentive-android-sdk` to simply `apptentive`. If you were priviously referencing `apptentive-android-sdk` in your Eclipse or IntelliJ IDEA project, you should remove that reference and follow the instructions to add it back in [here](http://www.apptentive.com/docs/android/integration/#setting-up-the-project). + +In addition, we have added support for Gradle in this release. While we do not yet upload an AAR to a Maven repo (this is coming soon!), you can now use Apptentive in your gradle projects with minimal extra work. Please see instructions [here](http://www.apptentive.com/docs/android/integration/#using-gradle).