网易云信 NIM iOS SDK 的NIMChatManagerDelegate协议和NIMChatManager协议，分别提供监听消息撤回和撤回消息的方法。

• SDK 支持多种消息撤回类型，如单聊单向撤回和群聊双向撤回，可通过NIMRevokeMessageNotificationType设置。
• SDK 支持多种消息撤回通知类型，如在线通知、离线通知和漫游通知，可通过NIMRevokeMessageNotification对象的offline属性判断是否为离线通知，roaming属性判断是否为漫游通知。

功能介绍

前提条件

已完成 SDK 初始化。

实现流程

不同类型消息撤回的流程相似，本节以用户A（消息发送方）与 用户B（消息接收方）的单聊消息交互为例，介绍单聊消息双向撤回的实现流程。

sequenceDiagram



note over NIM SDK: 初始化
发送方 ->> NIM SDK: 初始化SDK
note left of 发送方 : 初始化时配置是否将被撤回消息<br>计入未读数计算
接收方 ->> NIM SDK: 初始化SDK
note over NIM SDK: 发送方注册监听并登录
发送方 ->> NIM SDK: 监听消息撤回
接收方 ->> NIM SDK: 登录
note over NIM SDK: 接收方注册监听并登录
接收方 ->> NIM SDK: 监听消息撤回
接收方 ->> NIM SDK: 监听消息接收
接收方 ->> NIM SDK: 登录
note over NIM SDK: 发送消息
发送方 ->> NIM SDK: 构造并发送消息
note over NIM SDK: 发送方撤回消息
发送方 ->> NIM SDK: 撤回消息
发送方 ->> NIM SDK: 判定是否将消息撤回通知展示在通知栏
NIM SDK ->> 发送方: NIMRevokeMessageNotification
NIM SDK ->> 接收方: NIMRevokeMessageNotification

流程具体说明：

1. 发送方在初始化 SDK 时，通过NIMSDKConfig#shouldConsiderRevokedMessageUnreadCount配置被撤回的消息是否计入未读数计算。

   • 该参数默认值为 NO。设置成 YES 的情况下，如果被撤回的消息本地还未读，那么当消息发生撤回时，对应会话的未读计数将减 1 以保持最近会话未读数的一致性。
   • 默认为 NO 的原因是，客户端常常需要在撤回成功后在会话内写入一条“您已撤回一条消息”的提示消息用于提醒显示。使用 NO 作为默认值直接写入一条已读提示消息，可避免未读计数发生两次变化，最终导致界面重复刷新。如果客户场景不需要写入提示消息，可以设置为 YES，以保持未读计数的一致性。

2. 发送方和接收方在登录 IM 前，调用 addDelegate: 方法添加委托，注册onRecvRevokeMessageNotification:回调函数，监听消息撤回。

   示例代码如下：

   - (void)onRecvRevokeMessageNotification:(NIMRevokeMessageNotification *)notification
   {
       //your code    
   }
   

3. 发送方在发送消息后，按需调用以下三种中的任意一种方法撤回消息。

   撤回消息的方法	说明
   revokeMessage:completion:	撤回消息，撤回不会触发推送消息
   revokeMessage:apnsContent:apnsPayload:shouldBeCounted:completion:	撤回消息，并触发推送。同时可配置推送文案与附加信息apnsPayload，以及消息撤回系统通知是否计入未读数
   revokeMessage:option:completion:	撤回消息，消息撤回系统通知计入未读数。可通过NIMRevokeMessageOption设置撤回选项，其中包括撤回的附言和撤回扩展字段等

   在撤回消息成功后， SDK 会先将消息撤回通知（NIMRevokeMessageNotification）回调给上层应用，再自动将本地的这条消息删除。如果需要在撤回后在会话内显示一条“您撤回了一条消息”的提示，您可以自行构造一条提示消息并调用插入本地消息的方法，具体请参见提示消息收发。

   • 以下情况消息撤回会失败：
     • 消息并没有被 IM 服务端成功投递到对端。
     • 消息超过撤回时限。
     • 消息对象不是从本地数据库获取的。

   示例代码如下：

   //获取到了发送成功后的message，就可以撤回
   [[NIMSDK sharedSDK].chatManager revokeMessage:message
                                       apnsContent:@"TEST"
                                       apnsPayload:nil
                                   shouldBeCounted:YES
                                       completion:^(NSError * _Nullable error)
   {
       //your code
   }];
   

4. （可选）如果被撤消息已经通过 APNs 推送到客户端，可以通过设置apnsPayload来实现将原通知栏文案替换为apnsContent的效果。具体参见通知栏内容覆盖。