浏览 SDKs · React Native
SDKsReact Native商业版

批量删除消息

OpenIM React Native SDK 批量删除消息。

复制

使用 deleteMessages() 批量删除同一会话中的消息。

await OpenIMSDK.deleteMessages({
  conversationID,
  clientMsgIDs,
  isSync: true,
});

参数说明

参数类型是否必填说明
conversationIDstring要删除消息所属的会话 ID。
clientMsgIDsstring[]要删除的消息 ID 列表;列表中的消息应属于同一会话。
isSyncboolean是否将删除操作同步给会话另一方。为 true 时,会话双方都会删除对应消息;为 false 时,仅当前账号删除。

调用完成后,删除请求已完成。isSynctrue 时,会话另一方也会删除对应消息;为 false 时,仅当前账号删除,无论取值如何,当前账号的删除都会同步到该账号的其他设备。

监听消息删除

消息删除时会触发 OnMsgDeleted,回调携带被删除的 MessageItem。根据 clientMsgID 更新对应会话的消息列表。

function handleMessageDeleted(message) {
  // ...
}

// 设置监听
OpenIMSDK.on(OpenIMEvent.OnMsgDeleted, handleMessageDeleted);

// 取消监听
OpenIMSDK.off(OpenIMEvent.OnMsgDeleted, handleMessageDeleted);

组件销毁、退出登录或切换账号时,取消监听。