Release Notes
Release Notes
All notable releases for the Zendesk SDK for iOS will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[2.8.0] - 2022-11-30
Added
- Accessibility support to ensure new messages are announced to the user in real time.
Fixed
- The message composer will always persist text after submitting a form
- Photos taken in portrait mode will no longer be displayed in landscape mode when shared in the conversation
- The message composer will no longer disappear after attaching a document on iOS 16.1
- Attachment button will no longer be covered by the notch in landscape mode
[2.7.0] - 2022-10-25
Added
- Support link action type for all messages
- Accessibility improvements
Fixed
- Reply options crashes the app after changing to portrait on iOS 11.1
- Two instances of the conversation screen was created and pushed to the navigation stack on iOS 16
- Attachment menu issue on iOS 16
- Expanded GIF/Image showing composer field on iOS 16
- Timestamp is received in incorrect position
[2.6.0] - 2022-09-08
Added
- Improvements to support iOS 16
- Accessibility improvements
- Animations for messages disappearing from a conversation
Fixed
- Attachments will continue to upload when the SDK is backgrounded
- Conversation will scroll to the bottom when a new message is received
[2.5.0] - 2022-08-10
Added
- Improved the message history by loading more than 100 messages when user scrolls to the top of the message list
- Message receipt animation
- Support message with actions
Fixed
- Fixed an issue where the navigation bar appearance on the parent view controller was changed after leaving the conversation screen
Changed
- Update iOS minimum version support from 10.0 to 11.0
- The conversation screen now uses a standalone navigation bar. It is no longer required to push the conversation screen to a navigation controller in order to see the conversation header
[2.4.0] - 2022-05-30
Added
- Timestamp divider and grouping of messages on the conversation screen
- Support for increased number of items in the dropdown in a future release
Fixed
- Bug fix for conversation retry screen not shown when user is offline
[2.3.0] - 2022-03-31
Added
- Sending page view event for Visitor Path
- Support for image upload from the camera. Add these Property List Keys to your plist.
- Display error when unsupported file/image is uploaded
- Agent is typing indicator
Fixed
- Sending large files over 50mb displays error
- Share button causing the SDK to abort on iPad
- Selecting document closing the file picker
- Sending images with live photos
[2.2.3] - 2022-03-10
Added
- An error message for when there is an issue loading or creating a conversation.
- A divider in the UI to separate new messages when the user re-enters the conversation screen.
Fixed
- Improved connection strategy that sometimes prevented messages from showing in the conversation.
- Improved error handling of iOS photo permissions on iOS 13 and 14, where the share card's Save Image button could cause a crash.
- Fixed the issue preventing the installation of multiple apps containing the Zendesk SDK on the same device.
Changed
- Carousels have an improved design to a more modern structured look.
[2.2.0] - 2022-02-28
Important: This version was removed due to a dependency issue that caused a potential crash with other versions of the SDK. We decided to remove it entirely to avoid any further issues. The 2.2.3 version fixes this issue.
[2.1.0] - 2022-01-25
Note: Dependencies associated with the 2.2.0 release cause issues with previous versions of the SDK, leading to a crash. If you are using the exact version rules
set in SPM, we recommend updating to the latest version to avoid any issues.
Added
- End user authentication, enables a business to verify the identity of a user.
Fixed
- Tapping a failed image resends the image instead of launching it in preview mode.
- Message grouping differentiation between AnswerBot and agents.
- iOS 10 issues with uploading photo library images.
Changed
- Integration via Carthage package manager, now uses modules in XCFramework format instead of FatFramework format.
Removed
- Support for FatFramework modules for integrators using manual integration method.
[2.0.0] - 2021-12-09
Added
- Offline banner to inform user of connectivity state with auto retries and retry button.
- Send button animation to indicate progress of form submission.
- Skeleton loader is displayed while images and avatars are downloading from the network.
- Event Observer API to observe events emitted from the Zendesk SDK. See events documentation.
- Event added that passes the unread message count when the total number of unread messages has updated.
- API to get the total number of unread messages.
- Text persistence for composer and form when in the background or network re-connection.
- Form disclosure and navigation through iOS keyboard.
Fixed
- Form clearing when returning from the background.
- Form option position displaced after error message is displayed.
- Form not in focus after new inbound messages.
- Animate GIFs when in full screen.
Changed
- SDK initialization moved from the
ZendeskSDKMessaging
module to theZendeskSDK
module to enable flexibility as more capabilities are made available alongside messaging. See Initialize the SDK for more details. - Initialization snippet to accept a factory implementation of messaging.
- Initialization errors are returned as an
Error
object instead ofZendeskError
object.
Removed
ZenedeskSDKMessaging
module public APIs for initialisation are now removed, use the newZendeskSDK
module public APIs instead. This is a breaking change from SDK initialization of previous versions.
[1.2.1] - 2021-10-18
Added
- Support for iOS 15
Fixed
- Centering small text in messages and quick replies
- Resolved Xcode warnings
[1.2.0] - 2021-10-04
Added
- The ability for the end user to send images and file messages. See File Validation for all the supported file types.
- Animation for a Form being sent.
- Composer text is persisted through the app's lifecycle.
- Previously sent Flow Builder messages are now translated if device locale changes.
[1.1.0] - 2021-08-24
Added
- HTTP response caching for REST clients.
- Additional details were added to initialization flow errors to more easily diagnose issues.
[1.0.2] - 2021-08-10
Added
- FR-CA locale as a new language.
Fixed
- Quick replies not sending metadata to enable CSAT rating and fix reopening ticket issue.
- Automatic translations not working.
- Flickering of messages when re-opening the conversation.
- Default avatar showing while avatar is still being loaded.
- Vertical spacing between messages.
- SDK default color.
- Text message width relative to margins instead of a fixed width.
- Send button and background screen slightly visible for a brief time on iOS 11.
- Ordering quick replies in place as received.
- Failed messages disappearing after reconnection.
- Title not centered on iOS 10.
- Carousel time since receipt label not appearing consistently in the correct location.
- Conversation blank screen in an edge case.
- (Forms) Multiple taps on send not updating the screen with the sent form.
- (Forms) Time since receipt label consistently appearing in the correct location.
[1.0.1] - 2021-02-01
The initial public version of the Zendesk SDK for iOS.
Added
- The ability for the end-user to start a messaging conversation with your business.
- Direct integration with Zendesk's Flow Builder for building automated conversations.
- The ability for the end-user to receive text, image, quick reply and carousel messages.
- The ability for the end-user to send text messages to your business.
- The ability for your business to send a form to the end-user and have the completed form returned.
- The ability to customize the SDK's user interface colors from Zendesk’s Admin Center.
- Support for 33 languages, including right-to-left languages. For the full list, see Language codes for Zendesk supported languages.
- Support for Dark theme.
- Support for landscape mode.
- Support for WCAG 2.1 accessibility.