Upgrading from 4.x to 5.x

From SDK 5.0.0 release, 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 5.x for your app, Helpshift recommends you to follow the steps, depending upon the usage of Campaigns and the type of SDK. For any queries or feedback, please Contact Us

When upgrading to 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 4.x, please make sure to go through the Upgrade guides for 3.x, 2.8.x, 2.7.0

Upgrade scenarios

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

Integration-related changes

Please remove all the old SDK files and add the Standard SDK zip file in your app. 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 class imports and usage.
  2. If you initialize the SDK in ObjC layer, Replace [HelpshiftCore initializeWithProvider:[HelpshiftAll sharedInstance]] call with [HelpshiftCore initializeWithProvider:[HelpshiftSupport sharedInstance]] call.

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

Integration-related changes

Please remove all the old SDK files and add the Campaigns-enabled SDK zip file in your app. Integration Guide

Moving the SDK configuration from GUI Editor to C# code.

With Unity SDK 5.0.0, we have removed the GUI Configuration Editor for the Helpshift SDK. You can edit all the Helpshift SDK configuration from your C# code. Please find below the C# example codes for all the configuration which were present in the GUI Editor earlier.

Removed SDK Configuration from GUI Editor Replacement C# Code Example Link
unity_ios_install.png Install call from C#
unity_ios_game_object.png https://developers.helpshift.com/unity/sdk-configuration-ios/#unity-game-object
unity_ios_enable-in-app-notification.png https://developers.helpshift.com/unity/sdk-configuration-ios/#enableInAppNotification
unity_ios_enable_fallback_language.png https://developers.helpshift.com/unity/sdk-configuration-ios/#enableDefaultFallbackLanguage
unity_ios_disable_entry_exit_animation.png https://developers.helpshift.com/unity/sdk-configuration-ios/#disableEntryExitAnimations
unity_ios_enable_logging.png https://developers.helpshift.com/unity/sdk-configuration-ios/#enableLogging
unity_ios_enable_inbox_polling.png https://developers.helpshift.com/unity/sdk-configuration-ios/#enableInboxPolling
unity_enable_contact_us.png https://developers.helpshift.com/unity/sdk-configuration-ios/#enable-contact-us
unity_goto_conversation_after_contact.png https://developers.helpshift.com/unity/sdk-configuration-ios/#gotoConversationAfterContactUs
unity_present_full_ipad.png https://developers.helpshift.com/unity/sdk-configuration-ios/#presentFullScreenOniPad
unity_require_email.png https://developers.helpshift.com/unity/sdk-configuration-ios/#requireEmail
unity_hide_name_email.png https://developers.helpshift.com/unity/sdk-configuration-ios/#hideNameAndEmail
unity_prefill_text.png https://developers.helpshift.com/unity/sdk-configuration-ios/#conversationPrefillText
unity_enable_privacy.png https://developers.helpshift.com/unity/sdk-configuration-ios/#enableFullPrivacy
unity_show_search_results.png https://developers.helpshift.com/unity/sdk-configuration-ios/#showSearchOnNewConversation
unity_show_resolution_question.png https://developers.helpshift.com/unity/sdk-configuration-ios/#showConversationResolutionQuestion
unity_show_conversation_info.png https://developers.helpshift.com/unity/sdk-configuration-ios/#showConversationInfoScreen
unity_enable_typing_indicator.png https://developers.helpshift.com/unity/sdk-configuration-ios/#enableTypingIndicator
unity_supported_file_formats.png https://developers.helpshift.com/unity/delegates-ios/#display-attachment

API Cleanup

Removed API Replacement API
HelpshiftSdk.isConversationActive() HelpshiftSdk.checkIfConversationActive()
Reference: https://developers.helpshift.com/unity/tracking-ios/#isConversationActive
HelpshiftSdk.getNotificationCount() HsAddFAQsToDeviceSearch.AfterViewingFAQs
Reference: https://developers.helpshift.com/unity/campaigns-ios/#request-unread-messages-count
Helpshift Delegate API "didReceiveNotificationCount" Helpshift delegate API "didReceiveUnreadMessagesCount"
Reference: https://developers.helpshift.com/unity/delegates-ios/#newmessage-recieved
HelpshiftSdk.install() HelpshiftSdk.install("Reference: https://developers.helpshift.com/unity/getting-started-ios/#initializing
HelpshiftSdk.install("apiKey","domainName","appId") HelpshiftSdk.install("apiKey","domainName","appId", "configDictionary")
Reference: https://developers.helpshift.com/unity/getting-started-ios/#initializing
HelpshiftSdk.showConversation() HelpshiftSdk.showConversation("configDictionary")
Reference: https://developers.helpshift.com/unity/support-tools-ios/#conversation-view
HelpshiftSdk.showConversationWithMeta("configDictionary") HelpshiftSdk.showConversation("configDictionary")
Reference: https://developers.helpshift.com/unity/support-tools-ios/#conversation-view
Meta-data configuration reference: https://developers.helpshift.com/unity/tracking-ios/#metadata
HelpshiftSdk.showFAQSection("sectionPublishId") HelpshiftSdk.showFAQSection("sectionPublishId", "configDictionary");
Reference: https://developers.helpshift.com/unity/support-tools-ios/#faq-section-view
HelpshiftSdk.showFAQSectionWithMeta("sectionPublishId", "configDictionary") HelpshiftSdk.showFAQSection("sectionPublishId", "configDictionary");
Reference: https://developers.helpshift.com/unity/support-tools-ios/#faq-section-view
Meta-data configuration reference: https://developers.helpshift.com/unity/tracking-ios/#metadata
HelpshiftSdk.showSingleFAQ("questionPublishId") HelpshiftSdk.showSingleFAQ("questionPublishId", "configDictionary")
Reference: https://developers.helpshift.com/unity/support-tools-ios/#faq-question-view
HelpshiftSdk.showSingleFAQWithMeta("questionPublishId", "configDictionary") HelpshiftSdk.showSingleFAQ("questionPublishId", "configDictionary")
Reference: https://developers.helpshift.com/unity/support-tools-ios/#faq-question-view
Meta-data configuration reference: https://developers.helpshift.com/unity/tracking-ios/#metadata
HelpshiftSdk.showFAQs() HelpshiftSdk.showFAQs("configDictionary");
Reference: https://developers.helpshift.com/unity/support-tools-ios/#faqs-view
HelpshiftSdk.showFAQsWithMeta("configDictionary") HelpshiftSdk.showFAQs("configDictionary");
Reference: https://developers.helpshift.com/unity/support-tools-ios/#faqs-view
Meta-data configuration reference: https://developers.helpshift.com/unity/tracking-ios/#metadata

Drop iOS 9 support

With version 5.0.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.