SDKsuni-app / uni-app x

Delete user messages

Purge all messages sent by a specific user within a group chat.

Invoke deleteUserAllMessagesInConv() to purge all messages sent by a specific member in a group conversation. This is an administrative moderation action; caller permissions are verified authoritatively by OpenIMServer.

Parameters

Parameter	Type	Required	Description
`conversationID`	`string`	Yes	Target group conversation ID.
`userID`	`string`	Yes	User ID of the member whose messages are being purged.

Code example

import { deleteUserAllMessagesInConv } from '@/uni_modules/unix-openim-sdk'

await deleteUserAllMessagesInConv({
  conversationID,
  userID: targetUserID,
})

Return value

The Promise resolves with void upon successful server processing.

Listen for user message purge events

Centrally register onDeleteUserAllMsgsInConv to capture group message purge notifications. The event provides an opaque string signal. Treat this signal as an invalidation trigger to reload current group history rather than relying on unexposed payload fields.

import {
  off,
  onDeleteUserAllMsgsInConv,
} from '@/uni_modules/unix-openim-sdk'

const handleUserMessagesDeleted = (_payload: string) => {
  reloadCurrentGroupHistory()
}

const userMessagesDeletedSubscription =
  onDeleteUserAllMsgsInConv(handleUserMessagesDeleted)

function removeUserMessagesDeletedListener() {
  off(userMessagesDeletedSubscription)
}

Promise resolution, event delivery, and re-querying the conversation history are three decoupled phases. Unregister the listener when unmounting views or switching accounts.

Was this page helpful?