Revoke a message

Invoke revokeMessage() when a message needs to be withdrawn so that participants see a "Message was revoked" placeholder. Never substitute local or bulk deletion when the intent is to revoke the message for all chat participants.

Parameters

Code example

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

const clientMsgID = message.clientMsgID
if (clientMsgID == null) return

await revokeMessage({
  conversationID,
  clientMsgID,
})

Allowed revoking roles, time windows, and supported message types are authoritatively enforced by OpenIMServer. If the request fails, do not maintain a revoked placeholder in local state.

Return value

The Promise resolves with a confirmation string upon successful processing. It does not return a full updated message object; update your local UI model using the original clientMsgID optimistically, confirming state via subsequent queries if necessary.

Listen for revoked messages

Centrally register onNewRecvMessageRevoked to observe message revocations. When another user or device revokes a message, the SDK triggers onNewRecvMessageRevoked. Update the existing message bubble in your view model to its revoked placeholder state using conversationID:clientMsgID, rather than removing the message item completely from the list.

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

const handleMessageRevoked = (
  revoked: OpenIMMessageRevokedItem | null,
) => {
  if (revoked == null) return
  markMessageRevoked(revoked.clientMsgID, revoked)
}

const revokedSubscription =
  onNewRecvMessageRevoked(handleMessageRevoked)

function removeMessageRevokedListener() {
  off(revokedSubscription)
}

The OpenIMMessageRevokedItem object supplies revoker information, revocation timestamp, and revoker role, allowing you to format contextual system notices (for example, "Admin revoked a message"). Unregister the listener when the page unmounts or upon switching accounts.