CHANGELOG.md

Change Log

v2.2.3

2020-08-29

• [Changed] Replace "Bummer." with "Oh no!" as default critical feedback question title.

v2.2.2

2019-11-17

• [Fixed] Catch all thrown exceptions when accessing package info of review apps.

v2.2.1

2019-05-06

• [Fixed] Updated internal map to support calling notifyEventTriggered with different instances of a single event type.

v2.2.0

2017-12-11

• [Changed] Updated dependency and target versions.

v2.1.1

2017-11-01

• [Fixed] Overloaded constructor provided to allow specifying an alternate SharedPreferences instance is now correctly marked public.

v2.1.0

2017-03-05

• [Added] Default email feedback template now includes application install source (Google Play Store, Amazon Appstore, etc.). This information is also exposed through the IApp interface.

v2.0.0

2017-02-26

Second major version! The Amplify instance configuration API has been overhauled significantly. This version should be backwards-compatible with 1.X versions in the sense that the information written to disk to track events has not changed. Therefore, upgrading to this version of amplify should not reset any tracked event information within your apps.

• [Added] Ability to specify feedback collection methods via Amplify.setPositiveFeedbackCollectors and Amplify.setCriticalFeedbackCollectors. Prior to this release, positive feedback was always collected via the Google Play Store, and critical feedback via email. This expanded functionality replaces the more limited functionality previously offered by Amplify.setFeedbackEmailAddress, Amplify.setFeedbackEmailContentProvider, and Amplify.setPackageName and those methods have therefore been removed.
• [Added] Ability to specify multiple feedback collection methods in priority order. If the highest priority collector is unable to collect feedback on the current device, the next highest priority collector is tried, etc.
• [Added] Built-in support for collecting feedback via the Amazon App Store. See the new AmazonAppStoreFeedbackCollector class.
• [Changed] Default feedback email template now includes more information about the user device.
• [Changed] Tweaked the example app to make it feel like it belongs to this project (new name and icon!).
• [Internal] Simplified internal models and updated them to be more representative of the problem space rather than of the solution space. This internal restructuring was significant, but not much should leak into consumer code. If you notice any changes not captured in this CHANGELOG entry that have affected your consumption of the library, please open an issue that describes the change and its impact.

v1.5.1

2017-01-02

• [Fixed] Crash that could occur when restoring saved prompt view state.

v1.5.0

2016-06-07

• [Added] The subject line and pre-filled body for critical feedback emails can now be customized.
• [Changed] The method Amplify.setLogLevel(LogLevel) has been removed. Logging is now enabled by calling Amplify.setLogger(ILogger) before any other configuration occurs.

v1.4.0

2016-06-06

• [Fixed] Prompt views being rendered by Android Studio's Layout Editor Preview no longer cause an IllegalStateException (issue #152);
• [Added] Users can now customize more attributes of the DefaultLayoutPromptView in both xml and code:
  • Text size;
  • Button border width;
  • Button corner radius.

v1.3.1

2016-04-12

• [Fixed] BasePromptView subclasses now properly restore all state after configuration changes:
  • Crash on orientation change when attempting to unpack saved state (issue #146; affects v1.2.0 and v1.3.0);
  • BasePromptView configuration being reset to default on orientation change (issue #148).

v1.3.0

2016-04-06

• [Added] A new initialization method, Amplify.initSharedInstance(Application, String), has been added. The second String parameter represents the name of the SharedPreferences instance that will be used to store and retrieve tracking data. Amplify.initSharedInstance(Application) works exactly as before, with tracking data stored in the default SharedPreferences instance named "AMPLIFY_SHARED_PREFERENCES_NAME".
• [Added] Subclasses of BasePromptView (which include the packaged DefaultLayoutPromptView and CustomLayoutPromptView classes) can now be configured to automatically fade out the displayed thanks view after a delay. The length of this delay may be specified using the xml attribute prompt_view_thanks_display_time_ms or by calling the method setThanksDisplayTimeMs(int) when building a BasePromptViewConfig instance programmatically. The default behavior is for the thanks view to display indefinitely.
• [Fixed] Base prompt view config not being saved/restored during configuration changes.

v1.2.0

2016-03-31

• [Added] Subclasses of BasePromptView (which include the packaged DefaultLayoutPromptView and CustomLayoutPromptView classes) now properly save and restore state through orientation changes. This change induced several other structural adjustments.
• [Changed] The method Amplify.get(Context) has been replaced by two separate methods:
  • Amplify.initSharedInstance(Application), which should be called when performing initial library configuration in your custom Application subclass;
  • Amplify.getSharedInstance(), which can be called thereafter to obtain a reference to your configured Amplify instance.
• [Changed] The methods Amplify.promptIfReady(Activity, IPromptView) and Amplify.promptIfReady(Activity, IPromptView, IEventListener<PromptViewEvent>) have been replaced by the method Amplify.promptIfReady(IPromptView). Users who wish to listen for promp-related events should now register an IEventListener implementation with their PromptView before calling Amplify.promptIfReady. This can be accomplished using the BasePromptView. (IEventListener) method.
• [Note] Any user-provided implementations of IPromptView that wish to properly save and restore state through orientation changes should mimic the implementation used in the BasePromptView class. (It is expected that almost all library users will be using a packaged subclass of BasePromptView, and can therefore safely ignore this.)
• [Note] Any user-provided implementations of IPromptView must prepare an associated PromptPresenter instance in their constructors, rather than receiving an instance via the (now-removed) IPromptView.setPresenter(IPromptPresenter) method. Library users can refer to the BasePromptView class as an example.
• [Fixed] Memory leak that occurred during device configuration changes.

The README has been updated to reflect all of the above changes.

v1.1.0

2016-03-20

• [Changed] VersionChangedRule has been removed and replaced with VersionNameChangedRule and VersionCodeChangedRule to allow library consumers to decide which dimension of the embedding application version to track. Events of these types are registered using the new methods addLastEventVersionNameRule and addLastEventVersionCodeRule respectively. applyAllDefaultRules now uses VersionNameChangedRule internally for consistency with amplify v1.0.0.
• [Added] New minimum count rule. When this rule is applied, the feedback prompt will only be shown if the associated event has occurred at least a given number of times.
• [Changed] Moved the GooglePlayStoreRule into the correct package (com.github.stkent.amplify.tracking.rules).

v1.0.0

2016-03-18

Initial public release!

• [Note] Upgrading to this version (or later) of amplify from a pre-release version will reset all tracking information for certain built-in events (app crashed; user gave/declined to give positive/critical feedback). We will endeavor to avoid this in all post-1.0.0 builds.