cometchat_sdk

New

• Added a multi-file upload API for sending several attachments in one message. CometChat.createUploadFileRequest() returns an UploadFileRequest you upload through and manage per file — uploadAttachment / uploadAttachments, retryAttachment, removeAttachment, clearAll — and inspect with getStatus(), getAttachments(), and getAttachmentCount().
• Added UploadFileListener for per-file progress, success, rejection, and failure updates, with rejection (onFileError) and retryable failure (onFileFailure) as distinct callbacks.

Enhancements

• Improved Web and WebAssembly (dart2wasm) support.
• Added caption editing for image, video, audio, and file messages via editMessage(), which now returns Future<BaseMessage?> (resolving to null on failure).
• Relicensed the package under the MIT License.

Fixes

• None

New

• Added a CardMessage class for receiving developer card messages, with accessors for the card payload, fallback text, and data.text.
• Added an onCardMessageReceived callback to MessageListener for real-time card message delivery.
• Added AIAssistantCardStartedEvent, AIAssistantCardReceivedEvent, and AIAssistantCardEndedEvent for AI assistant card streaming through onAIAssistantEventReceived.
• Added an AIAssistantElement model with getType() and getData() to represent ordered content blocks in AI assistant messages.
• Added getElements() and setElements() to AIAssistantMessage for working with ordered AIAssistantElement blocks from data.elements.

Enhancements

• None

Fixes

• None

New

• None

Enhancements

• None

Fixes

• Fixed an issue where custom server configurations could fail when endpoint URLs were provided without https://.

New

• None

Enhancements

• Improved device recognition consistency across app launches for a more reliable experience.
• Improved the SDK reconnect behavior by stopping further reconnection attempts after a connection-not-allowed error is received from the WebSocket connection.

Fixes

• Fixed an issue on web that could prevent some applications from connecting successfully in browser environments.

New

• Added Notification Feed support with new data models including NotificationFeedItem, NotificationCategory, and PushNotification.
• Added FeedReadState enum with values read, unread, and all for filtering notification feed items by read status.
• Added FeedEngagementType enum with values viewed, clicked, and interacted for reporting user engagement on feed items.
• Added NotificationFeedRequestBuilder for fetching paginated notification feed items with filters for read state, category, channel ID, tags, and date range.
• Added NotificationCategoriesRequestBuilder for fetching paginated notification categories.
• Added markFeedItemAsDelivered() and markFeedItemsAsDelivered() methods to mark notification feed items as delivered.
• Added markFeedItemAsRead() method to mark a notification feed item as read.
• Added markAllFeedItemsAsRead() method to mark all notification feed items as read in a single call.
• Added reportFeedEngagement() method to report user engagement (viewed, clicked, interacted) on a feed item.
• Added getNotificationFeedUnreadCount() method to retrieve the unread count for notification feed items.
• Added getNotificationFeedItem() method to fetch a single notification feed item by ID for deep linking.
• Added markPushNotificationDelivered() method to mark a push notification as delivered.
• Added markPushNotificationClicked() method to mark a push notification as clicked.
• Added NotificationFeedListener for receiving real-time notification feed items via WebSocket with onFeedItemReceived() callback.
• Added addNotificationFeedListener() and removeNotificationFeedListener() methods for managing real-time notification feed listeners.

Enhancements

• None

Fixes

• None

New

• None

Enhancements

• Enhanced CometChat Skills to improve support for agentic integrations and workflow interoperability.

Fixes

• Fixed an issue where push notification tokens were not registered correctly on iOS devices, preventing reliable notification delivery.

Deprecations

• None

Removals

• None

New

• Added a fully rewritten Flutter SDK built entirely in pure Dart, with unified support across iOS, Android, Web, and desktop platforms.
• Added modular package imports, allowing developers to include only the required modules such as messaging.dart, calling.dart, ai.dart, notifications.dart, and moderation.dart.
• Added real-time typing indicators powered by native Dart streams.
• Added background isolate parsing for improved performance when handling large message lists.
• Added automatic HTTP retry support with exponential backoff for transient network failures.
• Added improved WebSocket reconnection handling on web platforms during browser tab throttling.
• Added pagination metadata, including currentPage and totalPages, to message fetch responses.
• Added device-level event routing to prevent duplicate event handling across multiple sessions.
• Added feature flags to disable typing indicators, read receipts, and presence updates.

Enhancements

• None

Fixes

• None

Breaking Changes

