Release Notes

v5.0.0 Download SDK

May 17, 2019

  • Updated to Android SDK version 7.5.0 View
  • Introduced a new rich element for automation bots to let users choose from a list of selectable option responses if the number of selectable options is more than 5. For more details, refer here.
  • Users can modify their CSAT rating during the Feedback phase before submitting them. For more details, refer here.
  • 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.
  • Added configuration option, conversationPrefillText, for pre-filling new conversation's description in the conversational issue filing experience. For more details, refer here.
  • 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.
  • In debug mode, public APIs in Support, Campaigns and Core would log an error if the API is called before Core#install API.
  • 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 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 Download SDK

Oct 22, 2018

  • 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 this FAQ 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 > In-app SDK configuration page.
  • Introduced support for Android P.
  • Introduced functionality for end users to be able to tap on an attachment that they sent to in order to view the image.
  • Added Campaigns delegate callbacks to track when a Helpshift campaigns session begins and when a session ends. Refer here.
  • Fix a crash happening when trying to send metadata via the Helpshift FAQs or conversation API.
  • Fixed a bug where the Campaigns poller was not stopped when the app was in the background.
  • Fixed a bug where form-based Issue filing was not considered the default until the app configuration was received.
  • Fixed a bug where a duplicate attachment was sent again if the user turned off the internet while sending the attachment 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 an edge case crash that would occur as a result of the concurrent modification exception.
  • 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 a new 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 that 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.

v4.0.0

May 24, 2018

  • 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.
  • 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.

v1.9.0

December 11, 2017

  • Fixed a crash which occurred in the following case:
    1. conversationPrefillText is set in the config and the user tries to file an issue without changing the description.
    2. The flag showSearchOnNewConversation is also enabled and a FAQ is opened from search suggestion screen.
    3. User clicks on Done button on the FAQ screen, SDK crashes.

v1.8.0

November 28, 2017

  • Updated to Android SDK version v6.4.0
  • Add support for notification channels introduced in Android Oreo. View
  • Storage permission for user attachments is now optional. For more details on storage permission usage, View.
  • Added support for sending Custom Issue Fields when filing a new conversation. View
  • Added new Campaigns addLongLongProperty() API to support Long Long values.
  • Added new dynamic form API, showDynamicForm() to support taking in the title of the dynamic form as input.
  • 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 where downloading attachments would result in NullPointerException.
  • Fixed a crash caused due to Package Manager runtime errors.
  • Fixed a rare NullPointerException crash caused when sending a text message.
  • 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 API 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.
  • 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 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 crash that would occur when an attachment selected from a gallery was changed and the "Don’t Keep Activities" flag was enabled.
  • 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 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.

v1.7.0

September 06, 2017

  • 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 a new key for customizing the typing indicator color. View
  • Added an API to asynchronously check if an active Conversation exists View
  • Setting the enableFullPrivacy API configuration to true will now hide the name and email address fields View
  • Updated design for Conversation screen View
  • Deprecated the following APIs within the HelpshiftCocos2dx class: View
    • isConversationActive
    • setSDKLanguage
  • 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

v1.6.0

April 24, 2017

  • Updated the Android native SDK to v4.9.1
  • 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.
  • Added flag for showing Conversation info screen. View
  • SDK now supports logging to console. View
  • 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 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 some bugs that would cause the app to crash on startup.
  • 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.

v1.5.0

February 7, 2017

  • Updated the Android native SDK to v4.8.1
  • Added support for setting expiry time to campaign messages.
  • Improved Syncing strategy for campaigns data.
  • Improved in-app FAQ search by making it faster and memory efficient.
  • Improved translations for SDK strings.
  • Improved Helpshift Log API to make it thread safe.
  • Improved SDK start-up time.
  • Reply box in chat screen now can be expanded up to four lines.
  • Fixed a bug where search keyword highlighting did not work on some devices.
  • Fixed a crash on Android N devices when opening attachments sent from agent dashboard.
  • Fixed a rare crash which occurred due to null arguments on launching the Helpshift screen.
  • Fixed a rare crash which occurred due to unexpected service wake-up on some devices.
  • Fixed a UI glitch in single question view on tablet devices where an unexpected vertical line was visible to user.
  • Fixed an ANR issue on clicking search icon when using android support library v25.1.0 and above.
  • Fixed a string localization issue in the FAQs screen which occurred on some 7" tablets.
  • Fixed a rare crash which occurred due to exceptionally large number of un-synced app sessions.

v1.4.0

October 7, 2016

  • Update Android native SDK to v4.7.0
  • Add compatibility for Android Nougat.
  • Add support for push notifications with FCM (Firebase cloud messaging).
  • 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 carrier name was being collected in full privacy mode.
  • 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 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.

v1.3.0

September 16, 2016

  • 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 Helpshift Core'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 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.
  • Send user-id and device-id with every new conversation to facilitate integration of the Support and Campaigns products.
  • Add support for notification when a conversation is resolved.
  • Remove SD card information from metadata due to data inaccuracy.
  • Add translations for Bengali, Bulgarian, Gujarati, Hindi, Kannada, Latvian, Malayalam, Marathi, Punjabi, Persian, Tamil and Telugu languages.
  • Improve localization strings according to customer feedback.
  • Fix a bug where Contact Us config is reset to default on activity restart due to high memory pressure.

v1.2.0

April 18, 2016

  • 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.

v1.1.0-support

January 15, 2015

  • Add support for Nested dynamic forms.
  • Fix the missing appcompat lib in dependencies.
  • Fix thread leaks in android plugin code on app startup

v1.0.0-support

December 23, 2015

Release Notes:

  • Update iOS native SDK to v5.3.0
  • Update Android native SDK to v4.2.0

v3.8.0

April 16, 2015

  • 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