Upgrading to 7.5.0 and above

From SDK 7.5.0, Helpshift SDK is available in the following forms:

  1. Standard SDK - In-app Customer Service

  2. Campaigns-enabled SDK (Proactive In-app Customer Service)

In order to use SDK 7.5.x for your app, Helpshift recommends you to follow the steps, depending on whether you use Campaigns or not and what type of SDK you are already using. If you have questions or feedback, please Contact Us

When upgrading to 7.5.x, please replace all the old files with new files. If you have made changes in the HelpshiftLocalizable.strings or HelpshiftConfig.plist file, please make sure to port over those changes to the new versions.

If you are looking to upgrade from a version older than 7.x, please make sure to go through the Upgrade guides for 6.x, 6.2, 6.0 and 5.x

Upgrade scenarios

Scenario 1 : You currently use Helpshift's default SDK (Example: 7.3.0) but you are not using Helpshift Campaigns feature

Integration-related changes

Manual integration

When you integrate SDK manually, remove all the old SDK files and add the Standard SDK zip file in your app. Integration Guide

Cocoapods

If you are using cocoapods for integration, then there is no need to update or modify any file. Integration Guide

Code-related changes

If your code-base has references to Campaigns code, then the compilation fails after the upgrade. You will need to remove all the references to Campaigns code from the code-base.

Following are the changes:

  1. Remove any HelpshiftCampaigns.h imports.
  2. Remove any HelpshiftAll.h imports.
  3. Remove any HelpshiftInbox.h imports.
  4. Replace [HelpshiftCore initializeWithProvider:[HelpshiftAll sharedInstance]] call with [HelpshiftCore initializeWithProvider:[HelpshiftSupport sharedInstance]] call.

Scenario 2 - You currently use Helpshift's default SDK (Example: 7.3.0) and Helpshift Campaigns feature

Integration-related changes

Manual integration

When you integrate SDK manually, remove all the old SDK files and add the Campaigns-enabled SDK zip file in your app. Integration Guide

Cocoapods

If you are using cocoapods for integration, then replace the 'Helpshift', '7.4.0' from the podfile with 'Helpshift', '7.5.3-withCampaigns'. Integration Guide

Drop iOS 9 support

With version 7.5.0, Helpshift SDK has dropped support for iOS 9. If you wish to keep supporting iOS 9 devices for your apps, please read the KB Article to support Helpshift on older OS versions.

Deprecations

deprecated API New API
HelpshiftCampaigns.inboxDelegate HelpshiftInbox.delegate
HsAddFAQsToDeviceSearch.HsAddFAQsToDeviceSearchOnInstall HsAddFAQsToDeviceSearch.AfterViewingFAQs