Manage local messages
In chat apps, a conversation is composed of all the messages in a peer-to-peer chat, chat group, or chatroom. The Chat SDK supports managing messages by conversations, including retrieving and managing unread messages, deleting the historical messages on the local device, and searching historical messages.
This page introduces how to use the Chat SDK to implement these functionalities.
Understand the tech
SQLCipher is used to encrypt the database that stores local messages. The Chat SDK uses
ChatManager to manage local messages. Followings are the core methods:
loadAllConversations: Loads the conversation list on the local device.
deleteConversation: Deletes the specified conversation locally.
deleteConversationFromServer: Delete a conversation from the server.
Conversation.getUnreadMsgCount: Retrieves the count of unread messages in the specified conversation.
getUnreadMessageCount: Retrieves the count of all unread messages.
searchMsgFromDB: Searches for messages from the local database.
Conversation.insertMessage: Inserts messages in the specified conversation.
Before proceeding, ensure that you meet the following requirements:
- You have integrated the Chat SDK, initialized the SDK and implemented the functionality of registering accounts and login. For details, see Chat SDK quickstart.
- You understand the API call frequency limits as described in Limitations.
This section shows how to implement managing messages.
loadAllConversations to retrieve all the conversations on the local device:
Retrieve messages in the specified conversation
Refer to the following code sample to retrieve the messages in the specified conversation:
Retrieve the count of unread messages in the specified conversation
Refer to the following code example to retrieve the count of unread messages:
Retrieve the count of unread messages in all conversations
Refer to the following code example to retrieve the count of all unread messages:
Mark unread messages as read
Refer to the following code example to mark the specified messages as read:
Delete conversations and historical messages
You can delete conversations on both the local device and the server.
To delete them on the local device, call
To delete a conversation on the server, call DeleteConversationFromServer:
Search for messages using keywords
searchMsgFromDB to search for messages by keywords, timestamp, and message sender:
Call importMessages to import multiple messages to the local database.
If you want to insert a message to the current conversation without actually sending the message, construct the message body and call
insertMessage. This can be used to send notification messages such as "XXX recalls a message", "XXX joins the chat group", and "Typing ...".
After implementing managing messages, you can refer to the following documents to add more messaging functionalities to your app: