Release Notes

Release Notes:

iOS

• Updated to iOS SDK version 7.6.3. View
• Helpshift iOS SDK is now fully compatible with iOS 13. We recommend you to use the latest SDK since apps using Older SDKs (<=5.0 version ) will see the following degraded behavior for in-app support when run on iOS 13:
  • End-users will not be able to send attachment
  • Inconsistent dark/light color elements in SDK, when you turn ON the OS level dark mode
  • Difficulty in navigating or reading through FAQs because of the UX changes introduced in iOS 13
  • Gestures to open and close the bot options in list picker UI will not work properly
• Added Dark Mode support for apps running on iOS 13. View
• Added API for switching the Helpshift SDK theme at runtime. View
• Added a new high contrast theme for Dark Mode.
• Added support for customizing the font and colors of the in-app notification banner elements. View
• Added Voice-over support for FAQ search results and Form based issue filing.
• Added a character limit of 100,000 for every user message to ensure a smooth user experience.
• Changed the rate-limiting algorithm for requestUnreadMessagesCount API to fetch the latest count from Helpshift servers, to handle the case of the delayed push being received in the app.
• Disabled automatic detection of numbers as phone numbers in FAQ view. If you want to add telephone number links, please add URLs in the FAQ editor with tel:
• Fixed a bug where the prefill text shown in the reply box via conversationPrefillText API config fails to update if changed in conversational issue filing mode.
• Fixed a bug where the user fails to view customContactUs flows if they try to contact support from the footer in the FAQ screen.
• Fixed a bug where In-app notification for resolution request was shown twice to the user if the resolution question setting was turned off.
• Fixed a bug where duplicate issues were being created in some network edge cases.
• Fixed a bug where push notifications fail to deliver to iOS 13 devices if the host app is built with Xcode 11.
• Fixed a crash that would occur if New Issue Automation assigns the issue to a custom bot, and the first bot step presents more than 5 options to the end-user.
• Fixed a rare crash that would occur sometimes when a user loads conversation history and at the same time closes the chat screen.
• Fixed a bug where the Dynamic Forms screen fails to open as a full screen on iOS 13 devices.
• Fixed a bug where API config passed to showDynamicForms API was being ignored.
• Fixed a bug which caused option pills to reload when navigated in VoiceOver mode.
• Fixed a bug where answer bot messages were not redacted in the current open conversation screen but were updated on re-opening the conversation.

Android

• Updated to Android SDK version: v7.6.3
• The delegate displayAttachmentFile will now be triggered with a Uri file path instead of a normal file path on Android 10 & above. For more details, refer here.
• Added new themes to support Dark Mode.
• Added new API for changing the Helpshift SDK theme at runtime.
• Added support for customizing additional icons in the SDK. To view the updated list of customizable icons, refer here.
• Added a character limit of 100,000 on user messages.
• Fixed a crash which occurred when a user opens the chat screen containing an attachment message and hardware acceleration was explicitly disabled in the app.
• Fixed a bug where a blank screen was shown instead of the FAQ content when opened through Answer Bot for some languages.
• Fixed a bug where the keyboard input type remains the same when a number/date input bot-message was interrupted by an agent.
• Fixed a bug where the SDK UI was being displayed in the cutout area on some android phones with a notch.
• Updated the rate limiting algorithm for getNotificationCount API. The API will allow one call when the user closes the conversation screen. This is to accommodate any custom requirements for showing the notification count in the app.
• By default, hardware acceleration is now explicitly enabled in the manifest file for the SDK's ParentActivity. This prevents rendering issues of WebView on Android OS 5.1.
• Fixed an edge case crash which occurred when the user files an issue for the first time and user authentication failed.
• Fixed a bug where the prefill text shown in the reply box via conversationPrefillText API config wasn't being updated if changed in conversational issue filing mode.
• Fixed an edge case bug where duplicate issues were being created in bad network scenarios.
• Fixed an edge case bug where the typing indicator was shown indefinitely when the user replies to a bot.
• Fixed a bug where the Answer bot FAQ suggestions message wasn't shown as redacted while the user was on the chat screen.

v5.1.0

August 26th, 2019

Release Notes:

iOS

• Updated to iOS SDK version 7.6.1. View
• Added support for iOS 13 Beta 4 and Xcode 11. Apps using Older SDKs (version <=5.0 version ) will see the following degraded behavior for in-app support when run on iOS 13 beta:
  • End-users will not be able to send attachment
  • Inconsistent dark/light color elements in SDK, when you turn ON the OS level dark mode
  • Difficulty in navigating or reading through FAQs because of the UX changes introduced in iOS 13
  • Gestures to open and close the bot options in list picker UI will not work properly
• Removed CoreLocation framework dependency
• Added support for messages and attachment redaction for SDKs. If you redact messages and attachments from Agent desktop, they will be redacted from the device too.
• Fixed a bug, where the user did not receive the agent response. It occurred when the user was on chat screen and device got locked, and after unlocking the device, intermittently the user did not receive the Agent messages. However, when you close and reopen the chat screen, user was able to receive all the Agent messages.
• Fixed a bug, where sometimes, SDK configuration set on dashboard would not show on app launch.
• Fixed a bug where map and filter named methods of NSArray category were conflicting with the host app's categories.
• Fixed a bug where, in some network edge cases, the user was able to retry an older message which is not part of the running bot.
• Fixed a bug where the user couldn't send the CSAT rating for a resolved conversation if conversation history was ON and if there was a login change between users.
• Fixed a bug where the previously sent images were not shown on chat screen immediately after a login change. However if the user closed and revisited the chat screen, the images would load correctly.
• Fixed a bug where, in some network edge cases, the user fails to send or receive messages if a bot was interrupted by another bot.
• Fixed a bug, where conversationEnded delegate was not called for the agent rejected conversation unless user exits the chat screen.
• Fixed a bug where the user message was sent twice in an edge case when Send button was tapped multiple times
• Improved the loading of large FAQs.
• Fixed a crash which occurred when Photo gallery was opened in Landscape only orientation.

