zendesk_messaging 3.2.3

zendesk_messaging: ^3.2.3 copied to clipboard

Bug Fixes #

• iOS: Parse the APNs device token as hex before forwarding to PushNotifications.updatePushNotificationToken. The previous code used token.data(using: .utf8), which produced the UTF-8 bytes of the hex string instead of the 32-byte device token, so Zendesk registered a malformed token and never delivered iOS push.
• Android: Use the application context (stored in onAttachedToEngine) for handleNotification instead of the Activity. The Activity is null in a background isolate / terminated state, so the previous code bailed with no_context and background pushes never displayed. PushNotifications.displayNotification only needs a Context.
• Android: Guard initialize against a null Activity to return a clean error instead of a NullPointerException. Push display does not require initialize; it uses shouldBeDisplayed / handleNotification.

Documentation #

• Correct the push notification token usage in all README translations and the updatePushNotificationToken API doc. On iOS, pass the APNs device token from getAPNSToken(), not the FCM token from getToken() — using the FCM token on iOS silently fails to deliver push. Token retrieval is now split per platform, and onTokenRefresh is guarded to Android (iOS APNs tokens are re-fetched on launch).
• Document that showConversation should be called once per navigation. Rapid duplicate calls can make the underlying SDK open the default conversation instead of the requested one, so callers that may fire more than once for a single user action (e.g. a notification tap reaching multiple handlers) should de-duplicate.

Bug Fixes #

• iOS: Resolve root view controller from active scene for UISceneDelegate apps (#94)

Documentation #

• Add multi-language README support
  • 繁體中文 (Traditional Chinese)
  • 简体中文 (Simplified Chinese)
  • Español (Spanish)
  • Português (Brasil) (Portuguese)
  • 日本語 (Japanese)
  • 한국어 (Korean)
• Fix image URL for pub.dev compatibility (use absolute GitHub raw URL)

Breaking Changes #

• Flutter SDK: >=3.24.0 -> >=3.27.0

Improvements #

• Add GitHub Actions CI workflow with automated testing
• Expand unit test coverage for plugin APIs
• Update README documentation

New Features #

• Push Notifications Support
  • updatePushNotificationToken(token) - Register FCM/APNs token with Zendesk
  • shouldBeDisplayed(data) - Check if notification is from Zendesk messaging
  • handleNotification(data) - Display Zendesk push notification
  • handleNotificationTap(data) - Handle notification tap and navigate to conversation
  • ZendeskPushResponsibility enum - Notification classification (messagingShouldDisplay, messagingShouldNotDisplay, notFromMessaging)

Implementation Details #

• Android: Uses official PushNotifications class from Zendesk SDK
• iOS: Uses official PushNotifications class with handleTap completion handler
• Follows official Zendesk SDK documentation patterns

Breaking Changes #

• iOS minimum version: 12.0 -> 14.0
• Dart SDK: ^3.0.0 -> ^3.6.0
• Flutter SDK: >=3.10.0 -> >=3.24.0

Native SDK Updates #

• Android SDK: 2.26.0 -> 2.36.1
• iOS SDK: 2.24.0 -> 2.36.0
• Kotlin: 1.9.24 -> 2.1.21
• Swift: 5.9

New Features #

• Full Event System: 24 event types via sealed class pattern

  • UnreadMessageCountChanged - unread count changes with conversation details
  • AuthenticationFailed - auth errors with JWT expiration detection
  • ConnectionStatusChanged - network state monitoring
  • ConversationAdded, ConversationStarted, ConversationOpened - conversation lifecycle
  • MessagesShown - messages rendered with message data
  • SendMessageFailed - message send failures
  • FieldValidationFailed - conversation field validation errors
  • MessagingOpened, MessagingClosed - UI lifecycle
  • ProactiveMessageDisplayed, ProactiveMessageClicked - proactive messaging
  • ConversationWithAgentRequested, ConversationWithAgentAssigned, ConversationServedByAgent - agent events
  • NewConversationButtonClicked, PostbackButtonClicked - UI interactions
  • ArticleClicked, ArticleBrowserClicked - article events
  • ConversationExtensionOpened, ConversationExtensionDisplayed - extension events
  • NotificationDisplayed, NotificationOpened - push notification events (Android)

• Multi-Conversation Navigation

  • showConversation(conversationId) - navigate to specific conversation
  • showConversationList() - display conversation list
  • startNewConversation() - start new conversation directly
  • getUnreadMessageCountForConversation(conversationId) - per-conversation count

• User Management

  • getCurrentUser() - get current user with auth type
  • ZendeskUser model with id, externalId, authenticationType
  • ZendeskAuthenticationType enum (anonymous, jwt)

• Connection Status

  • getConnectionStatus() - get SDK connection state
  • ZendeskConnectionStatus enum (connected, connecting, disconnected, unknown)

• New Models

  • ZendeskUser - user information
  • ZendeskMessage - message data with id, conversationId, authorId, content, timestamp
  • ZendeskLoginResponse - login response data
  • ZendeskEvent sealed class hierarchy

Improvements #

• Modern Dart 3.x syntax with sealed classes and pattern matching
• Comprehensive API documentation
• Unit tests for method channels and event parsing
• Enhanced example app with all features demonstrated
• Backwards compatible unreadMessagesCountStream for legacy code

Migration Guide #

See README.md for detailed migration instructions from 2.x.

• Update Dart SDK minimum version to 3.0.0 .
• Update Flutter SDK minimum version to 3.10.0 .
• Fix method channel calls never complete.

• Fix multi conversation navigation

• recover namespace setting for android

• fix issue for logoutUser in iOS
• upgrade ios version to 2.24.0
• downgrade android version to 2.13.0

• Upgrade zendesk-messaging sdk version to 2.16.0
• Minimum iOS version is now 12
• ADD conversation fields

• Add invalidate() to invalidate the current instance of ZendeskMessaging

• Add conversation tag

• Upgrade Flutter sdk version
• Upgrade zendesk-messaging sdk version to 2.11.0

• Upgrade ZendeskSDKMessaging of iOS to v2.9.0 to be compatible with Xcode 14.3

• Fix parameter type issue of handler function

• Upgrade Dart sdk version

• Update versions of environment

• Upgrade to 2.6.0

• Upgrade to 2.5.0

• Authentication
• Global observer

• Initial release