• Changed onTypingIndicator() to return Stream<TypingIndicator> instead of Stream<String>.
• Removed deprecated APIs including receaverUid and fetchPushPreferences.
• Renamed builder setters to setWithUserAndGroupTags, setWithTags, setIncludeBlockedUsers, and setWithBlockedInfo.

New

• None

Enhancements

• Added support for configuring unanswered call timeouts in CometChat.initiateCall(), allowing calls to be automatically rejected after a specified number of seconds. The default timeout is 45 seconds.

Fixes

• Resolved an issue where the text_message_end event was not recognized during AI Assistant streaming, preventing the streaming message bubble from finalizing correctly.

Deprecations

• None

Removals

• None

New

• Introduced markMessageAsUnread() method to allow marking messages as unread for easier tracking and follow-up.
• Added markConversationAsDelivered() method to signal that a conversation has been delivered.
• Introduced markConversationAsRead() method to update the status of a conversation to "read."
• Updated lastReadMessageId variable to return and accept a int type instead of a string.

Deprecations

• Deprecated markAsUnread() method. Please use markMessageAsUnread() instead.

Fixes

• Resolved an issue where image and video thumbnails were not displayed for url not present in metadata when the file access token feature was enabled.

New

• Added a getFlagReasons method that retrieves the list of available flag reasons from the dashboard, allowing developers to display accurate and up-to-date reporting categories.
• Added a flagMessage method that enables developers to flag a specific message by providing the message ID and the corresponding reason ID.
• Added quotedMessageId variable to the BaseMessage class for retrieving and assigning the ID of a quoted message.
• Introduced quotedMessage in the BaseMessage class to get or set the quoted message object.
• Introduced hideQuotedMessages in the MessageRequestBuilder class to configure whether quoted messages should be included in the response.

New

• Added a getFlagReasons method that retrieves the list of available flag reasons from the dashboard, allowing developers to display accurate and up-to-date reporting categories.
• Added a flagMessage method that enables developers to flag a specific message by providing the message ID and the corresponding reason ID.
• Added quotedMessageId variable to the BaseMessage class for retrieving and assigning the ID of a quoted message.
• Introduced quotedMessage in the BaseMessage class to get or set the quoted message object.
• Introduced hideQuotedMessages in the MessageRequestBuilder class to configure whether quoted messages should be included in the response.

Enhancements

• Changed the default limit to fetch in various request builders from 50 to 30.

Fixes

• Fixed an issue where only offline group members were fetched by default.
• Fixed pagination issue in various request builders.
• Added a flag to prevent multiple requests from being triggered simultaneously within a method.

New

• Added filters (hideAgentic, onlyAgentic) to ConversationsRequest to help manage AI-driven (agentic) conversations.
• Added a status filter to GroupMembersRequest for more precise member management.

Enhancements

• Added setPage() methods to all request builders, enabling direct page navigation and improved data handling in paginated responses.
• Implemented file size and file count validation in sendMediaMessage(), with configurable limits available through Settings.

Fixes

• Resolved an issue where sending multiple media files using the chat SDK did not return the list of attachments in the onSuccess callback. This issue occurred despite successful media transmission and has now been fixed to ensure accurate delivery feedback.

New

• Added AI Assistant Event Classes to provide detailed lifecycle tracking for AI assistant interactions:
  • AIAssistantBaseEvent – Serves as the base type for all AI assistant-related events.
  • AIAssistantRunStartedEvent – Triggered when an AI assistant run begins.
  • AIAssistantRunFinishedEvent – Triggered when an AI assistant run completes.
  • AIAssistantMessageEndedEvent – Triggered when an AI assistant finishes sending a message.
  • AIAssistantContentReceivedEvent – Triggered when content is received from the AI assistant.
  • AIAssistantToolStartedEvent – Triggered when the AI assistant starts executing a tool.
  • AIAssistantToolEndedEvent – Triggered when the AI assistant completes a tool execution.
  • AIAssistantToolArgumentEvent – Triggered when arguments are passed to an AI tool.
  • AIAssistantToolResultEvent – Triggered when results are returned from an AI tool.
• Introduced AIAssistantListener for subscribing to and handling AI assistant events:
  • addAIAssistantListener – Registers a listener for AI assistant events.
  • removeAIAssistantListener – Unregisters an AI assistant listener.
  • onAIAssistantEventReceived – Handles incoming AI assistant events.
• Introduced new methods in MessageListener for subscribing to and handling new AI assistant messages:
  • onAIAssistantMessageReceived – Handles incoming AI assistant message.
  • onAIToolArgumentsReceived – Handles incoming AI tool arguments.
  • onAIToolResultReceived – Handles incoming AI tool result.
