撤回消息

超级群业务中，消息发送方可撤回已发送成功的消息。撤回成功后，服务端即删除原始消息。

撤回指定消息，只有已发送成功的消息可被撤回。

撤回指定消息

方法

recallUltraGroupMessage(
  message: RCIMIWMessage,
  deleteRemote: boolean,
  callback: IRCIMIWRecallUltraGroupMessageCallback
): Promise<number>;

参数说明

参数名	参数类型	描述
message	RCIMIWMessage	需要撤回的消息
deleteRemote	boolean	是否删除远端消息
callback	IRCIMIWRecallUltraGroupMessageCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

返回值	描述
Promise<number>	当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考状态码文档。

代码示例

let callback = {
onUltraGroupMessageRecalled:(res) => {
//...
}};
let code = await engine.recallUltraGroupMessage(message, deleteRemote, callback);

回调方法

• setOnUltraGroupMessageRecalledListener

setOnUltraGroupMessageRecalledListener(listener?: ({code, message, deleteRemote}) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
message	RCIMIWMessage	撤回的消息
deleteRemote	boolean	调用接口时传入的是否删除远端消息

代码示例

engine.setOnUltraGroupMessageRecalledListener((res) => {
    //...
});

监听远端消息撤回

当 SDK 与融云服务器的连接状态发生变化时，开发者可通过下面方法进行处理。

方法

setOnRemoteUltraGroupMessageRecalledListener(listener?: ({messages}) => void): void;

参数说明

参数名	参数类型	描述
messages	Array<RCIMIWMessage>	撤回的消息集合

代码示例

engine.setOnRemoteUltraGroupMessageRecalledListener((res) => {
    //...
});