DocumentationAPI Reference

Release Notes

Release Notes

All notable releases for the Zendesk SDK for Android will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[2.12.0] - 2023-05-30

Added

  • Re-login an authenticated user when a user merge event is detected
  • 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

  • A field disappears after submitting form while offline
  • Messages sent from web are now displayed on both the logged in iOS and Android conversation
  • Image attachments is not being displayed
  • The blockChatInput flag is not properly handled
  • Outbound messages are not grouped correctly

Changed

  • Kotlin version to 1.7.21
  • The ProGuard rules have been updated to ensure compatibility with the default R8 mode enabled by Gradle 8

[2.11.0] - 2023-04-24

Added

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

Fixed

  • Theme colors now dynamically update when the configuration is updated

[2.10.0] - 2023-04-17

Added

  • Various improvements to support future capabilities.

[2.9.0] - 2023-03-27

Added

  • Proactive messaging support

Fixed

  • Conversation screen should scroll to the bottom in landscape mode after uploading images

Changed

  • Removed elevation and drop shadow from form buttons

[2.8.0] - 2022-11-30

Added

  • Accessibility support to ensure new messages are announced to the user in real time.

Fixed

  • Answer Bot interactions will always be displayed in the right order
  • Failed messages will not affect the status of following successful messages
  • Attachment button will still be visible when the composer is disabled
  • Unread message divider will always be displayed for messages received while the app is in the background
  • Compilation error will not occur when customer uses FileProvider

[2.7.0] - 2022-10-26

Added

  • Upgrade Kotlin dependency to version 1.6.X
  • Support link action type for all messages
  • Upgrade Coil dependency to latest version

Fixed

  • Tapping a form text field scrolls to the bottom of the conversation
  • Exception appears in logs for Coil upgrade
  • NullPointerException in API level 28 and below caused by URLConnection
  • ConnectionBanner causes Stackoverflow crash

[2.6.0] - 2022-09-15

Added

  • Capability to load more than 100 messages when the user scrolls to the top of the message list
  • Accessibility improvements

Fixed

  • Notifications runtime permissions will show up on screen (Android 13 only)
  • Tapping a sent video will play it
  • Users will see the latest message that was displayed on the push notification when they tap a notification

[2.5.0] - 2022-08-10

Added

  • Message receipt animation
  • Improve accessibility
  • Push notification permissions
  • Media permissions

Fixed

  • Scrolling issue after submitting a form

Changed

  • Android 13 support
  • Carousels have an improved design to a more modern structured look

[2.4.0] - 2022-05-30

Added

  • Timestamp divider and grouping of messages on the conversation screen
  • Improved handling of denial of permissions
  • Support for increased number of items in the dropdown in a future release

Fixed

  • Bug fix for the text composer not being re-enabled when new messages are received

[2.3.0] - 2022-03-31

Added

  • Sending page view event for Visitor Path
  • Support for Android 12
  • Agent is typing indicator

Changed

  • Kotlin version to 1.5.31
  • SDK targets and compiles to API 31

[2.2.0] - 2022-03-10

Added

  • A divider in the UI to separate new messages when the user re-enters the conversation screen.
  • Typed text is now persisted in a conversation screen.

Fixed

  • Improved connection strategy that sometimes prevented messages from showing in the conversation.

[2.1.0] - 2022-01-25

Added

  • End user authentication, enables a business to verify the identity of a user.

[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.
  • Hide the text composer when a form field is in focus.
  • Event Observer API to observe events emitted from the Zendesk SDK. See events documentation.
  • Event that passes the unread message count when the total number of unread messages has updated.
  • API to get the total number of unread messages.

Fixed

  • Android 12 (API 31) pending intent mutability change as per Android 12's documentation.
  • Email keyboard not displaying on Android 5.1.
  • EOFException terminating the WebSocket connection.
  • Focus on first form field triggering keyboard for text or expanding dropdowns.

Changed

  • SDK initialization moved from the Messaging module to the Zendesk 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 a Throwable object instead of ZendeskError object.

Deprecated

  • Messaging module public APIs are now deprecated. Use the Zendesk module public APIs instead. The Messaging SDK initialization will be removed in a future version of the SDK.

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

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

Fixed

  • A logger issue when an exception message was null.

[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.
  • Internal concurrent safe access to event listeners.
  • Flickering of sent messages when re-opening the conversation.
  • Ordering quick replies in place as received.
  • Carousel not adhering to RTL specifications.
  • Updating failed messages when opening the conversation from a push notification.
  • (Forms) Text field vertical space not reclaimed when re-validated.
  • (Forms) Icon missing in form field validation.
  • (Forms) Keep form response in place (replace form), instead of adding as a new message.
  • Optimized GIF loading.
  • Added 1dp border to image messages for smoother rounded corners.
  • Conversation screen showing a blank in edge cases.
  • Messages in a blank Conversation should flow from the top of the screen.
  • (API 21) Failed messages not properly styled.
  • (API 21) Font size not increasing.

[1.0.1] - 2021-02-08

Fixed

  • Message content partially displaying offscreen due to a mismatching version of ConstraintLayout.

[1.0.0] - 2021-02-01

The initial public version of the Zendesk SDK for Android.

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.