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.

iOS

[2.27.0] - 2024-12-10

Added

Implemented support for private attachments in conversations, enhancing the security and confidentiality of shared data.
The Article Viewer now supports accounts with custom domains. The article URL detection has been improved to allow for the display of help center articles within the native article viewer, regardless of the domain used.

Fixed

Fixed an issue where documents sent could not be opened, ensuring a smoother user experience when sharing files.
Resolved a critical crash issue that could occur with the Observable object, enhancing overall application stability.
Fixed a memory leak that occurred during the SDK initialization. This fix improves the management of unused references, leading to better memory usage and performance.

[2.26.0] - 2024-10-31

Added

File attachments now open in a webview.

Fixed

Resolved an issue where login request fails due to a non-optional parameter.
Resolved an accessibility issue where the divider label did not increase in size to match a font size increase.
Resolved an issue where the conversation list didn't display the name of the author who sent the most recent message.

[2.25.2] - 2024-10-21

Fixed

Fixed an issue where default conversation titles wouldn’t localize to languages other than English.

[2.25.1] - 2024-10-14

Fixed

Removed breaking API changes introduced in version 2.25.0, in order to prevent backward compatibility issues in our previous SDK versions.

[2.25.0] - 2024-09-30

Fixed

Resolved crashes occurring on the Observable object.
Fixed an issue to ensure links in the message bubble support dynamic type font.

Added

