撤回消息
大约 1 分钟
撤回消息
发送方可以撤回一条发送成功的消息,包括已经发送的历史消息,离线消息或漫游消息。
默认情况下,发送方可撤回发出 2 分钟内的消息。你可以在环信即时通讯云控制台的功能配置 > 功能配置总览 > 基础功能页面设置消息撤回时长,该时长不超过 7 天。
提示
除了透传消息,其他各类型的消息都支持撤回。
技术原理
环信即时通讯 IM 通过 ChatManager
和 ChatMessage
类支持你撤回一条发送成功的消息:
recallMessage
:撤回一条发送成功的消息。
前提条件
开始前,请确保满足以下条件:
实现方法
撤回消息
调用该方法后,服务端的该条消息(历史消息,离线消息或漫游消息)以及消息发送方和接收方的内存和数据库中的消息均会被移除,消息的接收方会收到 onMessageRecalled
事件。
ChatClient.getInstance().chatManager()?.recallMessage(message, ext).then(()=> {
// success logic
})
设置消息撤回监听
你可以设置消息撤回监听,通过 onMessageRecalled
事件监听发送方对已接收的消息的撤回。
- 若用户在线接收了消息,消息撤回时,该事件中的
RecallMessageInfo
中的getRecallMessage
为撤回的消息的内容,getRecallMessageId
为返回撤回的消息的 ID。 - 若消息发送和撤回时接收方离线,该事件中的
RecallMessageInfo
中的getRecallMessage
为空,getRecallMessageId
为返回撤回的消息的 ID。
onMessageRecalled?: (messages: Array<RecallMessageInfo>) => void;