Release notes

Version 2.11.1

27th May 2021

  • Fixed the known issue where assignment of the ChatAPIConfiguration lead to chats not starting in the ChatSDK.

Version 2.11.0

5th May 2021

  • Added a new API ChatProvider.setDepartment(_ name: String?, completion: ((Result<String?, DeliveryStatusError>) -> Void)?) to allow integrators to set a department.

  • Updated the observeChat<Data>(...) methods to allow integrators to pass a ObservableIdentifier argument. The new parameter has a default value of an internally generated UUID. The following methods have been updated:

    • AccountProvider.observeAccount(...)
    • ChatProvider.observeChatState(...)
    • ConnectionProvider.observeConnectionStatus(...)
    • ProfileProvider.observeVisitorInfo(...)
    • SettingsProvider.observeChatSettings(...)
  • Fixed an issue where the department associated with a visitor doesn’t match the department they selected

in the pre-chat form.

  • Fixed an issue where the department associated with a visitor doesn’t match the department set on the configuration.

  • There is still a known issue with using the ChatAPIConfiguration to set the department while using the pre-chat form. You can find a workaround and more details here.

  • Previously, when a Chat was in a disconnected state, a banner was displayed with the text "Connection Failed". This text has changed to now read "Disconnected".

  • Fixed an issue where the ‘Disconnected’ banner was displayed after an offline form was completed.

Version 2.10.0

25th November 2020

  • Swift Package Manager (SPM) support. See Adding the SDK with SPM.

  • CocoaPods integration now uses XCFrameworks.

  • Deprecated the ChatProvider.requestChat() API, which is no longer supported.

  • Fixed an issue where the app would become unusable if the user dismissed the document picker by swiping down on the modal viewController.

  • Fixed an issue where queued API requests would be cleared when a user entered the chat screen.

  • Fixed an issue where setting the department on the ChatAPIConfiguration would be ignored if the user filled out the pre-chat form before a chat.

  • Fixed constraint issues with the cells used for Chat option shortcuts.

Version 2.9.0

14th September 2020

  • Added a new API MessagingConfiguration.isMultilineResponseOptionsEnabled on MessagingSDK to opt-in into a Flexbox-layout of the quick-reply options. This API is useful if you have a long list of departments with large titles. See the documentation for more details.

  • Added a new API PushNotificationsProvider.registerPushTokenString(_ token: String) that allows you to register for push notifications by providing the device token in String format.

  • Fixed an issue where the callback for ending the chat wasn't always called.

  • Fixed an issue where connectionStatus was incorrectly set to .connecting once the chat had ended.

  • Fixed minor bugs related to offline forms.

Version 2.8.0

31st July 2020

  • Added support for authenticating users via JWT. For a better understanding, see the SDK documentation, the Guide article, and the sample app.

  • Added a new API on the ChatProvider to check to see if there is an active chat. For more information, see the documentation.

  • Fixed an issue where a user couldn't send a message if the visitorInfo was set through the ChatAPIConfiguration.

  • Fixed an issue where a string in the offline form (key: ios.conversation.ui.chat.offline_form.message_prompt) wasn't being translated to the device locale.

This key was replaced by ios.conversation.ui.chat.offline_form.introduction_message. If you are overriding strings, make sure to update the key of that translation.

  • Fixed other minor bugs and improvements.

Version 2.7.0

8th June 2020

  • Added support for configuring multiple apps in the Admin Console, as well as the ability to target a sandbox for testing push notifications.

  • Added support for an end-user to choose from a selection of quick responses in the chat conversation.

  • Added Dark Mode support to the messaging screen within chat conversations.

  • Fixed an issue where image caching was causing a performance issue.

  • Fixed an issue where the typing indicator was not being displayed correctly for grouped Answer Bot messages.

Version 2.6.0

18th May 2020

  • Custom link handling in order to enable deep-linking.

  • New event observers in order to enable better UI lifecycle management.

  • Enable integrators to easily implement their own unread message counter. See the article on how to implement it.

  • Fixed an issue where an event was not sent in case when agent has ended the chat.

  • Fixed an issue where the device and platform values in the Chat Agent Dashboard were empty when the SDK was being used.

Version 2.5.1

12th May 2020

  • The SDK is now built using Swift 5.2.x.

  • The SDK is now fully compatible with RTL languages.

  • Minor UI & UX improvements.

  • Exposed the debug logger to Objective-C.

  • Fixed an issue that wouldn't allow you to override the Chat strings.

  • Fixed an issue where isAgentAvailabilityEnabled flag needed to be enabled for the pre-chat form to work.

  • Fixed an issue where resetting identity didn't stop push notifications.

  • Fixed an issue where the connection banner would be visible behind the navigation bar.

  • Fixed an issue on iPad that caused a crash when the SDK tried to present a UIAlertController.

Version 2.5.0

10th April 2020

  • Initial release of Chat SDK v2.