Delete Messages

Delete messsage is a feature which is found in modern messaging apps which allows the user to delete the message once it is sent.Once you sent the message, you can able to delete the messages by using built in sdk methods.

Delete for me

If you want to delete the messages for yourself only then you can use the below method.

Note: The messages will not be deleted to the receipient.

Argument	Type	Description
TO_JID	String	jid of the chat user
MESSAGE_ID_LIST	List<String>	List of messageId to be deleted
DELETE_CHAT_TYPE	DeleteChatType	DeleteChatType.chat for single chat, DeleteChatType.groupchat for group chat
IS_MEDIA_DELETE	boolean	true, if media file also to be deleted in the local storage
CALLBACK	ChatActionListener	callback to observe the action status

Java

ChatManager.deleteMessagesForMe(TO_JID, MESSAGE_ID_LIST, DELETE_CHAT_TYPE, IS_MEDIA_DELETE, (isSuccess, message) -> {

});

Kotlin

ChatManager.deleteMessagesForMe(TO_JID, MESSAGE_ID_LIST, DELETE_CHAT_TYPE, IS_MEDIA_DELETE, object : ChatActionListener {

override fun onResponse(isSuccess: Boolean, message: String) {

}

})

Delete for everyone

If you want to delete the messages for yourself and receiver then you can use the below method. The messages will also be deleted to the receipient.

Argument	Type	Description
TO_JID	String	jid of the chat user
MESSAGE_ID_LIST	List<String>	List of messageId to be deleted
DELETE_CHAT_TYPE	DeleteChatType	DeleteChatType.chat for single chat, DeleteChatType.groupchat for group chat
IS_MEDIA_DELETE	boolean	true, if media file also to be deleted in the local storage
CALLBACK	ChatActionListener	callback to observe the action status

Java

ChatManager.deleteMessagesForEveryone(TO_JID, MESSAGE_ID_LIST, DELETE_CHAT_TYPE, IS_MEDIA_DELETE, (isSuccess, message) -> {

});

Kotlin

ChatManager.deleteMessagesForEveryone(TO_JID, MESSAGE_ID_LIST, DELETE_CHAT_TYPE, IS_MEDIA_DELETE, object : ChatActionListener {

override fun onResponse(isSuccess: Boolean, message: String) {

}

})

caution

If delete message feature unavailable for your plan then it will throw 403 exception.

Clear chat messages

Clear chat messages is a feature which allows users to delete the chat messages to reduce the storage usage. if you want to clear the messages for the entire chat, or multiple chats then you can utilise the below methods. it will also delete the downloaded media files from your local storage.

Clear chat

You can clear the messages for any chat by using the below method. The messages will not be deleted to the receipient.

Argument	Type	Description
TO_JID	String	jid of the chat user
CHAT_TYPE	ChatTypeEnum	ChatTypeEnum.chat for single chat, ChatTypeEnum.groupchat for group chat, ChatTypeEnum.broadcast for broadcast
CLEAR_EXCEPT_STARRED	boolean	if true, delete all the messages except the favourite messages
CALLBACK	ChatActionListener	callback to observe the action status

Java

ChatManager.clearChat(TO_JID, CHAT_TYPE, CLEAR_CHAT_EXCEPT_STARRED, (isSuccess, message) -> {

});

Kotlin

ChatManager.clearChat(TO_JID, CHAT_TYPE, CLEAR_EXCEPT_STARRED, object : ChatActionListener {

override fun onResponse(isSuccess: Boolean, message: String) {

}

})

caution

If clear chat feature unavailable for your plan then it will throw 403 exception.

Clear all conversation

You can clear the messages of all chats including group by using the below method.

Argument	Type	Description
CALLBACK	ChatActionListener	callback to observe the action status

Java

ChatManager.clearAllConversation((isSuccess, message) -> {

});

Kotlin

ChatManager.clearAllConversation(object : ChatActionListener {

override fun onResponse(isSuccess: Boolean, message: String) {

}

})

caution

If delete chat feature unavailable for your plan then it will throw 403 exception.