Android

• Updated to Android SDK version 7.6.0. View
• Added support for targeting Android Q Beta 5 which includes support for the new scoped storage changes. Apps using Older SDKs (<=7.5 version ) will see the following degraded behavior for Helpshift messaging experience when they target Android Q beta:
  • End-users will not be able to send attachments.
  • End-user will not be able to view attachments/files sent by Agents.
• Added support for messages and attachment redaction for SDKs. Messages and attachments which are redacted from the Agent dashboard will be removed from user's devices too.
• Fixed an edge case crash that would occur when the chat screen is opened and an already downloaded attachment is not accessible by the SDK.
• Fixed an edge case crash on opening any SDK screen when conflicting versions of support libraries are used.
• Fixed an edge case crash which occurred on sending a message when both reply box and options pills would be visible at the same time.
• Fixed an ANR which occurs in an edge case when searching through an FAQ which has a large number of media elements.
• Fixed an edge case crash that would occur when user swipes through the FAQ sections view pager very quickly and "Don't keep activities" from Developer Options is turned ON.
• Fixed a bug where the user incorrectly sees the authentication failure screen instead of the conversation if login API is used without email or userID and User Identity verification is enabled.
• Fixed a bug where, in some network edge cases, the user wasn't able to send or receive messages if a bot was interrupted by another bot.
• Fixed a bug where, in some network edge cases, user was not able to see the messages sent by the agent in the messaging experience.
• Fixed a bug where the embedded media content was not visible in an FAQ on Android P and above.
• Fixed a bug where the deep link to an FAQ was not working from another FAQ screen.
• Fixed a bug where the image attachment wasn't visible on the chat screen when an issue is filed with an attachment via Form based issue filing flow.
• Fixed a bug where the user couldn't send the CSAT rating for a resolved conversation if conversation history was ON and if there was a login change between users.
• Fixed a bug where the dot character at the end of a message (if present) would also be part of the link.
• Fixed a bug where, in some network edge cases, the user was able to retry an older message which is not part of the running bot.
• Fixed a bug where updateMetaData delegate was called instead of didReceiveInAppNotificationCount delegate.
• Fixed a bug where requestUnreadMessagesCount delegate was not called in case of failure.
• Fixed a crash where an app was showing a notification after upgrade without opening the app.
• Fixes an edge case crash that would occur on authentication failure.
• Removed targetSdkVersion from Helpshift SDK.

v5.0.2

May 17th, 2019

Release Notes:

iOS

• Updated to iOS SDK version 7.5.3. View

v5.0.1

May 8th, 2019

Release Notes:

iOS

• Fixed a crash that occurs when you use the closeHelpshiftSupportSession API

v5.0.0

April 25th, 2019

Release Notes:

Common Updates

• Introduced a new rich element for automation bots to let users choose from a list of selectable options if the number of options is more than 5.
• Users can modify their CSAT rating during the Feedback phase before submitting them. For more details, see here.
• Added a configuration option for setting the minimum number of characters required, before you can send a message in conversational experience. For more details, see the android and iOS release notes.
• Added configuration option, conversationPrefillText, for pre-filling new conversation's description in the conversational issue filing experience. For more details, see here.
• Removed GUI Editor for install keys and SDK configurations. For more details, refer migration guilde for iOS and migration guide for android
• Changed the rate-limiting algorithm for requestUnreadMessagesCount API to fetch the latest count from Helpshift servers, to handle the case of the delayed push being received in the app.

iOS

• Updated to iOS SDK version 7.5.2. View
• Added a new API enableTestingMode to enable testing mode in the SDK. For more details, see
• When testing mode is enabled, public APIs in HelpshiftSdk and HelpshfitCampaigns will now throw ExceptionInInitializerError exception if the API is called before HelpshiftSdk.Install API.
• Updated behavior of opening Links from the FAQ view inside of Helpshift. The Helpshift session will not close when opening external links.
• Added a new API for closing the active Helpshift session which now accepts a completion handler. For more details, see here.
• Added a configuration option, IssueMinimumDescriptionLength for setting the minimum number of characters required, before you can send a message in conversational experience. For more details, see the documentation
• From this release, Helpshift SDK will work for users on iOS 10,11 and 12. Here's how you could continue using Helpshift for your iOS 9 users. View
• Fixed a bug where tapping on attachment file in chat screen would crash the application if supportedFileFormats was set empty.
• Fixed a bug where the conversation wasn't closed if the user clicked on NO in the resolution question and exited the chat screen in some cases.
• Fixed a rare crash occurring due to resource deadlock during SDK initialization.
• Fixed a bug where deep links which opened FAQ screens in Agent replies failed to open in the app.
• Fixed a bug in the checkIfConversationActive API. If the conversation resolution question is off, this API would incorrectly return true until the chat screen is opened.
• Fixed a bug where blank screen was sometimes shown if conversation creation failed.
• Fixed a rare bug in the Form based issue filing experience in which the user was able to create multiple open conversations.
• Fixed a crash that occurred due to nil device ID returned by iOS APIs. Stack trace of the crash :
• Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: [__NSPlaceholderDictionary initWithObjects:forKeys:count:]: attempt to insert nil object from objects[0] [HsCampaignsInboxSyncController getRequestData]
• Fixed duplicate symbol linker errors when -ObjC linker flag is on.
• Fixed a bug where failed analytics events requests were never retried.
• Fixed a bug where close button was missing from nested dynamic form screens.
• Fixed a bug where user's name was visible as author for "What else can we help you with?" agent message.
• Fixed a bug, where a user could attach a screenshot twice by quickly tapping the Send button in the Preview screen multiple times.
• If there are no FAQs present in the SDK, FAQ search bar is disabled.
• Fixed a bug where agent nickname showed up as (null) on the SDK chat screen if it wasn't set on the admin dashboard.
• Fixed a bug where loading older messages would fail under an edge case.
• Fixed a UI issue where calling UIAppearance proxy API to invoke setContentInsetAdjustmentBehavior from host app was affecting some of SDK's scroll views.
• Fixed a bug where, under rare circumstances, retrying failed bot message could lead to user getting stuck on the chat screen with infinitely loading Typing Awareness Indicator.
• Fixed a rare crash that occurred when the app was brought to foreground.
• Deprecated the HsAddFaqsToDeviceSearchOnInstall enum value from the addFaqsToDeviceSearch option.