• Added Messages & Data Classes for structured handling of AI tool call, argument, result and message:
  • AIToolResultMessage – Represents a message containing the result of a tool execution.
  • AIToolCall – Contains structured data for a specific AI tool call.
  • AIToolCallFunction – Contains structured data for a specific AI tool call function.
  • AIToolArgumentMessage – Represents a message containing tool arguments.
  • AIAssistantMessage – Represents a message sent by the AI assistant.

Fixes

• Added a missing method to fetch message details by message ID.

New

• Added a new onMessageModerated method in the MessageListener class. This method is triggered when a message sent by the logged-in user is successfully processed by moderation and receives either an approved or disapproved status.
• Introduced a new moderationStatus variable in both TextMessage and MediaMessage classes, allowing users to check the moderation status of their messages.
• Added a new ModerationStatusEnum enum that includes the following states:
  • pending
  • approved
  • disapproved
  • unmoderated (default for apps without moderation enabled)

New

• Added support for sending multiple media files in a single message, enabling richer and more efficient conversations.
• Introduced createGroupWithMembers group creation by allowing users to create a group and add members in a single step.
• Added searchIn, sortBy, and sortByOrder variables to the UsersRequestBuilder, giving developers more control over user filtering and ordering.
• Added attachmentTypes variable to MessagesRequestBuilder, allowing developers to specify desired attachment types when fetching messages.

Enhancements

• Updated the id and parentMessageId fields in the message object from int to long to improve scalability and ensure consistency across platforms.

New

• Added support for filtering conversations using new parameters in ConversationsRequestBuilder:
  • userTags – Enables users to filter conversations based on specific user tags.
  • groupTags – Enables users to filter conversations based on specific group tags.

Fixes

• Fixed an issue where real-time listener events were only triggered when a UI action occurred. This was due to listener registration happening within a post-frame callback, which delayed initialization. The fix ensures listeners are now initialized earlier, restoring real-time responsiveness.

Fixes

• Fixed runtime crash due to Swift symbol mismatch between CometChatSDK and CometChatStarscream frameworks.

New

• Introduced Conversations & Advanced Search to enhance message and conversation filtering capabilities.
• Added new filters to MessagesRequestBuilder:
  • hasAttachments() – Retrieve messages that contain file attachments.
  • hasReactions() – Retrieve messages that include user reactions.
  • hasMentions() – Retrieve messages where users are mentioned.
  • hasLinks() – Retrieve messages that contain hyperlinks.
  • setMentionedUIDs(List<String>) – Retrieve messages mentioning specific user IDs.
• Added new filters to ConversationsRequestBuilder:
  • setSearchKeyword(String) – Search conversations (user or group) by name keyword.
  • setUnread(boolean) – Retrieve only unread conversations.

Fixes

• Fixed an issue where an error appeared in the console when logging in for the first time on a freshly installed app on iOS. This issue did not cause a crash but has now been resolved to ensure a smoother login experience.

Removals

• Removed myMentionsOnly method from MessagesRequestBuilder introduced in v4.0.2.

Fixes Fixed an issue with editing text messages in the CometChat API where a 'Type Null is not a subtype of Type User' error occurred.

New Fixed an issue where tags could not be added to a media message using the CometChat.editMessage() method in Flutter

Fixes

• Fixed an issue where readAt and deliveredAt timestamps were being added by default to Action messages.

New

• Added onMessagesDeliveredToAll and onMessagesReadByAll listeners to notify message sender when group messages are delivered or read by everyone in the group.

Fixes

• Fixed an issue where marking messages with mentions as read was not working.

New

• The following new methods have been introduced in the CometChatNotifications class:
  • updateTimezone: This method updates the timezone for receiving Enhanced Email and Enhanced SMS notifications correctly.
  • getTimezone: This method fetches the timezone set for a user.

Enhancements

• The following methods in the CometChatNotifications class have been deprecated:
  • fetchPushPreferences is now deprecated. Please use fetchPreferences as an alternative.
  • updatePushPreferences is now deprecated. Please use updatePreferences as an alternative.
  • resetPushPreferences is now deprecated. Please use resetPreferences as an alternative.
• The following class in the CometChatNotifications class has been deprecated:
  • PushPreferences is now deprecated. Please use NotificationPreferences as an alternative.

Fixes

• Fixed an issue where the CometChat.clearActiveCall() method was incorrectly calling ping instead of clearActiveCall.
• Fixed action messages constructor to take only required values

Deprecations

