Looking for older SDK 3.X docs? Click here →

Release Notes

5.10.1

April 18, 2017

Release Notes:

  • Added new SDK configuration for showing conversation info screen.
  • Fixed getActionTitleColor API returning title instead of title color.

5.10.0

March 31, 2017

Release Notes:

  • Introduced a new API that helps redirect users directly to Conversation on tapping of push notification in cases where the app was killed by the user.
  • Added new SDK configuration debug logging in the SDK for solving Issues during integration.
  • Added an API to check if there is an active conversation.
  • Added a delegate method that lets the app know when a Conversation has ended.
  • Added Inbox Data APIs to retrieve 'action type' and 'action data' for Campaigns action buttons in messages.
  • Made image attachment upload more network-efficient, also added support for GIF type images.
  • Added validation to guard against malformed FAQ and Section IDs.
  • Users can now view their Issue ID for an ongoing Issue by navigating to the Issue Information Screen by tapping the icon on the top-right of the Conversation screen.
  • Added a configuration in HelpshiftConfig.plist to specify extra vertical padding for table view cells.
  • Added a configuration in HelpshiftConfig.plist to hide the label of the back button while Helpshift session is active.
  • Added a configuration in HelpshiftConfig.plist to specify file name for custom font for FAQ body and custom bold font for FAQ title.
  • Added translations for the screenshot tutorial.
  • Replaced UIWebView implementation with WKWebView to display HTML content of an FAQ.
  • Improvements to voice over support.
  • Fixed a bug where row height was not being calculated correctly for FAQ tables.
  • Fixed a bug where a failed message delivery could be re-sent multiple times.
  • Fixed all memory leaks.
  • Fixed an edge case where in some rare cases an Agent message was not visible to the user.
  • Fixed a bug where a user's keyboard was dismissed after 'report new Issue view controller' is dismissed.
  • Fixed a bug where the FAQ view did not use the system default font.
  • Fixed a bug where chat bubble for landscape images was not on the same aspect ratio.
  • Fixed a UI issue where description text could overlap a button in certain cases.
  • Fixed a UI issue where the Helpshift SDK would hide the status bar even if the app displays it.
  • Fixed an issue with the loading spinner for image downloads being shown indefinitely in cases of no network detection.
  • Added missing device names to the device map dictionary.
  • Fixed bug where in some rare cases, conversation resolution question is displayed when an agent sends a follow up request.
  • Fixed a bug that prevented the Close button from functioning correctly in some cases.
  • Fixed a bug where some alert popups could move to a buggy position on screen in cases when SDK was launched on push notifications.
  • Fixed a bug in follow up feature where a follow up request from Agent fails in some valid cases.
  • Fixed a bug where customer could reopen a resolved issue by attaching an image.
  • Fixed a bug where some UI elements were not correctly using the theming options.
  • Fixed an issue where user could launch multiple conversation screens by tapping repeatedly on Contact Us buttons.
  • Fixed a bug where conversation text typed by customer could get deleted in some cases where he attempts to attach an image with it.
  • Fixed a bug where agent name is not shown for follow up request message.
  • Fixed a bug where a user can accept or reject issue resolution multiple times in some cases.
  • Fixed a case where chat screen was relaunched if the user was previously on chat screen and received a support push notification.
  • Fixed a bug where in some rare cases the “Ok, Attach” button was still visible after user attaches a screenshot.

5.9.3

February 6, 2017

Release Notes:

  • Fixed a bug where in rare circumstances FAQs would not load.

5.9.2

February 2, 2017

Release Notes:

  • Fixed a crash when Send Feedback button is tapped on the periodic review reminder alert view.
  • Fixed bug where an empty view controller was shown after quickly tapping the back button twice on the report issue screen or the chat screen.

5.9.1

January 18, 2017

Release Notes:

  • Fix bug where the SDK didn't pick up device language if it is Chinese - Hong Kong (Traditional) on iOS 8.x and iOS 9.x.

5.9.0

January 10, 2017