Support for iOS 18. The SDK is now completely compatible with iOS 18, aligning with the recent updates and functionality provided by Apple.
Support for Multi-conversations feature which will launch in October 2024. This feature will allow your end users to seamlessly manage multiple ongoing conversations with your business at the same time. (Stay tuned for updates by visiting our What's New page for the latest product releases and announcements.)
Capability to open all supported file types, not just images, natively in our mobile SDKs, eliminating the need to switch to a web browser.

[2.24.1] - 2024-09-20

Fixed

Resolved an issue where images captured with the device camera were not displaying in conversation.

[2.24.0] - 2024-08-20

Added

A ZendeskEvent for newly added conversations
A ZendeskEvent for messages that failed to send
A ZendeskEvent for connection status changes

[2.23.0] - 2024-07-30

Added

Ability to switch between different instances of the Zendesk SDK within the same mobile app. (This is a significant capability for customers with multiple brands or multiple territories within a single app.)
Support for different Conversation Extension sizes.

[2.22.0] - 2024-06-26

Added

Ability to automatically open conversation extensions upon receipt by a user. For more information, see Open automatically.

[2.21.1] - 2024-06-05

Fixed

Fixed an issue where calling logout before presenting the conversation screen would result in two tickets being created.

[2.21.0] - 2024-05-22

Fixed

Apple privacy manifest file is now updated with the correct Apple's required privacy information.
Fixed the voiceover focus to be on the latest message when the conversation screen is opened.
Changed voiceover announcement phrase from "Brand name headline" to "Brand name".
Fixed the accessibility trait of Tagline by change it from .header to .staticText.
Fixed AI Disclaimer layout on iOS 14 and below.

Added

Implemented voiceover accessibility for the conversation list items.

[2.20.0] - 2024-04-30

Fixed

The background color of inbound image messages is corrected to match the color of other inbound messages.
Fixed some issues to ensure all Help Center articles are opened in the article viewer in the SDK, rather than navigating end users to a browser.
Text form fields are fixed to not display the “this form is required” error until it is left blank.

[2.19.2] - 2024-04-26

Fixed

Some missing keys were added to the privacy manifest as required by Apple’s guidelines.

Important note: This is the minimum SDK version that must be used to be compliant with Apple's privacy manifest requirements.

[2.19.1] - 2024-04-24

Added

A new privacy manifest file is created in line with Apple’s guidelines.

Important note: A problem was identified with the privacy manifest in this version, and it is fixed in the later version (v2.19.2). Please use v2.19.2 in order to be compliant with Apple’s privacy manifest requirements.

[2.19.0] - 2024-03-20

Added

The message composer now has a placeholder when no text is present.
Users can now open articles from the help center directly within the application using the Article Viewer that sits on top of the conversation view. This is only supported when the account doesn’t use host mapping or other advanced methods, which causes the URL of the article to not match the account subdomain URL.
Users can now open a Conversation Extension in the application to enhance interactive experiences atop the conversation view.
Message generated by AI are displayed with a disclaimer at the bottom of that respective message.
Improved the voiceover announcements for received messages. The message content is now read aloud.
Enhanced the accessibility focus on the conversation screen. With voiceover activated, moving a finger across the screen will focus on the corresponding element.
Improved voiceover focus for image messages, allowing these to be selectable and read.

Changed

The color has been updated for the attachment button, drop-down chevron, message composer text, carousel action button, and the form field focus border to reflect the proper theme.

Fixed

Resolved a crash issue arising when the end-user authentication token (JWT) lacked optional client information.
Corrected instances of incorrect message timestamps in the conversation view when the device's time zone is manually changed.
Addressed issues of messages displaying out of order when the device time is manually changed.

[2.18.1] - 2024-02-21

Fixed

Enhanced accessibility whereby the screen reader will read messages when received and when tapped by the end user.

[2.18.0] - 2024-02-01

Added

Users can remove failed messages in the conversation by long pressing (also known as pressing-and-holding) the message and selecting remove from the contextual menu.
Users can copy the contents of a message by long pressing the message and selecting copy from the contextual menu.
Async-Await wrappers added for our asynchronous public APIs. See Swift concurrency: async/await for more details.

[2.17.0] - 2023-11-30

Added

Technical upgrades for better color management.
Improvements to how we store and clear images.
Integrator option to clear storage. (See developer documentation for implications of this here)
Accessibility support for the “[N] new messages” button.

Fixed

Improvement to conversation storage initialisation.
An issue on the navigation bar disappearing on a canceled swipe.
Quick replies flicker on the conversation screen.
A field validation error message when correct email format is entered.
A compilation naming error.
Issue with the message composer being cleared when typing indicator appears or disappears.

[2.16.0] - 2023-11-02

Added

Support for postback action type.

Postback buttons enhance your conversations as they can trigger server-side logic when a user clicks on them and are helpful when building a bot. You can also use them to trigger other server-side actions by clicking a button in the conversation, such as an “add-to-cart” action.

“See latest” navigation button added on the conversation screen to indicate there are new messages received when the end user is scrolled up on the conversation screen. Tapping the button will scroll to the bottom of the screen.
“Unread messages” button is added for when an end user navigates to the conversation screen and there are a group of unread messages that don’t fit in the visible partition of the conversation. Tapping the button will scroll to the first unread message.

Fixed

Fixed an intermittent crash issue that occurred during the process of notifying observers.
Dropdown form field values will be displayed as expected in landscape mode.

[2.15.0] - 2023-10-03

Added

Added iOS 17 Support. The SDK is now completely compatible with iOS 17, aligning with the recent updates and functionality provided by Apple.
Zip format is now supported as an attachment in a conversation.

Fixed

Fixed the end user authentication token (JWT) not being updated when expired.

Changed

Update iOS minimum version support from 11.0 to 12.0.
Improved the end user experience for validation of form fields, the validation is now done after each character change.

Removed

The SDK no longer supports iOS 11.

[2.14.0] - 2023-08-16

Added

When an end user wants to upload a photo, the photo library and the document picker options will now pick the selected photos in PNG format instead of HEIC format so agents in the Agent Workspace can easily preview photos.
Image and file uploads will wait until a socket event is received before updating status.
Minor improvements to offline and reconnecting banners.

Fixed

Device rotation will no longer cause issues on the size of carousel cards.
When the Answer Bot sends a compound message (image, text & button in one message), the view will scroll down properly to display the message.
Fixed the layout of proactive messages to prevent overlapping of text when there are multiple lines.
Improved the end user experience for validation of form fields when maximum character size is reached. The validation occurs on form field change instead of when the end user taps on the send button.

[2.13.1] - 2023-08-04

Fixed

Removed breaking API changes introduced in version 2.13.0, in order to prevent backward compatibility issues in our previous SDK versions.

[2.13.0] - 2023-07-06

Added

APIs to set messaging metadata, also known as conversation fields and conversation tags.
APIs to clear conversation fields and conversation tags from the SDK storage.
Accessibility updates to the dropdown form field and connection banner.

Fixed

Updated the style on images that failed to send.
Fixed an issue with the navigation bar not rendering correctly on iOS 11 devices.
The message composer will now be cleared on tapping the send button.
Message action buttons now use the correct color.

[2.12.0] - 2023-05-29

Added

Functionality to enable and disable upload attachments. To disable attachments for mobile devices, you must disable them for both iOS and Android. Note: This feature is available only from version 2.12.0 and later.

Fixed

Animation on avatar image.
Outbound messages are not grouped correctly.

[2.11.0] - 2023-04-24

Added

An API to set text color values until this is available to set via Admin Center.

Fixed

The message composer not reappearing after the document or image picker is closed.

[2.10.0] - 2023-04-17

Added

Various improvements to support future capabilities.

Fixed

When the end user navigates to the conversation screen, the screen fully scrolls to the bottom of the page to make the last message completely visible.

Changed

Messages will remain in a sending state for 60 seconds before timing out and will fail with an option to retry.

[2.9.0] - 2023-03-28

Added

Proactive messaging support.
Border around transparent images.
Shimmer effect on carousel image load.

Fixed

The message composer did not appear after submitting a form.
File or image upload error state did not appear on failures.
Messages sent from another platform were not displayed on mobile.
Carousel did not resize on device rotation.

Changed

Improved status bar contrast.
Expansion of the tap area on failed messages to retry.
Improved the form input field focus with a thicker border.

[2.8.1] - 2023-03-12

Fixed

Tapping compound message links will now open the browser every time.

[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 the ZendeskSDK 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 of ZendeskError object.

Removed

ZendeskSDKMessaging module public APIs for initialisation are now removed, use the new ZendeskSDK 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.