tencent cloud

未读消息

未读消息是指用户没有读过的消息（而非对方是否已经阅读），TIMMessage 方法 isReaded 标识消息是否已读，要想显示正确的未读计数，需要开发者显式调用已读上报，告诉 App 某条消息是否已读。例如，当用户进入聊天界面，可以设置整个会话的消息已读。对于聊天室，Server 不保存未读计数，每次登录后跟 Server 同步未读计数后将会清零。

@interface TIMMessage : NSObject
/**
 *  是否已读
 *
 *  @return TRUE 已读  FALSE 未读
 */
- (BOOL)isReaded;
@end

获取当前未读消息数量

可通过 TIMConversation 的 getUnReadMessageNum 方法获取当前会话中未读消息的数量。对于聊天室，Server 不保存未读计数，每次登录后跟 Server 同步未读计数后将会清零。

原型：

@interface TIMConversation : NSObject
- (int)getUnReadMessageNum;
@end

示例：

TIMConversation * conversation = [[TIMManager sharedInstance] getConversation:TIM_C2C receiver:@"iOS_002"];
[conversation getUnReadMessageNum]; 

已读上报

当用户阅读某个会话的数据后，需要进行会话消息的已读上报，IM SDK 根据会话中最后一条阅读的消息，设置会话中之前所有消息为已读。

原型：

@interface TIMConversation : NSObject
/**
 *  设置已读消息
 *
 *  @param readed 会话内最近一条已读的消息，nil 表示上报最新消息
 *
 *  @param succ  成功时回调
 *  @param fail  失败时回调
 *
 *  @return 0 表示成功
 */
- (int)setReadMessage:(TIMMessage*)readed succ:(TIMSucc)succ fail:(TIMFail)fail;
@end

参数说明：

以下示例设置 C2C（单聊）会话内的所有消息为已读。
示例：

TIMConversation * conversation = [[TIMManager sharedInstance] getConversation:TIM_C2C receiver:@"iOS_002"];
[conversation setReadMessage:nil succ:nil fail:nil];

禁用自动上报

在单终端情况下，默认设置可以满足需求，出于性能考虑，未读消息由 IM SDK 拉回到本地，Server 默认会删除未读消息，切换终端以后无法看到之前终端已经拉回的未读消息，如果仅在一个终端，未读计数没有问题。如果需要多终端情况下仍然会有未读，可以在 TIMManager 初始化之前禁用自动上报，即时通信 IM 不会代替用户已读上报，一旦禁用自动上报，需要开发者显式调用 setReadMessage。

@interface TIMUserConfig: NSObject
/**
 *  禁止自动上报（加载消息扩展包有效）
 */
@property(nonatomic,assign) BOOL disableAutoReport;
@end

多终端已读同步

在2.0以上版本中引入的功能，在多终端情况下，未读消息计数由 Server 下发同步通知，IM SDK 在本地更新未读计数后，通知用户更新会话。此功能需要在 TIMManager 登录之前设置。

原型：

@protocol TIMRefreshListener <NSObject>
@optional
/**
 *  刷新部分会话（包括多终端已读上报同步）
 *
 *  @param conversations 会话（TIMConversation*）列表
 */
- (void)onRefreshConversations:(NSArray*)conversations;
@end
@interface TIMUserConfig : NSObject
/**
 *  会话刷新监听器（未读计数、已读同步）（加载消息扩展包有效）
 */
@property(nonatomic,retain) id<TIMRefreshListener> refreshListener;
@end