Delete conversations

Introduction

ZIM supports users to delete a specific conversation or all conversations in the conversation list.

Delete a conversation

To delete a specified conversation after login, call the deleteConversation with the conversationID parameter.

Note

When deleting a specified conversation:

All messages in the conversation are not automatically deleted. If you need to delete both the conversation and all messages in the conversation, call the deleteAllMessage method. For details, see the chapter Delete all messages of the specified conversation of Delete messages.
If the conversation has unread messages, the total number of unread messages will be reduced and shown in the conversationTotalUnreadMessageCountUpdated callback. For details, see the chapter Get the number of unread messages above.

Sample code

// Delete a specified conversation.
ZIMConversationDeleteConfig conversationDeleteConfig =
      ZIMConversationDeleteConfig();
conversationDeleteConfig.isAlsoDeleteServerConversation = true;
ZIM
    .getInstance()
    .deleteConversation(
        'conversationID', ZIMConversationType.peer, conversationDeleteConfig)
    .then((value) {})
    .catchError((onError) {});

Copied!

Delete all conversations

After the login, a user can delete all conversations in the conversation list by calling the deleteAllConversations interface.

Untitled

// Delete all conversations
ZIMConversationDeleteConfig config = ZIMConversationDeleteConfig();
config.isAlsoDeleteServerConversation = true;

ZIM.getInstance()!.deleteAllConversations(config).then((value) => {})
    .catchError((onError) {});

Copied!