Skip to content

APIChanges.md

Latest commit

 

History

History
154 lines (104 loc) · 6.98 KB

APIChanges.md

File metadata and controls

154 lines (104 loc) · 6.98 KB

This document tracks changes to the API between versions.

1.6.2

  • Added API method Apptentive.willShowInteraction(). If a call to this method returns true, then a call to engage() with the same Event name will result in an Interaction being displayed.
Added Methods
public static synchronized boolean willShowInteraction(Activity activity, String event)

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

Added Methods
public static synchronized boolean engage(Activity activity, String event, Map<String, Object> customData)
public static synchronized boolean engage(Activity activity, String event, Map<String, Object> customData, ExtendedData... extendedData)
public static void addParsePushIntegration(Context context, String deviceToken)
public static void setParsePushCallback(Class<? extends Activity> activity)
public static void setInitialUserName(Context context, String name)

1.5.0

Refactored Surveys to use the new Event framework. You should use Apptentive.engage(Activity activity, String eventName) instead of Apptentive.showSurvey().

New Survey integration instructions.

Migrating to 1.5.0

Removed Methods
public static boolean showSurvey(Activity activity, OnSurveyFinishedListener listener, String... tags)
Added Methods
public static boolean Apptentive.engage(Activity activity, String eventName)
public static void setOnSurveyFinishedListener(OnSurveyFinishedListener listener)

1.4.2

Added support for AWS SNS push notifications

Added Methods
public static void addAmazonSnsPushIntegration(Context context, String registrationId)

1.4.0

The Rating Dialog has been rebuilt to use the new unified engage() method. See the Interactions section of the README for more information.

Removed Methods
public static void Apptentive.logSignificantEvent(Context context)
public static boolean showRatingFlowIfConditionsAreMet(Activity activity)
Added Methods
public static boolean Apptentive.engage(Activity activity, String eventName)

1.2.7

Changes

Please remove the line <action android:name="android.intent.action.PACKAGE_RESTARTED"/> action from Apptentive's NetworkStateReceiver in your manifest. This is not needed, and may cause excessive battery drain.

1.2.5

New Methods
public static void Apptentive.addUrbanAirshipPushIntegration(Context context, String apid)
public static void setPendingPushNotification(Context context, Intent intent)
public boolean handleOpenedPushNotification(Activity activity)
public static void setPendingPushNotification(Context context, Intent intent)

1.2.3

New Methods
public static void addIntegration(Context context, String integration, Map<String, String> config)
public static void addUrbanAirshipPushIntegration(Context context, String apid)
public static void handleOpenedPushNotification(Activity activity, Intent intent)
public static boolean isApptentivePushNotification(Intent intent)
Changes
Old Method Signature New Method Signature
public static void showRatingFlowIfConditionsAreMet(Activity activity) public static boolean showRatingFlowIfConditionsAreMet(Activity activity)

1.2.1

Additions
New Methods
public static void showMessageCenter(Activity activity, Map<String, String> customData)

1.2.0

To improve the quality of the Apptentive SDK, and to make it easier to integrate, the following API method signatures of Apptentive.java have been changed or added.

Changes
Old Method Signature New Method Signature
public static void setUserEmail(String email) public static void setInitialUserEmail(Context context, String email)
public static void setCustomData(Map<String, String> customData) public static void setCustomDeviceData(Context context, Map<String, String> customDeviceData)
Additions
New Methods
public static void addCustomDeviceData(Context context, String key, String value)
public static void removeCustomDeviceData(Context context, String key)
public static void setCustomPersonData(Context context, Map<String, String> customPersonData)
public static void addCustomPersonData(Context context, String key, String value)
public static void removeCustomPersonData(Context context, String key)
public static int getUnreadMessageCount(Context context)

1.0

The following changes from the 0.6.x series were made.

We are moving over to a unified message center, which is an expansion of the feedback API. We have decided to take the opportunity to clean up the ratings flow API, and simplify how you interact with the SDK in general. Below are detailed changes that have been made to the API, but from a simple perspective, you'll want to:

General setup:

  • Replace

Apptentive.getFeedbackModule().addDataField("username", "Sky Kelsey");

with

Map customData = new HashMap();
customData.put("username", "Sky Kelsey");
Apptentive.setCustomData(customData);
  • Replace Apptentive.getRatingModule().setRatingProvider(new AmazonAppstoreRatingProvider()); with Apptentive.setRatingProvider(new AmazonAppstoreRatingProvider());

To launch feedback:

  • Replace Apptentive.getFeedbackModule().forceShowFeedbackDialog(YourActivity.this); with Apptentive.showMessageCenter(YourActivity.this);.

In ratings:

  • Replace Apptentive.getRatingModule().run(YourActivity.this); with Apptentive.showRatingFlowIfConditionsAreMet(YourActivity.this);
  • Replace Apptentive.getRatingModule().logEvent(); with Apptentive.logSignificantEvent();.