• Deprecated the receaverUid parameter in the CometChat.startTyping() method. Please use the receiverUid property instead. The receaverUid parameter will be removed in a future release.
• Deprecated the receaverUid parameter in the CometChat.endTyping() method. Please use the receiverUid property instead. The receaverUid parameter will be removed in a future release.

New

• Added a new parameter includeBlockedUsers in ConversationsRequestBuilder to allow fetching conversations of users blocked by the logged-in user.
• Added a new parameter withBlockedInfo in ConversationsRequestBuilder to fetch blocked information in the conversation object, such as blockedByMe and hasBlockedMe.
• Added a new parameter for scopes in BannedMembersRequestBuilder.

Fixes

• Fixed an issue causing a critical crash on Android devices when invoking the CometChat.disconnect() method.

New

• Added a method named getConversationUpdateSettings which returns the settings saved in Dashboard.

Enhancements

• Updated all 3rd-party plugins versions.
• Resolved all static Dart Analyser suggestions
• Added namespaces in build.gradle to avoid conflicts.

Fixes

• Fixed the issue where the onInteractiveMessageReceived listener is not working in iOS.

New

• Added PrivacyInfo file that complies with the latest apple guidelines for SDKs.

New

• Added a new boolean property isBannedFromGroup to the Group model class to indicate whether the user is banned from the group or not.
• Introduced three new properties in CustomMessage class as follows:
  • sendNotification: True value will trigger a notification for the custom message.
  • conversationText: This string can be used to display the last message text in the conversation list.
• updateConversation: If set to true, the message will appear as the last message in the Conversation and will update and reorder the conversation list, placing the conversation at the top.

Fixes

• Fixed URL handling in CometChat.callExtension, ensuring consistent and reliable endpoint interactions

New

• Introduced Reaction and ReactionEvent classes to enhance the functionality of message reactions introduced in v4.0.3.
• Added ReactionsRequest class as a replacement for ReactionRequest class introduced in v4.0.3.
• Added ReactionsRequestBuilder class as a replacement for ReactionRequestBuilder class introduced in v4.0.3.
• Introduced Enhanced Push Notification Feature.
  • Added PushPreferences, GroupPreferences, MutePreferences, MutedConversation, UnmutedConversation&DaySchedule` classes
  • Added method registerPushToken method to register push token.
  • Added method unregisterPushToken method to unregister push token.
  • Added method muteConversations method to mute push notifications of conversations.
  • Added method unmuteConversations method to unmute push notifications of conversations.
  • Added method fetchPushPreferences, updatePushPreferences & resetPushPreferences to fetch, update & reset push preferences.

Enhancements

• The real-time listeners onMessageReactionAdded and onMessageReactionRemoved have been improved to return an object of ReactionEvent class, providing a more robust event model.
• ReactionsRequestBuilder has been enhanced to return a list of Reaction objects, offering a more intuitive and consistent API.

Removals

• Removed the MessageReaction class introduced in v4.0.3, transitioning its responsibilities to the new Reaction and ReactionEvent classes.
• Removed myMentionsOnly method from MessagesRequestBuilder introduced in v4.0.2.

• New: ReactionEvent Object will be emitted by onMessageReactionAdded & onMessageReactionRemoved events
• New: MessageReaction class renamed to Reaction
• New: getReactions() method replaced with reactions property in BaseMessage class
• New: getMentionedUsers() method replaced with mentionedUsers property in BaseMessage class
• New: hasMentionedMe() method replaced with hasMentionedMe property in BaseMessage class
• Bug: fixed unreadRepliesCount count incorrect type error in Action Object
• Bug: fixed issue of other user's reactions not being received through the lastMessage property of Conversation Object on iOS
• Bug: fixed issue of receiving onMessageReactionAdded & onMessageReactionRemoved events when it is the logged-in user calling CometChat.addReaction and CometChat.removeReaction on iOS

• Bug: fixed sending metadata property in Call
• Bug: fixed sending muid property in Call

• Bug: fixed sending media messages with captions and tags in iOS
• Bug: fixed sending media messages with Attachment URL in iOS

• New: Added support to react on Text, Media and Custom Messages
• New: Added a new field unreadMentionsCount field in Conversation Object
• New: Added a new field lastReadMessageId field in Conversation Object

• New: Added support to mention a user in a Text & Media Message
• New: Added support to send interactive messages like forms, card, etc.
• New: Added a method to mark a message as unread

• New: Added methods for AI Conversation Summary & AI Assist Bot

• Bug: Fixes and performance improvements

• New: Optimized websocket connection
• New: Ping() for websocket connection
• Bug: Fixes and performance improvements

• New: CometChat v4 support enabled