OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse SDKs · WASM
SDKsWASMEnterprise

Delete messages in a batch

Delete multiple messages from one conversation for the current account with the WASM SDK.

Copy

Parameters

ParameterTypeRequiredDescription
conversationIDstringYesID of the conversation containing the messages to delete.
clientMsgIDsstring[]YesIDs of the messages to delete. Every ID in one batch must belong to the same conversation.
isSyncbooleanYesWhether to synchronize the deletion to the current account's other clients.
await openimsdk.deleteMessages({
  conversationID,
  clientMsgIDs: selectedMessageIDs,
  isSync: true,
});

With isSync: false, the operation deletes the current device's copy and the current account's server-side record. With true, it also requests deletion synchronization to the account's other clients. It does not delete copies held by other conversation members or display a revocation notice.

Promise completion means that the deletion request has completed. When synchronization is enabled, it does not mean that other clients have already received the event or updated their interfaces.

This page owns CbEvents.OnMsgDeleted. Its data is a MessageItem. Determine the conversation from the message routing fields, then remove it idempotently by clientMsgID.

import { CbEvents } from '@openim/wasm-client-sdk';

const handleMessageDeleted = ({ data }) => {
  removeMessage(resolveConversationID(data), data.clientMsgID);
};

openimsdk.on(CbEvents.OnMsgDeleted, handleMessageDeleted);

function removeMessageDeletedListener() {
  openimsdk.off(CbEvents.OnMsgDeleted, handleMessageDeleted);
}

Call removeMessageDeletedListener() when the component unmounts, the user logs out, or the active account changes. To reconcile the current message snapshot, query the corresponding conversation history again.