Upgrading to 5.x

From v5.0.0, Helpshift SDK is available in the following forms:

  1. Standard SDK - In-app Customer Service (Support only)

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

In order to use SDK 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

If you are looking to upgrade from a version older than 4.x, Make sure to go through the upgrade guides for 1.6.x, 1.7.x and 3.x.

Upgrade scenarios

You currently use Helpshift's SDK (Example: 4.1.0) but you are not using Helpshift Campaigns feature

Integration-related changes

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

Code-related changes

The following changes ship by default in SDK v5.0.0. Save any necessary modifications made in helpshift files.

If your Codebase 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 Codebase. Following are the changes:

  • Remove any HelpshiftCampaigns.h includes.
  • Remove any HelpshiftAll.h includes.
  • Remove any HelpshiftCocos2dxCampaignsDelegate.h includes.
  • Replace [HelpshiftCore initializeWithProvider:[HelpshiftAll sharedInstance]] call with [HelpshiftCore initializeWithProvider:[HelpshiftSupport sharedInstance]] call.

You currently use Helpshift's SDK (Example: 4.1.0) and use Helpshift Campaigns feature

Integration-related changes

  • When you integrate SDK manually, remove all the old SDK files and add the Campaigns-enabled SDK files to your app.
  • You will need to import HelpshiftCocos2dxCampaigns.h in order to use Campaigns API.
  • Use HelpshiftCocos2dxCampaigns namespace instead of HelpshiftCocos2dx to make Campaigns API calls. For example :

    Update

    HelpshiftCocos2dx::showInbox();
    

    To

    HelpshiftCocos2dxCampaigns::showInbox();