Android

• Updated to Android SDK version 7.5.0. View
• Added a configuration option, hs__issue_description_min_chars for setting the minimum number of characters required before you can send a message in conversational experience. For more details, refer here.
• In debug mode, public APIs in Support, Campaigns and Core would log an error if the API is called before Core#install API.
• Removed in-built dex support. Check out the migration guide.
• Removed in-built GCM push notification support. Check out the migration guide.
• Fixed a crash which occurs when isConversationActive API was called when the conversation is resolved and the user rejected the conversation resolution question.
• Prevented a crash due to Android OS 8.0 bug when using the screenOrientation configuration flag in the Install call.
• Fixed a bug where, in some network edge cases, SDK fails to download an image.
• Fixed a bug where the user could reply to a previously assigned bot in the conversation.
• Fixed a bug where in some network edge cases, the user can reply to a conversation while waiting for the next bot message.
• Fixed a bug where the "Message Deleted" message text was getting clipped off from the right when using a custom font.
• Fixed a bug where sometimes other messages were shown incorrectly in italics, if a message was redacted.
• Fixed a bug where the notificationSound configuration flag in the Install call wouldn't work correctly on Android OS 7.0 & above.
• Fixed a bug, where in some rare scenarios, agent messages were not received by the SDK.
• Fixed a bug, where in some rare scenarios, a user could not reply to a conversation if custom bot was assigned to it.
• Fixed a bug, where in some scenarios, conversations weren't closed when the user rejected the resolution question and closed the conversation screen.
• Fixed a bug, where sometimes, the getNotificationCount API would incorrectly return -1 when it should be 0.
• Fixed a bug where the getNotificationCount API would incorrectly return 0 if Conversation History was enabled and conversation was resolved/rejected.
• Fixed a bug where the isConversationActive API would incorrectly return true until the chat screen is opened if config for conversation resolution question is disabled.
• Fixed a rare bug in the Form based issue filing experience in which the user was able to create multiple open conversations.
• Fixed some memory leaks caused by launching of Conversation and FAQ UI.
• Fixed a bug where the hyperlinks in CJK language messages were not showing correctly if the message text contained full-width parentheses.
• Fixed a bug where an extra comma along side the date was displayed on the chat screen if agent name was empty.

v4.1.0

October 22, 2018

Release Notes:

Common Updates