Release Notes:

  • Added support for setting expiry time to campaign messages.
  • Implemented custom logger to support debug logs.
  • Improved in-app FAQ search by making it faster and memory efficient.
  • Helpshift SDK now supports iOS accessibility features for dynamic type sizes.
  • Fix and issue where FAQ with search tags were not prioritised correctly in the search results.
  • Improved translations for SDK strings.
  • Helpshift SDK now supports two more Chinese dialects: 'Chinese - Hong Kong' and 'Chinese - Singapore'.
  • Fix in-app notifications not received for issue resolution.
  • Fix in-app notifications do not support orientations of the topmost view controller onto which they are shown.
  • Fix in-app notifications rotate even if the app does not support rotation.
  • Fix application version is not retrieved from main bundle.
  • Fix app crashes when attempting to attach a file with no extension.
  • Fix if an UIAlertView with textfield is presented with the app in the landscape mode, it goes beneath the onscreen keyboard.
  • Fix when entering a very long name into the conversation page the name starts to overrun the email section before it gets truncated.
  • Fix campaigns are fetched after a delay if a campaign is pushed through push notification but and user launches the app manually.
  • Fix top level domain of the e-mail address (Issue reporter email) can't take more than 4 letters.
  • Fix SDK asking for push permissions on behalf of the app even if app is registered for silent push.
  • Changed the logic for handling http failures from the helpshift servers.
  • Fix issue where Helpshift SDK used to poll even when push was enabled.
  • Fix FAQs not getting added to Core Spotlight if the configuration is changed from HsAddFaqsToDeviceSearchNever to HsAddFaqsToDeviceSearchOnInstall.
  • Improved Syncing strategy for campaigns data.

5.8.0

September 30, 2016

Release Notes:

  • Added support for iOS 10.
  • Fix for iOS 10: An issue where the App Rating popup presented by Helpshift could move to an incorrect position.
  • Added HelpshiftAPIConfig and HelpshiftInstallConfig APIs to simplify SDK configs.
  • SDK no longer includes the 'carrier name' in metaData if 'enableFullPrivacy' flag is set to true.
  • Push campaigns are now registered on first launch.
  • Fix automatically close Helpshift’s campaign UI in case a deeplink action links back to the same app.
  • Fix memory leak caused by Helpshift SDK holding a strong reference to the host app’s viewController.
  • Fix an issue with Guided Ticket Filing where pressing back button would sometimes take the user to a blank screen.
  • Fix an issue where if an FAQ contains an animated GIF, sometimes the user will get multiple failed messages error.
  • Change the name of campaigns inbox delegate (from notificationDelegate to hsInboxNotificationDelegate) to avoid name conflict with Apple’s private API.
  • Fix an issue where the table row text for a FAQs could be truncated with ‘…’ for some languages.
  • Fix an issue where chat screen could go blank when returning from Suggestions view.
  • Fix as issue where Helpshift logo could sometimes be visible on Chat screen.
  • Updated voice over labels on Single FAQ screen.

5.7.1

August 24, 2016

Release Notes:

  • Fix accessibility VoiceOver labels in the SDK.

5.7.0

August 18, 2016

Release Notes:

  • Support Issue Archival feature which will automatically archive issues which are in Resolved or Rejected state for more than 12 months.
  • Add strict validation for HelpshiftCore's installForApiKey:domainName:appID: API. This API will now throw Install Exception if there are validation issues in the key information.
  • Move the Helpshift's localization files to HsLocalization.bundle file. For instructions on how to customize Helpshift strings, please visit https://developers.helpshift.com/ios/string-customization/
  • Add support for customizing Helpshift themes using a HelpshiftCustomConfig.plist file. For more details, please visit https://developers.helpshift.com/ios/design/
  • Handle corrupt or unsupported file formats in In-App Campaigns.
  • Improve localizations for German, Dutch, Chinese and Korean languages.
  • Fix resource deadlocks in Campaigns code.
  • Fix warnings in Helpshift header files.
  • Fix a bug where user was able to say Yes/No to resolution request multiples times on SDK upgrade.
  • Add support for handling HTML entities in FAQ search.
  • Add support for iOS 10 Beta release.
  • Fix for iOS 10: Crash when navigating to a Single FAQ.
    1. Open FAQ sections (showFAQs:)
    2. Tap any FAQ
    3. User is taken to Single FAQ screen and app crashes.
  • Fix for iOS 10: Crash when an in-app notification is displayed.
    1. File an issue
    2. Exit Helpshift
    3. Reply to ticket from dashboard
    4. An in-app notification is shown and the app crashes.

5.6.2

July 27, 2016

Release Notes:

  • Fix crash in FAQ search if any of the FAQ search tags starts with a special character.

5.6.1

June 3, 2016

