Release Notes

4.0.0

  • Custom fields functionality has been completely re-implemented. For more details, see our migration guide.
  • Custom fields are now available as the customFields property of the ZDKRequest class.
  • Enabled module stability for the SDKs.
  • Fixed crash in ZDKHelpCenterArticle.
  • Fixed crash in URLSessionTaskHandlerManager.

For integrators using Carthage, the new binary locations are as follows:

binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/CommonUISDK/CommonUISDK.json" == 1.1.0
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/ZendeskCoreSDK/ZendeskCoreSDK.json" == 2.2.0
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/ZendeskProviderSDK/ZendeskProviderSDK.json" == 4.0.0
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/ZendeskSDK/ZendeskSDK.json" == 4.0.0

3.0.3 Swift 5.1.2

  • Built for Swift 5.1.2 and Xcode 11.2.

3.0.2 Swift 5.1 compatible build

  • Replaced deprecated UIWebView in the Help Center article view with WKViewView.
  • Fixed issue where ticket details were not visible in ticket list in Dark Mode.
  • Fixed issue where the text on empty ticket list was displayed in the wrong color when using Dark Mode.
  • Fixed issue where Help Center search was missing from Help Center article list on initial load on iOS 13.
  • Fixed issue where Help Center navigation bar was displayed in the wrong color on iOS 13.
  • Fixed issue where the Article List was displayed in Times New Roman font on iOS 13.
  • Fixed issue where the "Failed to get tickets" error message was displayed in Times New Roman font on iOS 13.
  • Fixed issue where photos taken on device before update to iOS 13 were not recognized as jpeg.
  • Fixed issue where image picker text was not visible in Dark Mode.
  • Fixed issue where camera button was not visible on iOS 13 with device used in landscape mode.

3.0.1 Swift 5.1 GM compatible build

This is a Swift 5.1 GM compatible build of Zendesk Support SDK. It is compatible with GM Seed 2. It does not contain any source code changes. For full details of the changes in 3.0.1, see the 3.0.1 release notes.

For integrators using Carthage, the new binary locations are as follows:

binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-GM/CommonUISDK/CommonUISDK.json" == 1.0.1
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-GM/ZendeskCoreSDK/ZendeskCoreSDK.json" == 2.1.0
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-GM/ZendeskProviderSDK/ZendeskProviderSDK.json" == 3.0.1
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-GM/ZendeskSDK/ZendeskSDK.json" == 3.0.1

For integrators using CocoaPods, the binaries are available on a branch. Use the following line in your podfile:

pod 'ZendeskSDK', :git => 'https://github.com/zendesk/zendesk_sdk_ios.git', :branch => '3.0.1-swift5.1-GM'

3.0.1 Swift 5.1 beta 6 compatible build

This is a Swift 5.1 beta 6 compatible build of Zendesk Support SDK. It does not contain any source code changes. For full details of the changes in 3.0.1, see the 3.0.1 release notes.

For integrators using Carthage, the new binary locations are as follows:

binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta6/CommonUISDK/CommonUISDK.json" == 1.0.1
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta6/ZendeskCoreSDK/ZendeskCoreSDK.json" == 2.1.0
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta6/ZendeskProviderSDK/ZendeskProviderSDK.json" == 3.0.1
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta6/ZendeskSDK/ZendeskSDK.json" == 3.0.1

For integrators using CocoaPods, the binaries are available on a branch. Use the following line in your podfile:

pod 'ZendeskSDK', :git => 'https://github.com/zendesk/zendesk_sdk_ios.git', :branch => '3.0.1-swift5.1-beta6'

3.0.1 Swift 5.1 beta 5 compatible build

This is a Swift 5.1 beta 5 compatible build of Zendesk Support SDK. It does not contain any source code changes. For full details of the changes in 3.0.1, see the 3.0.1 release notes.

For integrators using Carthage, the new binary locations are as follows:

binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta5/CommonUISDK/CommonUISDK.json" == 1.0.1
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta5/ZendeskCoreSDK/ZendeskCoreSDK.json" == 2.1.0
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta5/ZendeskProviderSDK/ZendeskProviderSDK.json" == 3.0.1
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta5/ZendeskSDK/ZendeskSDK.json" == 3.0.1

For integrators using CocoaPods, the binaries are available on a branch. Use the following line in your podfile:

pod 'ZendeskSDK', :git => 'https://github.com/zendesk/zendesk_sdk_ios.git', :branch => '3.0.1-swift5.1-beta5'

3.0.1 Swift 5.1 beta 4 compatible build

This is a Swift 5.1 beta 4 compatible build of Zendesk Support SDK. It does not contain any source code changes. For full details of the changes in 3.0.1, see the 3.0.1 release notes.

For integrators using Carthage, the new binary locations are as follows:

binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta4/CommonUISDK/CommonUISDK.json" == 1.0.1
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta4/ZendeskCoreSDK/ZendeskCoreSDK.json" == 2.1.0
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta4/ZendeskProviderSDK/ZendeskProviderSDK.json" == 3.0.1
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta4/ZendeskSDK/ZendeskSDK.json" == 3.0.1

For integrators using CocoaPods, the binaries are available on a branch. Use the following line in your podfile:

pod 'ZendeskSDK', :git => 'https://github.com/zendesk/zendesk_sdk_ios.git', :branch => '3.0.1-swift5.1-beta4'

