Browse SDKs · HarmonyOS
Platform
SDKsHarmonyOSEnterprise

Delete all messages by user in group chat

Delete all messages sent by a specified user within a target group conversation.

Copy

This is a high-impact administrative moderation action and should not appear in regular single-message context menus. Permissions are enforced by OpenIMServer.

Code example

import sdk, {
  DeleteUserAllMessagesInConvReq,
  EventOnDeleteUserAllMsgsInConvData,
  OpenIMSDKEvent,
} from '@openimsdk/imsdk';

const request: DeleteUserAllMessagesInConvReq = {
  conversationID: conversationID,
  userID: targetUserID,
};
await sdk.deleteUserAllMessagesInConv(request);

const handleUserMessagesDeleted = (data: EventOnDeleteUserAllMsgsInConvData): void => {
  reloadGroupHistory(data.conversationID, data.userID);
};
const unsubscribeUserMessagesDeleted = sdk.on(
  OpenIMSDKEvent.EventOnDeleteUserAllMsgsInConv,
  handleUserMessagesDeleted,
);

export function removeUserMessagesDeletedListener(): void {
  unsubscribeUserMessagesDeleted();
}

Parameters

ParameterTypeRequiredDescription
conversationIDstringYesTarget group conversation identifier.
userIDstringYesUser ID whose messages should be purged.

Return value

Returns a Promise that resolves to void upon server acceptance.

State changes after the call

conversationID must identify a group conversation. Clients can filter and purge in-memory messages by matching conversationID and userID. Promise resolution does not imply that other clients have already re-rendered their timeline. Once the event arrives, reload affected conversation history from the server. Unregister the listener when tearing down the state layer.