Release Notes:

  • Remove duplicates in Localization files.
  • Fix crash in showFAQs API when there is only 1 section with some FAQs.
  • Impact analysis of version 5.6.1 remains same as 5.6.0

5.6.0

May 18, 2016

Release Notes:

  • Show notification to the user when agent resolves a conversation.
  • Send user-id and device-id with every new conversation to facilitate integration of the Support and Campaigns products.
  • Fix bug which caused warnings about setting UI properties from background thread.
  • Add translations for Bengali, Bulgarian, Gujarati, Hindi, Kannada, Latvian, Malayalam, Marathi, Punjabi, Persian, Tamil and Telugu languages.
  • Fix bug which prevented keyboard from dismissing on some UI screens.
  • Fix conversation state mismatch where user is able to click Yes and No multiple times when presented with a resolution question.
  • Improve localization strings according to customer feedback.
  • Added Voice over support in the SDK for improving Accessibility.

  • Impact analysis

5.5.1

April 4, 2016

Release Notes:

  • Fix compiler error when all_load linker flag is enabled.
  • Fix : Remove the CFBundleExectuable key from HsUIResourceBundle.
  • Update French translations.

5.5.0

March 17, 2016

Release Notes:

  • Add support for Inbox functionality and rich in-app campaign messages.
  • Add config option for supporting Guided Issue Filing when user clicks on Contact Us from inside the SDK screens.
  • Fix a bug that prevented config to be fetched after migration. This caused new SDK version to use incorrect values for certain configuration items.
  • Fix a bug that caused text within individual chat bubbles to be scrollable. This prevented the chat screen from scrolling properly.
  • Add support for sending messages read status from the SDK.
  • Reduce init times of the Helpshift SDK by adding async queuing mechanism.
  • Fix API config behaviour for flags not passed in the API.
  • Fix showSingleFaq API call behaviour which caused FAQ to not get updated on migration.
  • Add support for all dialects of Danish and Norwegian languages.

  • Impact analysis

5.3.0

December 16, 2015

Release notes:

  • Add a way for View controller based status bar apps to set Helpshift status bar style.
  • Add support for iPad Slide Over and Split View.
  • Fix an issue where the in-app notification bar appeared in the wrong orientation on some devices.
  • Improve the way copy text features works on chat screen.
  • Fix an issue that caused images on FAQ screen to not load when launched from spotlight or deep-link.

5.2.1

November 9, 2015

Release notes:

  • FIX Sending of screenshots was failing on iOS 9 due to ATS restrictions.
  • FIX Default values being set incorrectly in case the config options dictionary was nil.

5.2.0

November 6, 2015

Release notes:

  • Fix: When using theming via HelpshiftConfig.plist file, there was a bug which prevented setting the navigation button colours.
  • Added support for copy/pasting messages in chat screen. Now you can long-press a message to bring up the copy menu.
  • Updated accessibility strings for some UI elements.
  • Added a flag to disable entry and exit animation for Helpshift screens. Only applicable to the launch and close events of Helpshift Support views. Animations will still be present inside a Helpshift Support session.

5.1.0

October 30, 2015

Release notes:

  • Added feature for Guided issue filing for all support issues created by the end-user.
  • New SDK option for improving ticket deflection. Added option for CONTACT_US_AFTER_MARKING_ANSWER_UNHELPFUL to show contact us only after end user marks a FAQ unhelpful.
  • Added support for reducing gibberish ticket by adding a configurable threshold for all supported language.
  • iOS 9 feature: In-Device search - Now you can make your FAQs searchable with core spotlight.
  • iOS 9 feature: Bitcode distribution - Now the iOS bundle will have a bit code enabled version along in the SDK archive.
  • The Customer Satisfaction survey view is now a part of the messages scroll view. This makes it easier for users of landscape apps to view previous messages.
  • Changed the default value of showConversationResolutionQuestion flag to true.
  • Moved graphical assets location to Xcassets
  • FAQ Search algorithm improvement: Improved the FAQ search relevance threshold for fuzzy match to make it strict.
  • FAQ Search algorithm improvement: Sometimes search term was not highlighted if it was with a prepending or appending punctuation mark
  • FAQ Search algorithm improvement: FAQs were listed twice in search results
  • Added new HelpshifSupport API to replace older Helpshift API

4.15.0

September 25, 2015

