Skip to main content

Flutter SDK v5 Documentation Changelog

This file tracks all changes made to the v5 documentation.

Changes Log

Date: March 26, 2026

SDK Changes - Deprecated Methods Removed

  • Removed markAsUnread() method from cometchat.dart (use markMessageAsUnread())
  • Removed receaverUid parameter from startTyping() and endTyping() - receiverUid is now required
  • Removed fetchPushPreferences(), updatePushPreferences(), resetPushPreferences() from cometchat_notifications.dart
  • Removed PushPreferences class from push_preferences.dart (use NotificationPreferences)

Documentation Updates - Deprecation Warnings Removed

  • Updated typing-indicators.mdx - removed deprecation warnings for receaverUid
  • Updated delivery-read-receipts.mdx - removed deprecation warning for markAsUnread()
  • Updated upgrading-from-v4-guide.mdx:
    • Removed lastReadMessageId type change section (was already int)
    • Changed “Deprecations” section to “Method Migrations” (methods are now removed, not deprecated)
    • Updated migration checklist

Initial Setup

  • Copied all v4 docs to docs/sdk/flutter/5.0/ folder (64 files)
  • Created this changelog file

Completed Updates

1. delivery-read-receipts.mdx ✅

  • Updated markAsUnread() to markMessageAsUnread() with deprecation notice
  • Added markConversationAsDelivered() method documentation
  • Added markConversationAsRead() method documentation
  • Updated Enhanced Messaging Status feature list

2. send-message.mdx ✅

  • Added “Send Multiple Media Files” section with code examples
  • Added “File Size and Count Validation” section with error handling

3. retrieve-conversations.mdx ✅

  • Added userTags filter documentation
  • Added groupTags filter documentation
  • Added hideAgentic filter documentation
  • Added onlyAgentic filter documentation
  • Updated lastReadMessageId description to note int type

4. retrieve-users.mdx ✅

  • Added searchIn parameter documentation
  • Added sortBy parameter documentation
  • Added sortByOrder parameter documentation
  • Added combined example for all new parameters

5. create-group.mdx ✅

  • Added createGroupWithMembers() method documentation
  • Added isBannedFromGroup property to Group Class table

6. retrieve-group-members.mdx ✅

  • Added status filter (CometChatUserStatus.online/offline) documentation

7. additional-message-filtering.mdx ✅

  • Added “Direct Page Navigation” section with setPage() method
  • Updated default limit note (50 → 30)
  • Added attachmentTypes filter documentation
  • Added hideQuotedMessages filter documentation

8. typing-indicators.mdx ✅

  • Updated code examples to use receiverUid instead of receaverUid
  • Added deprecation notices for receaverUid parameter

9. upgrading-from-v4-guide.mdx ✅ (NEW)

  • Created comprehensive migration guide
  • Documented breaking changes (lastReadMessageId type, default limit)
  • Documented all deprecations
  • Documented all new features
  • Added migration checklist

Summary of Changes

FileChanges Made
delivery-read-receipts.mdx4 updates, removed deprecation warning
send-message.mdx2 new sections
retrieve-conversations.mdx5 updates
retrieve-users.mdx4 new parameters
create-group.mdx2 additions
retrieve-group-members.mdx1 new filter
additional-message-filtering.mdx4 updates
typing-indicators.mdxRemoved deprecation notices (methods now removed)
upgrading-from-v4-guide.mdxUpdated for removed methods

SDK Changes (v5)

Removed Methods

  • markAsUnread() - use markMessageAsUnread() instead
  • receaverUid parameter - use receiverUid (now required)
  • fetchPushPreferences() - use fetchPreferences() instead
  • updatePushPreferences() - use updatePreferences() instead
  • resetPushPreferences() - use resetPreferences() instead
  • PushPreferences class - use NotificationPreferences instead

Features Documented

New Methods

  • markMessageAsUnread() - replaces deprecated markAsUnread()
  • markConversationAsDelivered() - mark entire conversation as delivered
  • markConversationAsRead() - mark entire conversation as read
  • createGroupWithMembers() - create group with members in one step

New Filters/Parameters

  • userTags - filter conversations by user tags
  • groupTags - filter conversations by group tags
  • hideAgentic - hide AI-driven conversations
  • onlyAgentic - show only AI-driven conversations
  • searchIn - specify user fields to search
  • sortBy - sort users by field
  • sortByOrder - sort order (asc/desc)
  • status - filter group members by online/offline
  • page - direct page navigation
  • attachmentTypes - filter by attachment types
  • hideQuotedMessages - exclude quoted messages

New Capabilities

  • Multiple media files in single message
  • File size/count validation
  • isBannedFromGroup property in Group class

Breaking Changes Documented

  • Default limit: 50 → 30
  • Removed deprecated methods (see SDK Changes section above)

docs.json Updated ✅

  • Added v5 version entry to Flutter SDK dropdown
  • v5 is now the first/default version shown
  • All v5 doc paths point to sdk/flutter/5.0/ folder
  • Includes upgrading-from-v4-guide in Resources section