Skip to main content

Upgrading from 4.x to 5.x

Important
Helpshift’s Legacy SDKs (SDK Version <=7.x.x) reached their end of life on 31 Dec 2022, and end of support on 31 March 2023. Please upgrade to the Latest SDKif you haven't already.

Upgrading from 4.x to 5.x

Important

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

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

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.

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 EditorReplacement C# Code Example Link
unity_ios_install.pngInstall call from C#
unity_ios_game_object.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#unity-game-object
unity_ios_enable-in-app-notification.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#enableInAppNotification
unity_ios_enable_fallback_language.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#enableDefaultFallbackLanguage
unity_ios_disable_entry_exit_animation.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#disableEntryExitAnimations
unity_ios_enable_logging.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#enableLogging
unity_ios_enable_inbox_polling.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#enableInboxPolling
unity_enable_contact_us.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#enable-contact-us
unity_goto_conversation_after_contact.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#gotoConversationAfterContactUs
unity_present_full_ipad.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#presentFullScreenOniPad
unity_require_email.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#requireEmail
unity_hide_name_email.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#hideNameAndEmail
unity_prefill_text.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#conversationPrefillText
unity_enable_privacy.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#enableFullPrivacy
unity_show_search_results.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#showSearchOnNewConversation
unity_show_resolution_question.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#showConversationResolutionQuestion
unity_show_conversation_info.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#showConversationInfoScreen
unity_enable_typing_indicator.pnghttps://developers.helpshift.com/unity/sdk-configuration-ios#enableTypingIndicator
unity_supported_file_formats.pnghttps://developers.helpshift.com/unity/delegates-ios#display-attachment

API Cleanup​

Removed APIReplacement 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("<apiKey","domainName","<appId", "configDictionary")
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.