Release notes:

  • Added a flag for toggling fallback languages in FAQs to english. In case you have FAQs in multiple languages but do not wish to fallback to English if localisation is missing, set ‘enableDefaultFallbackLanguage’ to ‘no’ in Helpshift’s install call.
  • Fix: Renamed a public method that could cause namespace issue with other libraries.
  • Fix: Fixed a bug that could prevent a database from being created.

4.14.1

September 15, 2015

Release notes:

  • Fix: Localisations on iOS 9.
  • Fix: Sometimes admin attachments do not download on re-installing app or migrating to a newer version.

If your FAQ images are not loading on iOS 9 click here to know what you need to do to fix this.

4.14.0

September 10, 2015

Release notes:

  • Filter FAQs by category tags.
  • Added configurability to the conversation resolution flow by adding flag showConversationResolutionQuestion. See note below for details.
  • Increased the accuracy of free disk space on the device.
  • Added support for 12 new languages: Danish, Slovak, Catalan, Greek, Finnish, Croatian, Malay, Norwegian, Romanian, Swedish, Ukrainian and Hebrew.
  • Changed the default conversation placeholder to "How can we help?"
  • Added error reporting capability for logging and reporting Helpshift crashes on runtime. This allows helpshift to get hold of all crashes and crash details that occurred in production due to Helpshift api or execution in Helpshift flows.
  • By default this is turned on.
  • [Bug fix] FAQ rendering issue.
    • Issue - FAQ was getting clipped before the first fold causing for FAQ text to appear clipped.
    • Cause - This was introduced when with the handling of a crash on older devices (iPhone 4s for UIVewbview).
    • Resolution - We have ensured that the UIWebView rendering happens on the main UI rendering thread.
    • Impact - This issue existed in v4.13 which has now been fixed.
  • Developers can now choose to skip the issue resolution questions (Y/N) by setting the key showConversationResolutionQuestion as No. This will lead the user to the CSAT screen after the issue is resolved by the agent. More details here.
  • Available in Portrait & Landscape
  • Default value for showConversationResolutionQuestion is set to No. If you wish to show the Y/Ns question after the issue is resolved, please set the showConversationResolutionQuestion to Yes
  • We have observed that the error reporting capability does not work if your app already has a crash logger that is not crashalytics.

4.13.0

August 19, 2015

Release notes:

  • Improved ticket avoidance to include the FAQs flows.
  • Added a feature that prevents empty or gibberish tickets from being filed.
  • Added support for two new languages: Polish and Arabic
  • Bug fixes
  • UI fixes

4.12.1

July 17, 2015

Release notes:

  • Add workaround for iOS UIScrollView inconsistency bug.
  • Bug fixes
  • UI fixes

4.12.0

July 10, 2015

Release notes:

  • Fix the bug in handling conversations with special characters in them.
  • Fix the FAQs syncing bug during migrations.
  • Move more code to ARC.
  • Improve the FAQ on device search with Fuzzy matching.
  • Fix iOS 6 compatibility.
  • UI fixes

4.11.1

June 2, 2015

Release notes:

  • Bug fixes

4.11.0

May 26, 2015

Release notes:

  • Ability to change SDK language dynamically.
  • Added fuzzy search for FAQ searches.
  • Search term highlighting for FAQs.
  • Additional navigation bar customizations.
  • Bug fixes.
  • UI fixes.

4.10.2

March 25, 2015

Release notes:

  • Bug fixes
  • UI fixes

4.10.1

March 20, 2015

Release notes:

  • New optional delegate method called when a Helpshift session begins: - (void) helpshiftSessionHasBegun;
  • This is a counterpart to the existing delegate that is called when a Helpshift session ends: - (void) helpshiftSessionHasEnded;
  • New optional delegate method that is called when user complete customer satisfaction survey after issue getting resolved. - (void) userCompletedCustomerSatisfactionSurvey:(NSInteger)rating withFeedback:(NSString *)feedback;
  • Added support for Hungarian, Czech, Slovenian and Traditional Chinese languages.
  • UI fixes
  • Bug fixes

4.10.0

March 4, 2015

Release notes:

  • Allow admins and agents to attach files with replies
  • Allow admins and agents to reopen conversations
  • Added multi-user feature for support conversations
  • Added new delegate methods for conversation updates
  • Bug fixes
  • UI fixes

4.9.1

October 9, 2014

Release notes:

  • Bug fixes

4.9.0

October 7, 2014