3.0.1

  • Bug fixes.

3.0.0 Swift 5.1 beta 3 compatible build

This is a Swift 5.1 beta 3 compatible build of Zendesk Support SDK. It does not contain any source code changes. For full details of the changes in 3.0.0, see the 3.0.0 release notes.

For integrators using Carthage, the new binary locations are as follows:

binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta3/CommonUISDK/CommonUISDK.json"== 1.0.0
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta3/ZendeskCoreSDK/ZendeskCoreSDK.json" == 2.1.0
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta3/ZendeskProviderSDK/ZendeskProviderSDK.json" == 3.0.0
binary "https://zendesk.jfrog.io/zendesk/libs-releases-local/ios/zendesk/5.1.0-beta3/ZendeskSDK/ZendeskSDK.json" == 3.0.0

For integrators using CocoaPods, the binaries are available on a branch. Use the following line in your podfile:

pod 'ZendeskSDK', :git => 'https://github.com/zendesk/zendesk_sdk_ios.git', :branch => '3.0.0-swift5.1-beta3'

3.0.0

The Zendesk Support SDK is now shipped with a extra framework to include when integrating into your app called the CommonUISDK.framework. This will need to imported when using the UiConfiguration class in the SDK. For more details, see our migration guide.

  • Fixed bug where Help Center search with labels that contain spaces were not getting encoded correctly.
  • Fixed issue where the navigation bar would cover content in Request List screen on iOS 10 when accessed through Help Center screen.
  • Fixed issue for integrators using Swift where the id property on ZDKHelpCenterSimpleArticle would be the wrong type.
  • The ArticleViewController now supports RTL content in the article.
  • The showContactSupport property was not being respected in the Help Center article page when accessed through search. This is fixed.
  • The HelpCenterViewController and ArticleViewController now automatically show the Answer Bot UI from the "Contact us" button if the AnswerBotSDK is present. New properties deflectionEnabled on the ArticleUiConfiguration and HelpCenterUiConfiguration allows integrators to configure whether to open the Answer Bot screen or not.
  • The CoreSDK now respects the identity type set on the SupportSDK tab in the Admin dashboard and will fail authentication if the identity type set in code doesn't match it.
  • Date format in the ArticleViewController is now formatted correctly in RTL languages.
  • Fixed bug where users create a ticket but then don't receive push notification on that ticket till they re-enter the Request screen.
  • Fixed crash on iPads when displaying alert views for for unsent messages on the Request screen.
  • Fixed issue where tickets created for JWT users are not linked correctly if we fail to fetch the request the first time they enter the request screen.
  • The minimum platform requirement is iOS 9.3.

2.3.1

  • Built for Swift 5.0 and Xcode 10.2.

 2.3.0

  • Fix for image attachments layout issues in the RequestController, where images appear at varying dimensions in landscape.
  • Added Voice Over compatibility.
  • Fix for text cursor jumping to the end of text, when inserting unicode character, in the middle of the input field.
  • Fix for article failing to load on initial display, from a clean install.
  • Fix for tabBar blocking the inputField on iOS 9 and 10.
  • Deprecated the ZDKHelpCenterDelegate that displayed the human contact options, use HelpCenterUiConfiguration and ArticleUiConfiguration instead.
  • Fix for navBar shadow missing after presenting Create Request screen.

2.2.0

  • Compatibility with Answer Bot SDK version 1.0.0-EAP1.

2.1.1

  • Support for iOS 12, Xcode 10, and Swift 4.2 compatibility.

2.1.0

  • Added RTL support
  • Added the ability to override device locale to display specific Help Center articles
  • Fixed failed messages duplication on retry
  • Fixed crash caused by agent avatars with non-latin characters in file name
  • Fixed issue with multistage text input

2.0.3

  • Fixed a crash when presenting UIDocumentPickerviewController without UINavigationBar.appearance().tintColor set

2.0.2

  • Fixed integer overflow issues on 32bit devices. This required a breaking change to several APIs. For more details please see migration guide
  • Fixed a crash on Swift 4.1
  • HEIC are now treated as images instead of files
  • Fixed deeplinking
  • Fixed push notification registration for anonymous users

2.0.0

Most of the SDK was completely rewritten for version 2

CreateRequestViewController is a new view controller for creating, viewing, and updating tickets. It includes:

  • All new design
  • Separate ticket creation view when the conversations feature is disabled
  • Offline support (view tickets offline)
  • Clickable links
  • Support for deep-linking to Help Center articles
  • Support for rich text
  • Support for file attachments (not just images)
  • Programmatically-added attachments
  • Multi-agent support
  • A confirmation message to be shown on successful creation of a ticket (configurable via the Zendesk Support admin page)
  • Improved error-handling and resending of tickets and comments
  • Improved image/file picker

RequestListViewController is the new view controller for viewing a list of a user's tickets. It features:

  • All new design
  • Offline support (view tickets offline)
  • Support for showing closed tickets in the list (configurable via the Zendesk Support admin page)
  • Improved error-handling HelpCenterOverviewController now matches the ordering of Help Center content on the web.

Many changes apply to the whole SDK:

  • Full support for re-initialization and changing of identity at runtime, using Zendesk.instance?.init and Zendesk.instance?.setIdentity
  • Simplified theming
  • Deep configuration options through UiConfigs
  • Support for 33 languages (up from 19)
  • A redesigned API