From SDK 7.5.0, Helpshift SDK is available in the following forms:
Standard SDK - In-app Customer Service
Campaigns-enabled SDK (Proactive In-app Customer Service)
In order to use SDK 7.5.0 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 7.x, please make sure to go through the upgrade guides for 6.x and 4.x
Download the "Standard SDK" from here.
You will need to update integration code to use "Support.getInstance()" in the Helpshift initialisation call.
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:
Core.install(All.getInstance())
call with Core.install(Support.getInstance())
Campaigns
apis from codeimport com.helpshift.Core; import com.helpshift.support.Support; import com.helpshift.InstallConfig; import com.helpshift.exceptions.InstallException; ... ... InstallConfig installConfig = new InstallConfig.Builder().build(); ... Core.init(Support.getInstance()); try { Core.install(this, "YOUR_API_KEY", "YOUR_DOMAIN_NAME", "YOUR_APP_ID", installConfig); } catch (InstallException e) { Log.e(TAG, "invalid install credentials : ", e); }
import com.helpshift.Core; import com.helpshift.support.Support; ... ... HashMap config = new HashMap(); ... Core.init(Support.getInstance()); try { Core.install(this, "YOUR_API_KEY", "YOUR_DOMAIN_NAME", "YOUR_APP_ID", config); } catch (InstallException e) { Log.e(TAG, "invalid install credentials : ", e); }
You will need to follow the integration guide for Campaigns-enabled SDK here.
Update the declaration of Helpshift SDK dependency i.e implementation 'com.helpshift:android-helpshift-aar:7.4.0'
to
implementation 'com.helpshift:android-helpshift-withCampaigns-aar:7.5.0'
No code changes required.
android { defaultConfig { ... resConfigs "en", "fr" } }