Release notes:

  • Added an API option "showSearchOnNewConversation" which when enabled will enhance ticket avoidance by suggesting relevant FAQs to the users before they start a new conversation.
  • Added an API option "enableFullPrivacy" which when enabled will restrict the user from attaching a screenshot and from sending personally identifiable information in meta-data.
  • UI fixes.
  • Bug fixes.

4.8.0

September 16, 2014

Release notes:

  • Full iOS 8 compatibility.
  • Bug fixes.
  • UI fixes.

4.7.0

September 2, 2014

Release notes:

  • Added support for Customer satisfaction survey, which prompts your app users to rate their customer support experience with your agents.
  • Agent names will now be visible in an ongoing conversation.
  • Added a API option, "conversationPrefillText", for prefilling new conversation description.
  • Added a API option, "hideNameAndEmail", for conditionally hiding name and email fields when starting a new conversation.
  • UX improvements for attaching screenshot.
  • Removed FAQ sync status.
  • Added support for deep-links in FAQs.
  • Bug fixes.
  • UI fixes.

4.6.0

July 9, 2014

Release notes:

  • Added a API option "requireEmail" to make emails compulsory or optional in the new conversation form.
  • Added fixes for iOS 8.
  • Added fixes for empty custom metadata.
  • Updated Korean translations.
  • Bug fixes
  • UI fixes

4.5.0

June 6, 2014

Release notes:

  • Optimized FAQ updates. Changes to FAQs in the admin are now updated and shown as soon as the SDK is opened.
  • Users can now directly attach screenshots while submitting new conversation or during an ongoing conversation.
  • New options for enableContactUs flag for ticket avoidance: ALWAYS, AFTER_VIEWING_FAQS and NEVER
  • setName:andEmail: API can now clear name and email if nil is passed for both.
  • Automatic app rating reminder is now available alongside the manual app rating API.
  • Bug fixes
  • UI fixes

4.4.0

April 30, 2014

Release notes:

  • Added new app rating API (showAlertToRateAppWithURL:withCompletionBlock:). Automatic review request is now removed in this release.
  • Conversation text and message reply text are now buffered, if users leave the screen while typing is in progress.
  • Improved message resolution interaction.
  • Added a new option in skinning plist for cell selection color.
  • Improved on some skinning bugs.
  • Improved on new conversation submission warnings.
  • Improved on FAQ helpful/unhelpful UI interaction.
  • Various bug fixes (crashes related to migration).
  • UI fixes

4.3.1

March 12, 2014

Release notes:

  • Critical migration bug fix that caused a conversation related crash

4.3.0

March 7, 2014

Release notes:

  • Added method pauseDisplayOfInAppNotification: to pause/resume display of in-app notifications
  • Added optional delegate method didReceiveInAppNotificationWithMessageCount: for in-app notifications
  • Added Dutch translations
  • Potrait only/Landscape only rotation now supported in the SDK, if app supports the same
  • New inapp notification delegate method
  • Review request in conversation can now be customized via localized strings.
  • Bug fixes
  • UI fixes

4.2.1

February 23, 2014

Release notes:

  • Fixed some critical crashes (Crash during screenshot attach, FAQ mark helpful/unhelpful and others).

4.2.0

February 03, 2014

Release notes:

  • Added support for fullscreen and formsheet modal presentation styles on iPad
  • Added Turkish translations
  • library now contains a 64-bit simulator slice
  • support for custom metadata in API options
  • Bug fixes
  • UI fixes

4.1.0

December 23, 2013

Release notes:

  • Conversation forwarding feature added to SDK
  • New Rate/Review & Feedback feature
  • Now using CFBundleShortVersionString instead of CFBundleVersion for app version
  • Added support for background image in HelpshiftConfig.plist
  • Fixed bugs related to getNotificationCountRemote being called from inside helpshiftSessionHasEnded
  • Improved UX for resolution rejected by user for resolved conversations
  • Bug fixes
  • UI fixes
  • Changes to HelpshiftLocalizable.strings

4.0.0

December 4, 2013

Release notes:

  • Multiple issues and inbox is no longer supported
  • The conversation interface has been unified into a single channel
  • New API calls for support tools and install method.
  • When FAQ is marked unhelpful, users can contact you to tell you why
  • Moved helpshift db from Documents/ folder to Library/ folder
  • New strings for localizations
  • Bug fixes
  • UI fixes

Older release notes

Release notes pre v4.0.0 can be found in SDK 3.x docs.