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 fromcometchat.dart(usemarkMessageAsUnread()) - Removed
receaverUidparameter fromstartTyping()andendTyping()-receiverUidis now required - Removed
fetchPushPreferences(),updatePushPreferences(),resetPushPreferences()fromcometchat_notifications.dart - Removed
PushPreferencesclass frompush_preferences.dart(useNotificationPreferences)
Documentation Updates - Deprecation Warnings Removed
- Updated
typing-indicators.mdx- removed deprecation warnings forreceaverUid - Updated
delivery-read-receipts.mdx- removed deprecation warning formarkAsUnread() - Updated
upgrading-from-v4-guide.mdx:- Removed
lastReadMessageIdtype change section (was already int) - Changed “Deprecations” section to “Method Migrations” (methods are now removed, not deprecated)
- Updated migration checklist
- Removed
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()tomarkMessageAsUnread()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
userTagsfilter documentation - Added
groupTagsfilter documentation - Added
hideAgenticfilter documentation - Added
onlyAgenticfilter documentation - Updated
lastReadMessageIddescription to note int type
4. retrieve-users.mdx ✅
- Added
searchInparameter documentation - Added
sortByparameter documentation - Added
sortByOrderparameter documentation - Added combined example for all new parameters
5. create-group.mdx ✅
- Added
createGroupWithMembers()method documentation - Added
isBannedFromGroupproperty 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
attachmentTypesfilter documentation - Added
hideQuotedMessagesfilter documentation
8. typing-indicators.mdx ✅
- Updated code examples to use
receiverUidinstead ofreceaverUid - Added deprecation notices for
receaverUidparameter
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
| File | Changes Made |
|---|---|
| delivery-read-receipts.mdx | 4 updates, removed deprecation warning |
| send-message.mdx | 2 new sections |
| retrieve-conversations.mdx | 5 updates |
| retrieve-users.mdx | 4 new parameters |
| create-group.mdx | 2 additions |
| retrieve-group-members.mdx | 1 new filter |
| additional-message-filtering.mdx | 4 updates |
| typing-indicators.mdx | Removed deprecation notices (methods now removed) |
| upgrading-from-v4-guide.mdx | Updated for removed methods |
SDK Changes (v5)
Removed Methods
markAsUnread()- usemarkMessageAsUnread()insteadreceaverUidparameter - usereceiverUid(now required)fetchPushPreferences()- usefetchPreferences()insteadupdatePushPreferences()- useupdatePreferences()insteadresetPushPreferences()- useresetPreferences()insteadPushPreferencesclass - useNotificationPreferencesinstead
Features Documented
New Methods
markMessageAsUnread()- replaces deprecatedmarkAsUnread()markConversationAsDelivered()- mark entire conversation as deliveredmarkConversationAsRead()- mark entire conversation as readcreateGroupWithMembers()- create group with members in one step
New Filters/Parameters
userTags- filter conversations by user tagsgroupTags- filter conversations by group tagshideAgentic- hide AI-driven conversationsonlyAgentic- show only AI-driven conversationssearchIn- specify user fields to searchsortBy- sort users by fieldsortByOrder- sort order (asc/desc)status- filter group members by online/offlinepage- direct page navigationattachmentTypes- filter by attachment typeshideQuotedMessages- exclude quoted messages
New Capabilities
- Multiple media files in single message
- File size/count validation
isBannedFromGroupproperty in Group class
Breaking Changes Documented
- Default limit: 50 → 30
- Removed deprecated methods (see SDK Changes section above)
Navigation Configuration
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-guidein Resources section