• Introduced support for Custom Bots.
• Introduced functionality for end users to view their past conversations. This can be managed via an Admin toggle available in the Dashboard on the App settings > In-app SDK configuration page. Review Review this FAQ to get started. to get started.
• Introduced functionality for Admins to prevent users from being able to attach files in conversations. This can be managed via an Admin toggle available in the Dashboard on the app settings > the In-app SDK configuration page.
• Introduced functionality for end users to be able to tap on an attachment that they sent in order to view the image.
• Added Campaigns delegate callbacks for tracking when a Helpshift campaigns session begins and when a session ends. Refer here (/unity/campaigns-android/#helpshift-campaigns-delegate)
• Fixed a bug where Form based Issue filing was not considered the default until the app configuration was received.

iOS

• Added iOS 12 support.
• Updated to iOS SDK version v7.3.0 View
• Added new customization keys: Details are available here
  • Selectable Option Text Color: The color of the text in option pills of the Answer Bot or skip button.
  • Selectable Option Background Color: The background color of the option pills of the Answer Bot or skip button.
  • Selectable Option Border Color: The border color of the option pills of the Answer Bot or skip button.
  • Field Background color: The background color of the reply field.
  • Field border color: The border color of the reply field.
• Removed the selectable option color customization key. Please use the latest plist with the updated keys if you plan to customize the Helpshift UI.
• Fixed a bug where Custom Bot options were only partially rendered in the chat screen.
• Fixed a bug where the new conversation button was shown along with the reply box.
• Fixed a bug where the conversation screen was not scrolling to the bottom when the option pills were rendered.
• Fixed a bug where the conversation would be closed when the chat screen was partially slid from the left.
• Fixed a bug where the greeting message text was appended whenever the chat screen was partially slid from the left.
• Fixed a bug where the app would crash when the chat screen was partially slid from the left after the user had tapped on the new conversation button.
• Fixed a bug where some Custom Bots pills were not rendered on migration.
• Fixed a bug where the reply box was not shown when a New Issue Automation was enabled with Custom Bots and an action set to resolve the Issue.
• Fixed a bug where the new conversation button was not shown after the user had selected one of the options offered by Answer Bot.
• Fixed a bug where the app would crash after the chat screen was scrolled while the user was in the process of selecting a Custom Bot option pill.
• Fixed a bug where Admin attachments were not displayed in the chat screen when a screenshot request was sent with an attachment.
• Fixed a bug where the app would crash after the user had tapped on the new conversation button when conversations history and a greeting message were both disabled.
• Improved the alignment of the pill options and the skip button.
• Fixed a bug where the Answer Bot option pills were still visible when they weren't supposed to be in some edge cases.
• Fixed a bug where the user attachment button was not showing in the chat screen after a user had rejected the resolution question.
• Fixed bug where the new conversation button would jump up when the orientation was changed from landscape to portrait.
• Fixed an edge case bug where, if the end user sent an image attachment at the same time that the Agent rejected the Issue, the Issue would* remain open on the end user side.
• Fixed a crash that would occur on 32 bit devices when the user selected a date in response to a Custom Bot.
• Fixed a crash that would occur when accessing a dictionary in a multithreaded environment:
  • Stack trace: [__NSDictionaryM setObject:forKey:] [HsIOSNetworkRequestDAO storeEtag:forRoute:]
• Fixed a bug where the system kept the form-based Issue filing experience as the default if the Conversational Filing configuration from the Dashboard was not known to the SDK yet.
• Fixed a bug where the SDK was incorrectly reporting the build number as the application version while filing the Issue.
• Fixed a bug where image attachments sent by an end user were not re-fetched after they had logged out and logged back in.
• Fixed a bug where image drafts were lost in the form-based Issue filing experience when the user visited suggested FAQs.
• Fixed a bug where image attachments sent by the end user were uploaded twice when network timeout errors occurred.
• Fixed a bug where the SDK was not throwing the InstallException in cases where wrong install credentials were provided.
• Fixed a bug where the name field was not being updated when the same user logged in with a different name.
• Fixed a bug where the dark theme was incorrectly displayed on iPhoneX devices in the FAQ detail screen bottom view.
• Fixed a bug where the status bar color property was not reflected correctly the first time that the screen was launched.
• Fixed a bug where the send button image theme could not be edited.
• Fixed a bug where the SDK was not considering the current push permission status with regards to starting and stopping the poller.
• Fixed a bug where FAQ search results were not being highlighted for CJK languages.
• Fixed a bug where pending notifications for a closed Issue were taking the user to the chat screen of the closed Issue even after the user had already created a new Issue.
• Fixed a crash that would occur occasionally while retrying the failed network requests: Stacktrace: objc_class::demangledName(bool) NSStringFromClass +[HSConstants queueNameForClass:]
• Fixed a crash in database operations: Stacktrace: __hs_db_worker_queue +[HsDbUtil pathForDatabaseName:] +[HsDbUtil openDb:] + 4342041624
• Fixed a bug where not all of the options in an options list submitted by Custom Bot would appear the first time if the app was in landscape mode. Selecting an option in this partially rendered list would crash the application.

Android

• Updated to Android SDK version: v7.3.0
• Introduced support for Android P.
• Fix a crash happening when trying to send metadata in a Helpshift FAQs or conversation API.
• Fixed a bug where the Campaigns poller was not stopped when the app is in the background.
• Fixed a bug where a duplicate attachment was sent again if the user turned off the internet while sending was in progress.
• Fixed a bug where the name field was not updated if the same user logged in again with a different name.
• Fixed a bug where multiple taps on a button would open up multiple FAQ screens.
• Fixed an edge case bug where the typing indicator was shown indefinitely during network connectivity problems.
• Fixed an edge case bug where, if the end user sent an image attachment at the same time that the Agent rejected the Issue, the Issue would remain open on the end user side.
• Fixed a bug where MetadataCallable was being called twice whenever an Issue was created.
• Fixed a bug where the typing indicator would show infinitely and the user was unable to send new messages on the chat screen.
• Fixed an ANR error which would occur sometimes when the Campaigns' addProperty API was called after the login API.
• Fixed a NullPointerException crash that would occur when the user tried to access the Android System Services.
• Fixed an edge case where a NullPointerException crash would occur when an end user tried to exit the chat screen while a view animation was running.
• Fixed a bug where the date header view would show up multiple times in the chat screen when the device was in daylight savings mode.
• Fixed an edge case bug where the typing indicator would not show when a Bot was running.
• Fixed a bug where the search icon would be missing on the FAQ screen if the "Don't keep activities" developer option was on.
• Fixed a bug where enableTypingIndicator config was not working when starting Conversation screen with HelpshiftSdk.showConversation(configDictionary) api.

v4.0.1

July 17, 2018

Release Notes:

Android

• Fixed an edge case crash that would occur due to ConcurrentModificationException when initializing the Helpshift SDK.
• Fixed a crash that would occur on receiving a push notification when application is not running.

v4.0.0

May 24, 2018

Release Notes:

Common Updates

• Applications are now required to build with Unity 5.5 or above.
• Introduced new updates to the in-app messaging experience. Here's our guide on how to onboard to the new experience.
• Introduced a new and enhanced Login API for name, email, user identifier for your end users.
• Introduced the ability to use the 'Email' field as a means of identifying users, so that email addresses don't have to be passed to the 'UserID' field.
• Introduced 'userauthtoken', which is an HMAC digest used to ensure that the requests are coming from an authentic source (and not a malicious 3rd party). Refer here.
• Introduced Answer Bot and Identity Bot for in-app messaging SDKs.
• Deprecated the setNameAndEmail(), setUserIdentifier() and the existing login() APIs. Please use the new Login API. Link
• Deprecated the configurations conversationPrefillText, requireEmail, hideNameAndEmail, goToConversationAfterContactUs, showSearchOnNewConversation, enableTypingIndicator along with the Form-based Issue filing experience. All the details are mentioned here.
• Changed the default value of showConversationResolutionQuestion to false and made it customizable from the app settings Dashboard.
• Fixed cases where multiple Issues can be created or duplicate messages can be sent from the SDK in case of client network errors.

iOS

• Updated to iOS SDK version: v7.0.1
• Fixed a bug where automatic retry of network requests was not working in case of failures.
• Fixed a bug where FAQs did not load for some users upgrading to 7.0.0.
• Fixed a crash in case a user replies to a Rejected conversation.
• Fixed a rare bug where user might get stuck in pre-issue state.
• Fixed a bug where 'didReceiveInAppNotification' delegate was not called in some cases.
• Fixed a bug where user would see a blank screen when calling showConversation API.
• Fixed CFBundleExecutable key issue in bundles.
• Fixed a bug where pre-issue might be reset in case of app reinstall.
• Fixed a bug where in some cases badge count did not update on FAQ screens.
• Fixed cases where multiple Issues can be created or duplicate messages can be sent from the SDK in case of client network errors.
• Fixed a bug where FAQ search keywords specified on the Dashboard were not picked up by the SDK if they contained capital letters.
• Fixed a bug where users wouldn't receive push notifications if the push token syncing failed.
• Fixed a bug where sometimes the SDK would keep making network requests if the host app is executing a background operation.
• Fixed a bug where, on the Issue filing screen, a deleted description draft would reappear after attaching the screenshot.
• Fixed a bug where the 'Contact Us' button was not visible if the FAQ or Section title was too large.
• Fixed a bug where the bottom half of the in-app notification banner was not tappable on an iPhone X.
• Fixed a bug where the background of the table view when presenting FAQ search results was not styled properly in Dark theme.
• Fixed a bug where sometimes a chat screen will launch automatically when multiple in-app notifications were received at the same time.
• Fixed a bug where sometime users were able to give a CSAT rating after they had reject the resolution request.
• Fixed a bug where the users' device was shown as an iPhone 7 instead of an iPhone 7 plus.
• Fixed a bug where user engagement analytics were not properly captured for Campaigns push notifications.
• Fixed a bug where rich push notification actions were not working in Campaigns push notifications if the UNNotification framework was used.
• Fixed a bug where the badge count for unread messages on the FAQ screen was incorrect if the Issue was resolved and the app was killed and re-opened.
• Fixed an issue where the SDK was throwing and catching exceptions while the device is offline, making the offline debugging harder for developers.
• Fixed a crash in database operations.
• Stacktrace: thread #4, queue = 'com.helpshift.HSIssuesPersistentStorage', stop reason = EXC_BAD_ACCESS (code=1, address=0x74786574)
• Fixed a crash which would sometime occur when sanitizing the user name string.
• Stacktrace: NSInvalidArgumentException
  • [HSProfile initWithServerIdentifier:identifier:name:email:userId:deviceId:andLastSeenAt:isSynced:]
• Fixed a crash which would occur when syncing device data for Campaigns:
  • Stacktrace: NSInvalidArgumentException [HsDeviceController makeHSRequestForProperties:]

Android

• Enhanced UI and support for voiceover.
• Fixed multiple SQLite database access errors by optimizing our data reads and writes.
• Fixed a NullPointerException when clicked on “Done" from a FAQ from search suggestions and if conversationPrefillText was also set.
• Fixed an edge case where messages were not being sent in Issues from the SDK.
• Fixed a bug where the badge count for unread messages on the FAQ screen was incorrect if the Issue was resolved and the app was killed & re-opened.
• Fixed a bug where image attachment does not work when the app doesn’t have READ_EXTERNAL_STORAGE permission and when the user tries attaching an image and clicks on the 'cancel' button.
• Fixed a rare bug where the user is stuck on a conversation due to race condition in network calls.
• customContactUsFlows is now an unsupported config for the showConversation() & getConversationFragment() APIs.

v3.0.0

December 6, 2017

Release Notes:

Common Updates

• Applications are now required to build with Unity 5.3 or above. If you have a project with Unity version prior to 5.3, you could use the build mentioned here.

iOS

• Updated to iOS SDK version: v6.4.0
• Added support for iPhone X.
• Applications are now required to build with Xcode 9 so that layouts work correctly across all supported iOS versions. If you have a project with Unity version prior to 5.3 or Xcode 8, you could use the build mentioned here.
• Added support for UNNotifications framework for push notifications. View
• Improved the accessibility behavior for the following UI elements:
  • Resolution Request view
  • "Start a new conversation" button
  • Customer Satisfaction Survey flow
  • Failed message indicator view
  • "Screenshot Request" message
  • "Review Request" message
  • Automation reply message
  • Attachment message
• Improved Italian translation for "Email (optional)" string.
• Fixed a crash in the Campaigns login API .
  • Stack trace: [HsSwitchUserController getRequestData] setObjectForKey - object cannot be nil (key: uid)
• Fixed a crash in the SDK migration flow.
  • Stack trace: setObjectForKey: object cannot be nil (key: profile-id)
• Fixed a crash in the Campaigns property syncing.
  • Stack trace: Exception: NSInvalidArgumentException in -[HsUserModel setSyncStatus:forProperties:]
• Fixed a crash which would occur when the showDynamicFormOnViewController:withTitle:andFlows:withConfig: API was called.
• Fixed a bug where the chat screen would automatically open if the control center or notification tray was open at the time of push notification arrival.
• Fixed an edge case bug where users would see a blank chat screen if they filed a new conversation while the SDK was migrating to a new SDK version.
• Fixed a bug where the image attachment would flicker after being sent successfully.
• Fixed a bug where the typing indicator animation was not smooth on iOS 11 devices.
• Fixed a bug where the "Contact Us" button in the search footer was not localized for VO users.
• Fixed a bug where focusing on the tableview in VO mode would shift the tableview down and show some empty space on top.
• Fixed a bug where Bar button font name was not getting applied from the HelpshiftConfigDark.plist.
• Fixed a bug where font size in Table Section Header was not getting applied.

v2.9.1

November 28, 2017

Release Notes:

Common Updates

• Fixed a bug where providing no config for supportFileFormats in install would cause a crash when attachment with unknown file format is opened.

Android

• Updated to Android SDK version: v6.4.0
• Fixed some variants of a database SQLiteException occurring majorly on Android 4.x devices.
• Fixed a bug where the dynamic form flow wouldn’t launch from a deep link on the FAQ screen.
• Fixed a bug where an attachment sent from the Agent wasn’t visible if it was attached with a Request Screenshot message.
• Fixed a bug where the resource integer value for hs__issue_description_min_chars did not change upon changing the language.

iOS

• Updated to iOS SDK version: v6.3.1
• Fixed a UX issue for apps built with Xcode8 or prior and running on iOS11 where the beginning of the tableviews was shifted down.
• Fixed a bug where CSAT view was overlapping with navigation bar when status bar is hidden.
• Fixed a bug where custom issue fields were not getting sent if HSCUSTOMISSUEFIELDKEY key was used.

v2.9.0

October 27, 2017

Release Notes:

Common Updates

• Added support for sending "Custom Issue Fields" when filing a new conversation. Android. iOS.
• Added new Campaigns addProperty() API to support 64 bit integer values. Android. iOS.
• Deprecated the following APIs. Android. iOS.
  • int GetCountOfUnreadMessages() in HelpshiftCampaigns class

Android

• Updated to Android SDK version: v6.3.0
• Storage permission for user attachments is now optional. For more details on storage permission usage, click here.
• Add support for notification channels introduced in Android Oreo. Click here
• Made improvements to the Campaign images downloading mechanism saving data for the user.
• Added two new customizable color attributes for tab text on FAQ sections pager screen.
• Fixed a crash that would occur in some specific devices with missing internet permission error.
• Fixed some ExceptionInInitializerError exceptions occurring when running in a multi-process environment.
• Fixed a crash that would occur with support library v26 when navigating to a deep link from an FAQ and pressing back.
• Fixed a crash where downloading attachments would result in NullPointerException.
• Fixed a crash caused due to Package Manager runtime errors.
• Fixed a crash that would occur when clicking on push notification after app's data is cleared.
• Fixed a rare NullPointerException crash caused when sending a text message.
• Fixed a rare crash that would occur when starting the attachment picking flow in some specific devices.
• Fixed a rare crash that would occur while trying to restore a backup in a re-install case.
• Fixed a bug where title of the dynamic form was not displayed.
• Fixed a bug where the button to enter full screen mode in embedded videos wasn’t visible on the FAQ screen.
• Fixed a bug where the user could reopen an Issue in cases where the conversation screen was opened from a notification within gallery.
• Fixed a bug where Agent messages stopped appearing on the conversation screen in an edge case.
• Fixed a bug where on passing null or empty values in the setNameAndEmail() API didn’t clear the name & email fields on the Issue filing screen if a user draft was present.
• Fixed a bug where the clicks on the attachment draft of the Issue filing screen were not getting disabled while Issue creation was in-progress.
• Fixed a bug where two conversation screens could open up when launching from a notification in a case with support library v26.
• Fixed a bug where the attachment icon was incorrectly visible on the information screen in an edge case.
• Fixed a bug where passing null as the failure callback in the getNotificationCount API was leading to some errors.
• Fixed a bug where passing the enableContactUs flag as Never, enabling showSearchOnNewConversation flag, and using showConversation() API resulted in the Send Anyway button being invisible.
• Fixed a bug where embedded videos in FAQs would not fit on screen.
• Fixed a bug where a Campaign notification with an open conversation action would do nothing if the user is on the Helpshift Support screen.
• Fixed a bug where the conversation resolution question was not shown if the user was on the conversation info screen when the message was received.
• Fixed a bug where subsequent conversationPrefillText updates were ignored after setting it once.
• Fixed a bug where updating the app and then using the showConversation() API would show the user's previous conversations (open or closed) instead of showing new conversation screen.
• Fixed a bug where clicking NO in the conversation resolution question would not show the new conversation button sometimes.
• Fixed a bug where sdkSDKLanguage() was ineffective on Android Oreo.
• Fixed a bug where the attachment icon in ActionBar would not disappear if 'Do not keep activities' in Android's developer settings was enabled.
• Fixed an edge case bug where the user's attachment showed up as blank on the conversation screen if the user revoked storage permission while the attachment is uploading.

iOS

• Updated to iOS SDK version : v6.3.0
• Helpshift now supports iOS 11
• Added a new delegate to provide unread campaign message count. View
• SDK now requires -ObjC flag to be present in the "Other Linker Flags" under Build Settings section.
• Made improvements to the Campaign images downloading mechanism.
• Changed the way licucore lib is added to the project.
• Fixed config JSON files getting added even when GUI inspector is not used.
• Fixed an intermittent crash on conversation filing screen when network is unavailable.
• Fixed a bug where links were not working in Screenshot Request messages.
• Fixed a UI issue where calling UIAppearance proxy API to invoke setContentInsetAdjustmentBehavior from host app was affecting SDK's scroll views.
• Fixed a bug where Application state was being read from background thread instead of main thread.
• Fixed an accessibility bug where VO would navigate to "Describe your problem" text view and its placeholder in the text input area.
• Fixed a rare case where failing to read metadata of a message from disk could cause the app to crash.
• Improved accessibility VO label for "Send" button on Conversation Filing Screen.
• Improved handling of the rare case where Conversation DB could go in an undesirable state.
• Deprecated ShowAlertToRateAppWithURL() API. An explanation of why we made this change can be found here.
• Automatic review reminder requests sent from the backend will now be ignored.
• Updated the review action in Campaigns to have it redirect to the app store page of the app.
• Fixed some code comments.
• Fixed a bug where the color set using "Rating star color" was not being applied to stars on feedback screen.
• Fixed Hindi translation for "You found this helpful" string.
• Fixed a rare crash in signature generation while making a network request.
• Fixed a bug where the retry button for text messages would not work even after reconnecting to the network.

v2.8.1

September 12, 2017

Release Notes:

Android

• Fixed a crash that would occur when requestUnreadMessagesCount API is called immediately after install API.

v2.8.0

September 06, 2017

Release Notes:

Android

• Updated to Android SDK version : v6.1.0
• Added support for Android O developer preview 4
• Added flag for showing a typing indicator on Conversation screen View
• Added a new High Contrast theme View
• Added new key for customizing the typing indicator color View
• Added an API to asynchronously check if an active Conversation exists View
• Added an API to asynchronously request the unread message count View
• Added the following methods to the Helpshift delegate interface: View
  • (void) didCheckIfConversationActive
  • (void) didReceiveUnreadMessagesCount
• Setting enableFullPrivacy API configuration to true will now hide name and email address fields.
• Updated design for Conversation screen View
• Fixed a crash that would occur when using Android support library v25.4.0
• Fixed a crash that would occur when generating a signature for network requests
• Fixed a crash that would occur when attaching a screenshot and disabling storage permission from the background
• Fixed a bug where search results on new Conversations did not clear if the end user accepted the FAQ
• Fixed a bug where the FAQ search would not work after screen rotation on Android support library v25.4.0
• Fixed a bug where image attachment did not work with Android support library v25.4.0
• Fixed a bug where the error snackbar view didn’t get hidden in some cases after pressing back from a screen
• Fixed an edge case where the user might see multiple chat screens after clicking the notification
• Fixed a bug where the image was not getting cleared on tap of the Remove button in preview screen
• Fixed an edge case where the previous image draft was not getting cleared on enabling full privacy
• Fixed an edge case where the image draft was not getting cleared if the user left the new Conversation screen while the Issue was getting filed
• Fixed a bug where the message timestamp in the chat screen was not updated upon a change in the SDK language
• Fixed a bug where the image was always shown in sending state if the app was killed during image upload
• Fixed some crashes due to SQLiteDatabase errors
• Fixed I/O streams leak in network call in some cases
• Fixed crash on using single quotes in login identifier
• Fixed RejectedExecutionException occurring in some cases
• Deprecated the following APIs within the HelpshiftSupport class:
  • IsConversationActive
  • GetNotificationCount
• Deprecated the method didReceiveNotificationCount in Helpshift delegate interface

iOS

• Updated to iOS SDK version : v6.1.0
• Added support for iOS-11 beta-5
• Added support to show an animated indication on the Conversation screen when an Agent is replying to the Conversation View
• Added a new High Contrast theme View
• Added two new keys for customizing the text color of the user chat bubble and the Agent chat bubble View
• Added a new key for customizing the typing indicator color. View
• Added new keys for customizing the Secondary text color, Placeholder text color, and Timestamp text color View
• Added an API to asynchronously check if an active Conversation exists View
• Added an API to asynchronously request unread message count View
• Added the following methods to the HelpshiftSupportDelegate protocol:
  • (void) didCheckIfConversationActive:(BOOL)isActive
  • (void) didReceiveUnreadMessagesCount:(NSInteger)count
• Setting enableFullPrivacy API configuration to true will now hide the name and email address fields View
• Fixed a bug where the SDK would crash when the user pressed the back button after attaching a second screenshot while the first screenshot upload was still in-progress
• Fixed a bug where the SDK would crash if the Issue was filed with a corrupt image
• Fixed a bug where the search title text was not highlighted in search results
• Fixed a bug where the FAQ footer text got clipped if the font size was increased in the device's accessibility settings
• Fixed a bug where follow-up was successful if sent while the user was typing
• Fixed a UI glitch where extra padding was added to the table view search controller if the translucency of the navigation bar was disabled
• Fixed a bug where a crash would occur when multi-character UTF-16 encoded characters were found in the FAQ body of search results
• Fixed a bug where the Contact Us button in the FAQ search results list was not accessible via the accessibility identifier
• Fixed a bug where the badge count was not updated when the Issue was resolved
• Fixed a bug where notification count APIs were returning incorrect values
• Fixed a bug where the app was not suspended immediately after being backgrounded
• Fixed a bug where a crash would occur on iOS 11 beta 3 while attaching a screenshot in a new Conversation
• Fixed a bug where a crash would occur in rare cases while creating a new Issue
• Fixed a rare bug where a crash would occur during syncing sessions on iOS 10
• Fixed a rare crash on app launch
• Fixed a bug where blank cells appeared upon searching for FAQs in the FAQ section view
• Fixed a bug on iOS 11-beta where the text view to enter CSAT review text was not visible in the review rating screen
• Fixed a bug where the compilation would fail if the Socket Rocket library was integrated with the app through source code
• Fixed a bug where tags were not added to a new Issue if the tags were added without metadata
• Fixed a bug where "Bold font name" config was not applied to FAQ title
• Fixed a bug where the applications that use Google Cast SDK would crash while filing a new Conversation
• Fixed the warnings reported by Xcode 9 where some of the UIKit APIs were called from a secondary thread
• Fixed a bug where database connections were not closed before removing the database during migration
• Fixed a bug on iOS 11 where the back button title would not appear in single FAQ and Conversation screens
• Deprecated the following APIs within the HelpshiftSupport class: view
  • (BOOL) isConversationActive
  • (NSInteger) getNotificationCountFromRemote:(BOOL)isRemote
• Deprecated the method (void) didReceiveNotificationCount:(NSInteger)count in HelphisftSupportMetadata protocol [add link]
• Improved syncing server configurations
• Improved handling for failed network requests

v2.7.0

April 26, 2017

Release Notes:

Common Updates

• Added Inbox Data API's support. Android. iOS.

Android

• Removed Assets/Plugin/Android/AndroidManifest.xml from the SDK package.
• Added support for programmatically setting screen orientation for the SDK. View
• Users can now view the 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.
• SDK now supports logging to console. View
• Added support of Gradle build replacable ${applicationId} placeholder in the helpshift/AndroidManifest.xml file
• Added support for customizing FAQ list item height.
• Messages that fail to deliver can now be tapped to retry.
• Introduced an API to check if a Conversation is active. View
• Added a new delegate to notify when the Conversation has ended. View
• Made image attachment upload functionality more network-efficient.
• Enabled TLS 1.2 as the default protocol for transferring data over internet for Android API levels 16 (4.1.x) to 19 (4.4.x).
• Screenshot messages in Conversations now have timestamps.
• Set max line limit to 3 for FAQ and sections list items.
• The default value for enableInboxPolling is now true. View
• Fixed a bug where Issue resolve requests could be bypassed because of failed messages.
• Fixed a bug where 'Suggestions' title in Toolbar for FAQ search results for new Conversations was not shown.
• Fixed a crash in the image attachment flow when "Don't keep activities" is enabled.
• Fixed an edge-case bug where duplicate Issues could be filed by the user.
• Fixed a bug where strings in the FAQ view were not being translated on Android N devices.
• Fixed minor memory leaks.
• Fixed a bug where sometimes the breadcrumbs and Issue logs were not sent to the server.
• Fixed a bug where the cursor for a multi-line EditText was positioned incorrectly.
• Fixed a bug with filing new Issues when Proguard is enabled.
• Fixed a bug where Conversations with resolution questions delivered could be rejected multiple times.
• Fixed a bug where the toolbar is hidden at times on the Conversation screen when the keyboard is visible.
• Fixed a bug where the default value for enableDefaultLanguage was set to false instead of true.
• Fixed an edge case that caused Agent messages to sometimes not load for users.
• Fixed a bug where on some devices, "Was this question Helpful?" footer was shown after tapping on "Yes/No".
• Improved handling of random database crashes.
• Fixed an NPE in Campaigns for certain network failures.
• Fixed a bug where multiple instances of Campaigns Inbox UI were being created.
• Fixed a bug where push notifications for a Campaign were sometimes shown more than once.

iOS

• Added new SDK configuration for showing conversation info screen. View
• Added new SDK configuration debug logging in the SDK for solving Issues during integration. View
• Added an API to check if there is an active conversation. View
• Added a delegate method that lets the app know when a Conversation has ended. View
• 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.

v2.6.1

Feb 9, 2017

Release Notes:

iOS

• Fixed a bug where in rare circumstances FAQs would not load.
• Updated iOS native SDK to v5.9.3.
• 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.
• fixed a rare issue where hmac generation would fail while initializing the SDK leading to an app crash.

v2.6.0

January 23, 2017

Release Notes:

Common Updates

• SDK no longer includes the 'carrier name' in metaData if 'enableFullPrivacy' flag is set to true.

Android

• Update Android native SDK to v4.7.0
• Add compatibility for Android Nougat.
• Add support for custom fonts in SDK.
• Helpshift SDK now supports two more Chinese dialects: 'Chinese - Hong Kong' and 'Chinese - Singapore'.
• Improve search algorithm where some results would not show up for important keywords.
• Improve translations for the message string shown to user when issue is archived.
• Fix a bug where sometimes clicking on notification would show "new conversation form" instead of the ongoing conversation.
• Fix a crash in FAQ screen when an image is used as window background in Helpshift theme.
• Fix intermittent database crash due to KeyValueStorage db locking.
• Fix a crash in issue reporting with hideNameAndEmail and login api for the following cases :
  1. Use login api with valid name and empty email. / Use login api with empty name and valid email.
  2. Set hideNameAndEmail flag to true.
  3. Click on send button to file an issue, SDK crashes.
• Fix a crash in SDK with android support library 24 for the following case :
  1. Integrate Helpshift SDK with support library 24.
  2. Launch any Helpshift Support screen (Faqs screen, Conversation screen, etc.)
  3. Rotate the device, SDK crashes.

iOS

• Update iOS native SDK to v5.8.0
• Fix for iOS 10: An issue where the App Rating popup presented by Helpshift could move to an incorrect position.
• 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 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.
• Updated voice over labels on Single FAQ screen.
• Fix preferred status bar option in single faq is not taken from presenting view controller.

v2.4.0

September 16, 2016

Release Notes:

• iOS 10 compatibility.
• Fixed a bug that caused chat screen to go blank in some cases.
• Fixed a bug that sometimes caused the Helpshift Logo to be visible on conversation screen.
• Fixed strong reference to presenting view controller is not released when support session is closed.
• Fix missing debug logs in issue metadata.
• 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.
• Add support for customizing Helpshift themes using a HelpshiftCustomConfig.plist file. For more details, please visit https://developers.helpshift.com/ios/design/
• 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.
• 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 HelpshiftSdk's' install(application, apiKey, domain, appId) API. This API will now throw Install Exception if there are validation issues in the key information.
• Handle corrupt or unsupported file formats in In-App Campaigns.
• Handle runtime revocation of storage permission for Campaigns.
• Improve few string translations for German, Dutch, Chinese, French and Korean languages.
• Support HTML entities in FAQs search.
• Fix a bug where FAQ filtering did not work with embeddable fragments.
• Fix a bug where image attachment orientation was getting changed on some devices.
• Fix a memory leak in case of device orientation change.
• Fix a stackoverflow crash caused by campaigns poller.
• Fix a bug where custom deeplinks in agent's replies were not working on chat screen.
• Fix a theme issue where "Send" button was not themed correctly.
• Fix a bug where FAQs UI was not getting updated immediately with new data.
• Add primitive data types support in custom meta data values.
• Fix crash on notification click on some older devices caused by dynamic dex loading.
• Fix the broken feature for custom notification icon and sound.

v2.3.2

June 29, 2016

• Fix a crash caused by migration from 3.x to 4.5.0 when the application is using Helpshift's Login API.
• Fix the GetNotificationCount api to wait for queue execution.
• Add an API for callback to SDK when forcefully quitting the application.
• Fix the broken GetCountOfUnreadMessages API.
• Impact Analysis for 2.3.2 remains the same as 2.3.1.

v2.3.1