Documentation Index Fetch the complete documentation index at: https://cometchat-22654f5b-docs-android-v6-beta2.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
AI Integration Quick Reference
Method Description markAsDelivered(message)Mark a message as delivered markAsRead(message)Mark a message as read markConversationAsDelivered(id, type)Mark entire conversation as delivered markConversationAsRead(id, type)Mark entire conversation as read markMessageAsUnread(message)Mark a message as unread getMessageReceipts(messageId)Get delivery/read receipts for a message
// Mark as delivered/read (pass message object)
CometChat . markAsDelivered ( message );
CometChat . markAsRead ( message );
// Mark entire conversation
CometChat . markConversationAsRead ( "UID" , "user" );
// Listen for receipt events
CometChat . addMessageListener ( "LISTENER_ID" , new CometChat . MessageListener ({
onMessagesDelivered : ( receipt ) => { },
onMessagesRead : ( receipt ) => { },
onMessagesDeliveredToAll : ( receipt ) => { }, // Groups only
onMessagesReadByAll : ( receipt ) => { } // Groups only
}));
Delivery and read receipts track whether messages have been delivered to and read by recipients.
Mark as Delivered
Use markAsDelivered() to mark messages as delivered. You can pass either a message object or individual parameters.
Using Message Object
CometChat . markAsDelivered ( message ). then (
() => {
console . log ( "Marked as delivered successfully" );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error marking as delivered:" , error );
}
);
CometChat . markAsDelivered ( message ). then (
() => {
console . log ( "Marked as delivered successfully" );
},
( error ) => {
console . log ( "Error marking as delivered:" , error );
}
);
Using Parameters
Parameter Description messageIdID of the message to mark as delivered receiverIdFor user chats: sender’s UID. For groups: group GUID receiverType"user" or "group"senderIdUID of the message sender
TypeScript (User)
JavaScript (User)
TypeScript (Group)
JavaScript (Group)
let messageId : string = "MESSAGE_ID" ;
let receiverId : string = "MESSAGE_SENDER_UID" ;
let receiverType : string = "user" ;
let senderId : string = "MESSAGE_SENDER_UID" ;
CometChat . markAsDelivered ( messageId , receiverId , receiverType , senderId ). then (
() => {
console . log ( "Marked as delivered successfully" );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error marking as delivered:" , error );
}
);
let messageId = "MESSAGE_ID" ;
let receiverId = "MESSAGE_SENDER_UID" ;
let receiverType = "user" ;
let senderId = "MESSAGE_SENDER_UID" ;
CometChat . markAsDelivered ( messageId , receiverId , receiverType , senderId ). then (
() => {
console . log ( "Marked as delivered successfully" );
},
( error ) => {
console . log ( "Error marking as delivered:" , error );
}
);
let messageId : string = "MESSAGE_ID" ;
let receiverId : string = "GROUP_GUID" ;
let receiverType : string = "group" ;
let senderId : string = "MESSAGE_SENDER_UID" ;
CometChat . markAsDelivered ( messageId , receiverId , receiverType , senderId ). then (
() => {
console . log ( "Marked as delivered successfully" );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error marking as delivered:" , error );
}
);
let messageId = "MESSAGE_ID" ;
let receiverId = "GROUP_GUID" ;
let receiverType = "group" ;
let senderId = "MESSAGE_SENDER_UID" ;
CometChat . markAsDelivered ( messageId , receiverId , receiverType , senderId ). then (
() => {
console . log ( "Marked as delivered successfully" );
},
( error ) => {
console . log ( "Error marking as delivered:" , error );
}
);
Mark Conversation as Delivered
Use markConversationAsDelivered() to mark all messages in a conversation as delivered.
markConversationAsDelivered() resolves with a string on success.
TypeScript (User)
JavaScript (User)
TypeScript (Group)
JavaScript (Group)
let conversationWith : string = "USER_UID" ;
let conversationType : string = "user" ;
CometChat . markConversationAsDelivered ( conversationWith , conversationType ). then (
( response : string ) => {
console . log ( "Conversation marked as delivered" , response );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error:" , error );
}
);
let conversationWith = "USER_UID" ;
let conversationType = "user" ;
CometChat . markConversationAsDelivered ( conversationWith , conversationType ). then (
( response ) => {
console . log ( "Conversation marked as delivered" , response );
},
( error ) => {
console . log ( "Error:" , error );
}
);
let conversationWith : string = "GROUP_GUID" ;
let conversationType : string = "group" ;
CometChat . markConversationAsDelivered ( conversationWith , conversationType ). then (
( response : string ) => {
console . log ( "Conversation marked as delivered" , response );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error:" , error );
}
);
let conversationWith = "GROUP_GUID" ;
let conversationType = "group" ;
CometChat . markConversationAsDelivered ( conversationWith , conversationType ). then (
( response ) => {
console . log ( "Conversation marked as delivered" , response );
},
( error ) => {
console . log ( "Error:" , error );
}
);
Mark as Read
Use markAsRead() to mark messages as read. You can pass either a message object or individual parameters.
Using Message Object
CometChat . markAsRead ( message ). then (
() => {
console . log ( "Marked as read successfully" );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error marking as read:" , error );
}
);
CometChat . markAsRead ( message ). then (
() => {
console . log ( "Marked as read successfully" );
},
( error ) => {
console . log ( "Error marking as read:" , error );
}
);
Using Parameters
TypeScript (User)
JavaScript (User)
TypeScript (Group)
JavaScript (Group)
let messageId : string = "MESSAGE_ID" ;
let receiverId : string = "MESSAGE_SENDER_UID" ;
let receiverType : string = "user" ;
let senderId : string = "MESSAGE_SENDER_UID" ;
CometChat . markAsRead ( messageId , receiverId , receiverType , senderId ). then (
() => {
console . log ( "Marked as read successfully" );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error marking as read:" , error );
}
);
let messageId = "MESSAGE_ID" ;
let receiverId = "MESSAGE_SENDER_UID" ;
let receiverType = "user" ;
let senderId = "MESSAGE_SENDER_UID" ;
CometChat . markAsRead ( messageId , receiverId , receiverType , senderId ). then (
() => {
console . log ( "Marked as read successfully" );
},
( error ) => {
console . log ( "Error marking as read:" , error );
}
);
let messageId : string = "MESSAGE_ID" ;
let receiverId : string = "GROUP_GUID" ;
let receiverType : string = "group" ;
let senderId : string = "MESSAGE_SENDER_UID" ;
CometChat . markAsRead ( messageId , receiverId , receiverType , senderId ). then (
() => {
console . log ( "Marked as read successfully" );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error marking as read:" , error );
}
);
let messageId = "MESSAGE_ID" ;
let receiverId = "GROUP_GUID" ;
let receiverType = "group" ;
let senderId = "MESSAGE_SENDER_UID" ;
CometChat . markAsRead ( messageId , receiverId , receiverType , senderId ). then (
() => {
console . log ( "Marked as read successfully" );
},
( error ) => {
console . log ( "Error marking as read:" , error );
}
);
Mark Conversation as Read
Use markConversationAsRead() to mark all messages in a conversation as read.
TypeScript (User)
JavaScript (User)
TypeScript (Group)
JavaScript (Group)
let conversationWith : string = "USER_UID" ;
let conversationType : string = "user" ;
CometChat . markConversationAsRead ( conversationWith , conversationType ). then (
( response : string ) => {
console . log ( "Conversation marked as read" , response );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error:" , error );
}
);
let conversationWith = "USER_UID" ;
let conversationType = "user" ;
CometChat . markConversationAsRead ( conversationWith , conversationType ). then (
( response ) => {
console . log ( "Conversation marked as read" , response );
},
( error ) => {
console . log ( "Error:" , error );
}
);
let conversationWith : string = "GROUP_GUID" ;
let conversationType : string = "group" ;
CometChat . markConversationAsRead ( conversationWith , conversationType ). then (
( response : string ) => {
console . log ( "Conversation marked as read" , response );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error:" , error );
}
);
let conversationWith = "GROUP_GUID" ;
let conversationType = "group" ;
CometChat . markConversationAsRead ( conversationWith , conversationType ). then (
( response ) => {
console . log ( "Conversation marked as read" , response );
},
( error ) => {
console . log ( "Error:" , error );
}
);
Real-Time Receipt Events
Register a MessageListener to receive delivery and read receipt events.
Callback Description onMessagesDeliveredMessage delivered to a user onMessagesReadMessage read by a user onMessagesDeliveredToAllGroup message delivered to all members onMessagesReadByAllGroup message read by all members
let listenerID : string = "UNIQUE_LISTENER_ID" ;
CometChat . addMessageListener (
listenerID ,
new CometChat . MessageListener ({
onMessagesDelivered : ( messageReceipt : CometChat . MessageReceipt ) => {
console . log ( "Message delivered:" , messageReceipt );
},
onMessagesRead : ( messageReceipt : CometChat . MessageReceipt ) => {
console . log ( "Message read:" , messageReceipt );
},
onMessagesDeliveredToAll : ( messageReceipt : CometChat . MessageReceipt ) => {
console . log ( "Message delivered to all group members:" , messageReceipt );
},
onMessagesReadByAll : ( messageReceipt : CometChat . MessageReceipt ) => {
console . log ( "Message read by all group members:" , messageReceipt );
}
})
);
let listenerID = "UNIQUE_LISTENER_ID" ;
CometChat . addMessageListener (
listenerID ,
new CometChat . MessageListener ({
onMessagesDelivered : ( messageReceipt ) => {
console . log ( "Message delivered:" , messageReceipt );
},
onMessagesRead : ( messageReceipt ) => {
console . log ( "Message read:" , messageReceipt );
},
onMessagesDeliveredToAll : ( messageReceipt ) => {
console . log ( "Message delivered to all group members:" , messageReceipt );
},
onMessagesReadByAll : ( messageReceipt ) => {
console . log ( "Message read by all group members:" , messageReceipt );
}
})
);
You will receive events in the form of MessageReceipt objects containing the following parameters:
Parameter Information messageIdThe ID of the message prior to which all the messages for that particular conversation have been marked as read. senderUser object containing the details of the user who has marked the message as read. System User for deliveredToAll & readByAll events.receiverIdID of the receiver whose conversation has been marked as read. receiverTypeType of the receiver (user/group) receiptTypeType of the receipt (read/delivered) deliveredAtThe timestamp of the time when the message was delivered. Only present if the receiptType is delivered. readAtThe timestamp of the time when the message was read. Only present when the receiptType is read.
The markAsDelivered() and markAsRead() methods are fire-and-forget — they do not return a MessageReceipt object. Use the listener callbacks above to receive delivery and read confirmations.
The following features require Enhanced Messaging Status to be enabled for your app:
onMessagesDeliveredToAll event
onMessagesReadByAll event
deliveredAt field in group messages
readAt field in group messages
markMessageAsUnread() method
Always remove listeners when no longer needed to prevent memory leaks. In React Native, place this in a cleanup function inside useEffect or in componentWillUnmount. CometChat . removeMessageListener ( "UNIQUE_LISTENER_ID" );
MessageReceipt Object
The listener callbacks receive a MessageReceipt object:
Field Getter Return Type Description messageId getMessageId()stringID of the message sender getSender()UserUser who triggered the receipt receiverId getReceiverId()stringID of the receiver receiverType getReceiverType()string"user" or "group"receiptType getReceiptType()string"delivery" or "read"deliveredAt getDeliveredAt()numberTimestamp when delivered readAt getReadAt()numberTimestamp when read
Get Receipt History
Use getMessageReceipts() to fetch delivery and read receipts for a specific message. Useful for group messages to see which members have received/read the message.
let messageId : number = 123 ;
CometChat . getMessageReceipts ( messageId ). then (
( receipts : CometChat . MessageReceipt []) => {
console . log ( "Message receipts:" , receipts );
},
( error : CometChat . CometChatException ) => {
console . log ( "Error fetching receipts:" , error );
}
);
let messageId = 123 ;
CometChat . getMessageReceipts ( messageId ). then (
( receipts ) => {
console . log ( "Message receipts:" , receipts );
},
( error ) => {
console . log ( "Error fetching receipts:" , error );
}
);
Returns an array of MessageReceipt objects.
Missed Receipts
When fetching messages, each message object includes deliveredAt and readAt timestamps indicating when the message was delivered and read.
let deliveredAt = message . getDeliveredAt ();
let readAt = message . getReadAt ();
Mark as Unread
Use markMessageAsUnread() to mark a message as unread. This is useful for “mark as unread” functionality in conversation lists.
You cannot mark your own messages as unread. This method only works for messages received from other users.
CometChat . markMessageAsUnread ( message ). then (
( conversation : CometChat . Conversation ) => {
console . log ( "Message marked as unread:" , conversation );
console . log ( "Unread message count:" , conversation . getUnreadMessageCount ());
},
( error : CometChat . CometChatException ) => {
console . log ( "Error marking as unread:" , error );
}
);
CometChat . markMessageAsUnread ( message ). then (
( conversation ) => {
console . log ( "Message marked as unread:" , conversation );
console . log ( "Unread message count:" , conversation . getUnreadMessageCount ());
},
( error ) => {
console . log ( "Error marking as unread:" , error );
}
);
Parameter Type Description messageBaseMessageThe message object to mark as unread
Next Steps
Typing Indicators Show real-time typing status in conversations
Receive Messages Listen for incoming messages in real time
Retrieve Conversations Fetch conversation list with unread counts
All Real-Time Listeners Complete reference for all SDK event listeners