干货分享——使用融云通讯能力库 IMLib 实现单群聊的阅读回执

今天的干货分享是关于“阅读回执”功能,这是一个很普遍的功能,但是针对使用融云的 SDK 去实现,还是有些坑在等着我们的,下面就开始分(bì)享(kēng)喽~

  1. 分享之前先做一些准备工作,先找到我们需要调用的接口文档

  1. 根据不同的会话类型以及消息的发送方和接收方,要分别处理

    • 单聊

      接收方 :在阅读消息后,调用 RCIMClient 类的发送阅读回执接口,参数如下:

      ​ conversationType 单聊会话类型

      ​ targetId 消息的会话 ID

      ​ time 会话最后一条消息的发送时间(sentTime)

      /*!
       发送某个会话中消息阅读的回执
      
       @param conversationType    会话类型
       @param targetId            会话 ID
       @param timestamp           该会话中已阅读的最后一条消息的发送时间戳
       @param successBlock        发送成功的回调
       @param errorBlock          发送失败的回调[nErrorCode: 失败的错误码]
      
       @discussion 此接口只支持单聊, 如果使用 IMLib 可以注册监听
       RCLibDispatchReadReceiptNotification 通知,使用 IMKit 直接设置RCIM.h
       中的 enabledReadReceiptConversationTypeList。
      
       @warning 目前仅支持单聊。
      
       @remarks 高级功能
       */
      - (void)sendReadReceiptMessage:(RCConversationType)conversationType
                            targetId:(NSString *)targetId
                                time:(long long)timestamp
                             success:(void (^)(void))successBlock
                               error:(void (^)(RCErrorCode nErrorCode))errorBlock;
      

      发送方:监听下面这个通知,在接收后修改消息的展示

      /*!
       @const 收到已读回执的 Notification
      
       @discussion 收到消息已读回执之后,IMLib 会分发此通知。
      
       Notification 的 object 为 nil,userInfo 为 NSDictionary 对象,
       其中 key 值分别为 @"cType"、@"tId"、@"messageTime",
       对应的 value 为会话类型的 NSNumber 对象 、会话的 targetId 、已阅读的最后一条消息的 sendTime。
       如:
       NSNumber *ctype = [notification.userInfo objectForKey:@"cType"];
       NSNumber *time = [notification.userInfo objectForKey:@"messageTime"];
       NSString *targetId = [notification.userInfo objectForKey:@"tId"];
       NSString *fromUserId = [notification.userInfo objectForKey:@"fId"];
      
       收到这个消息之后可以更新这个会话中 messageTime 以前的消息 UI 为已读(底层数据库消息状态已经改为已读)。
      
       @remarks 事件监听
       */
      FOUNDATION_EXPORT NSString *const RCLibDispatchReadReceiptNotification;
      
    • 群聊

      发送方

      ​ 在发送消息 A 后,需要针对该消息发送回执请求,message 传之前发的消息 A

      /*!
       请求消息阅读回执
      
       @param message      要求阅读回执的消息
       @param successBlock 请求成功的回调
       @param errorBlock   请求失败的回调[nErrorCode: 失败的错误码]
      
       @discussion 通过此接口,可以要求阅读了这条消息的用户发送阅读回执。
      
       @remarks 高级功能
       */
      - (void)sendReadReceiptRequest:(RCMessage *)message
                             success:(void (^)(void))successBlock
                               error:(void (^)(RCErrorCode nErrorCode))errorBlock;
      

      ​ 设置下面代理函数,在接收到发送方发来的阅读回执响应后,修改消息的展示

      /*!
       IMlib消息接收的监听器
      
       @discussion
       设置IMLib的消息接收监听器请参考RCIMClient的setReceiveMessageDelegate:object:方法。
      
       @warning 如果您使用IMlib,可以设置并实现此Delegate监听消息接收;
       如果您使用IMKit,请使用RCIM中的RCIMReceiveMessageDelegate监听消息接收,而不要使用此监听器,否则会导致IMKit中无法自动更新UI!
       */
      @protocol RCIMClientReceiveMessageDelegate <NSObject>
        
      /*!
       消息已读回执响应(收到阅读回执响应,可以按照 messageUId 更新消息的阅读数)
       @param messageUId       请求已读回执的消息ID
       @param conversationType conversationType
       @param targetId         targetId
       @param userIdList 已读userId列表
       */
      - (void)onMessageReceiptResponse:(RCConversationType)conversationType
                              targetId:(NSString *)targetId
                            messageUId:(NSString *)messageUId
                            readerList:(NSMutableDictionary *)userIdList;
      
      

      接收方

      ​ 设置下面代理函数,在接收到消息 A 后,还会接收到针对消息 A 的阅读回执请求

      /*!
       IMlib消息接收的监听器
      
       @discussion
       设置IMLib的消息接收监听器请参考RCIMClient的setReceiveMessageDelegate:object:方法。
      
       @warning 如果您使用IMlib,可以设置并实现此Delegate监听消息接收;
       如果您使用IMKit,请使用RCIM中的RCIMReceiveMessageDelegate监听消息接收,而不要使用此监听器,否则会导致IMKit中无法自动更新UI!
       */
      @protocol RCIMClientReceiveMessageDelegate <NSObject>
      
      /*!
       请求消息已读回执(收到需要阅读时发送回执的请求,收到此请求后在会话页面已经展示该 messageUId 对应的消息或者调用
       getHistoryMessages 获取消息的时候,包含此 messageUId 的消息,需要调用 sendMessageReadReceiptResponse
       接口发送消息阅读回执)
      
       @param messageUId       请求已读回执的消息ID
       @param conversationType conversationType
       @param targetId         targetId
       */
      - (void)onMessageReceiptRequest:(RCConversationType)conversationType
                             targetId:(NSString *)targetId
                           messageUId:(NSString *)messageUId;
      

      ​ 在代理方法中,调用下面接口发送阅读回执响应给发送方

      /*!
       发送阅读回执
      
       @param conversationType 会话类型
       @param targetId         会话 ID
       @param messageList      已经阅读了的消息列表
       @param successBlock     发送成功的回调
       @param errorBlock       发送失败的回调[nErrorCode: 失败的错误码]
      
       @discussion 当用户阅读了需要阅读回执的消息,可以通过此接口发送阅读回执,消息的发送方即可直接知道那些人已经阅读。
      
       @remarks 高级功能
       */
      - (void)sendReadReceiptResponse:(RCConversationType)conversationType
                             targetId:(NSString *)targetId
                          messageList:(NSArray<RCMessage *> *)messageList
                              success:(void (^)(void))successBlock
                                error:(void (^)(RCErrorCode nErrorCode))errorBlock;
      

总结

阅读回执需要区分会话类型处理,且单聊的阅读回执是针对会话的,群聊的阅读回执是针对某一条消息的:

​ 单聊:接收方阅读某个会话的消息后,发送阅读回执 ——发送方接到阅读回执,更新 UI

​ 群聊:发送方发送消息 A, 针对该消息,发送阅读回执请求 —— 接收方实现监听代理,接收到消息 A 的阅读回执请求 —— 接收方发送阅读回执响应 —— 发送方收到阅读回执响应,更新 UI

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,402评论 6 499
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,377评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,483评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,165评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,176评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,146评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,032评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,896评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,311评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,413评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,008评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2 353

推荐阅读更多精彩内容