1v1_7/MSYOUPAI/3rd/NIMChat/NIMSDK/NIMSDK.framework/Headers/NIMConversationManagerProtocol.h

//
//  NIMConversationManager.h
//  NIMLib
//
//  Created by Netease.
//  Copyright (c) 2015 Netease. All rights reserved.
//

#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

@class NIMMessage;
@class NIMSession;
@class NIMRecentSession;
@class NIMRecentSessionOption;
@class NIMHistoryMessageSearchOption;
@class NIMMessageSearchOption;
@class NIMDeleteMessagesOption;
@class NIMImportedRecentSession;
@class NIMMessageReceipt;
@class NIMTeamMessageReceiptDetail;
@class NIMClearMessagesOption;
@class NIMBatchDeleteMessagesOption;
@class NIMFetchServerSessionOption;
@class NIMMessageServerRetrieveOption;
/**
 *  读取服务器消息记录block
 *
 *  @param error  错误,如果成功则error为nil
 *  @param messages 读取的消息列表
 */
typedef void(^NIMFetchMessageHistoryBlock)(NSError * __nullable error,NSArray<NIMMessage *> * __nullable messages);

/**
 *  服务器消息检索记录block
 *
 *  @param error  错误,如果成功则error为nil
 *  @param messages 读取的消息列表
 */
typedef void(^NIMRetrieveServerMessagesBlock)(NSError * __nullable error,NSArray<NIMMessage *> * __nullable messages);

/**
 *  删除本地消息记录block
 *
 *  @param error  错误,如果成功则error为nil
 */
typedef void (^NIMBatchDeleteMessagesBlock)(NSError * __nullable error);

/**
 *  更新本地消息 Block
 *
 *  @param error  错误,如果成功则error为nil
 */
typedef void(^NIMUpdateMessageBlock)(NSError * __nullable error);

/**
 *  导入本地最近会话 Block
 *
 *  @param error  错误,如果成功则error为nil
 *  @param failedImportedRecentSessions  导入失败的最近会话
 */
typedef void(^NIMImportRecentSessionsBlock)(NSError * __nullable error, NSArray<NIMImportedRecentSession *> * __nullable failedImportedRecentSessions);


/**
 *  标记远端会话Block
 *
 *  @param error  错误,如果成功则error为nil
 */
typedef void(^NIMRemoveRemoteSessionBlock)(NSError * __nullable error);


/**
 *  搜索本地消息记录Block
 *
 *  @param error  错误,如果成功则error为nil
 *  @param messages 读取的消息列表
 *  @discussion 只有在传入参数错误时才会有error产生
 */
typedef void(^NIMSearchMessageBlock)(NSError * __nullable error,NSArray<NIMMessage *> * __nullable messages);

/**
 *  全局搜索本地消息记录Block
 *
 *  @param error      错误,如果成功则error为nil
 *  @param messages   读取的消息列表
 */
typedef void(^NIMGlobalSearchMessageBlock)(NSError * __nullable error,NSDictionary<NIMSession *,NSArray<NIMMessage *> *> * __nullable messages);

/**
 导出历史消息进度回调

 @param progress 进度 0-100
 */
typedef void(^NIMExportMessageProgress)(float progress);

/**
 导出历史消息完成回调

 @param error 错误，如果成功则为 nil
 @param resultFilePath 如果成功，则为结果文件路径
 */
typedef void(^NIMExportMessageComletion)(NSError * __nullable error, NSString * __nullable resultFilePath);

/**
 导入历史消息进度回调

 @param progress 进度 0-100
 */
typedef void(^NIMImportMessageProgress)(float progress);

/**
 导入历史消息完成回调

 @param error 错误，如果成功则为 nil
 */
typedef void(^NIMImportMessageCompletion)(NSError * __nullable error);

/**
 更新服务器历史备份文件结果回调

 @param error 错误，如果成功则为 nil
 */
typedef void(^NIMUpdateMigrateMessageCompletion)(NSError * __nullable error);

/**
 获取历史备份文件结果回调

 @param error 错误，如果成功则为 nil
 @param remoteFilePath 备份文件远端路径
 @param secureKey 备份文件解密的 key
 */
typedef void(^NIMFetchMigrateMessageCompletion)(NSError * __nullable error, NSString * __nullable remoteFilePath, NSString * __nullable secureKey);


/**
 *  读取服务器会话列表block
 *
 *  @param error  错误,如果成功则error为nil
 *  @param recentSessions 读取的消息列表
 *  @param minTimestamp 最小时间戳只有请求第一页时会返回这个参数，表示下一次增量同步时带在请求参数里
 */
typedef void(^NIMFetchRecentSessionsHistoryBlock)(NSError * __nullable error,
                                                 NSArray<NIMRecentSession *> * __nullable recentSessions,
                                                 BOOL hasMore);

/**
 *  读取服务器会话block
 *
 *  @param error  错误,如果成功则error为nil
 *  @param recentSession 结果会话
 */
typedef void(^NIMFetchRecentSessionHistoryBlock)(NSError * __nullable error,
                                                 NIMRecentSession * _Nullable  recentSession);

/**
*  更新服务端端会话扩展
*
*  @param error  错误,如果成功则error为nil
*/
typedef void(^NIMRemoteRecentSessionBlock)(NSError * __nullable error);


/**
 清空会话消息完成时状态回调
 */
typedef NS_ENUM(NSUInteger, NIMClearMessagesStatus)
{
    NIMClearMessagesStatusLocalCleared = 0,
    NIMClearMessagesStatusServerCleared,
    NIMClearMessagesStatusServerFailed,
};


/**
 *  会话管理器回调
 */
@protocol NIMConversationManagerDelegate <NSObject>

@optional

/**
*  最近会话数据库读取完成
*
*  @discussion 所有最近会话读取完成。设置NIMSDKConfig中的asyncLoadRecentSessionEnabled属性为YES时，此回调会执行。
*              该回调执行表示最近会话全部加载完毕可以通过allRecentSessions来取全部对话。
*/
- (void)didLoadAllRecentSessionCompletion;


/**
 *  增加最近会话的回调
 *
 *  @param recentSession    最近会话
 *  @param totalUnreadCount 目前总未读数
 *  @discussion 当新增一条消息，并且本地不存在该消息所属的会话时，会触发此回调。
 */
- (void)didAddRecentSession:(NIMRecentSession *)recentSession
           totalUnreadCount:(NSInteger)totalUnreadCount;

/**
 *  最近会话修改的回调
 *
 *  @param recentSession    最近会话
 *  @param totalUnreadCount 目前总未读数
 *  @discussion 触发条件包括: 1.当新增一条消息，并且本地存在该消息所属的会话。
 *                          2.所属会话的未读清零。
 *                          3.所属会话的最后一条消息的内容发送变化。(例如成功发送后，修正发送时间为服务器时间)
 *                          4.删除消息，并且删除的消息为当前会话的最后一条消息。
 */
- (void)didUpdateRecentSession:(NIMRecentSession *)recentSession
              totalUnreadCount:(NSInteger)totalUnreadCount;

/**
 *  删除最近会话的回调
 *
 *  @param recentSession    最近会话
 *  @param totalUnreadCount 目前总未读数
 */
- (void)didRemoveRecentSession:(NIMRecentSession *)recentSession
              totalUnreadCount:(NSInteger)totalUnreadCount;


/**
 *  单个会话里所有消息被删除的回调
 *
 *  @param session 消息所属会话
 */
- (void)messagesDeletedInSession:(NIMSession *)session;

/**
 *  所有消息被删除的回调
 */
- (void)allMessagesDeleted;

/**
 *  单个会话所有消息在本地和服务端都被清空
 *  @param session 消息所属会话
 */
- (void)allMessagesClearedInSession:(NIMSession *)session step:(NIMClearMessagesStatus)step;

/**
 *  所有消息已读的回调
 */
- (void)allMessagesRead;

/**
 *  会话服务，会话更新
 *
 *  @param 会话
 */
- (void)didServerSessionUpdated:(nullable NIMRecentSession *)recentSession;


@end

/**
 导出历史消息过程 delegate，可用于处理自定义消息
 */
@protocol NIMExportMessageDelegate <NSObject>

@optional

/**
 是否导出消息，YES - 导出，NO -不导出

 @param message 消息体
 @return YES / NO
 */
- (BOOL)shouldExportMessage:(NIMMessage *)message;

/**
 消息导出前的通知回调

 @param message 将导出的消息
 */
- (void)onMessageWillExport:(NIMMessage *)message;

@end

/**
 导入历史消息过程 delegate,可用于处理自定义消息
 */
@protocol NIMImportMessageDelegate <NSObject>

@optional

/**
 是否导入消息，YES - 导入，NO -不导入
 
 @param message 消息体
 @return YES / NO
 */
- (BOOL)shouldImportMessage:(NIMMessage *)message;

/**
 消息导入前的通知回调

 @param message 消息体
 */
- (void)onMessageWillImport:(NIMMessage *)message;

@end

/**
 *  会话管理器
 */
@protocol NIMConversationManager <NSObject>

/**
 *  删除某条消息
 *
 *  @param message 待删除的聊天消息
 */
- (void)deleteMessage:(NIMMessage *)message;

/**
 *  删除某个会话的所有消息
 *
 *  @param session 待删除会话
 *  @param option 删除消息选项
 */
- (void)deleteAllmessagesInSession:(NIMSession *)session
                            option:(nullable NIMDeleteMessagesOption *)option;

/**
 *  删除所有会话消息
 *
 *  @param option 删除消息选项
 *  @discussion 调用这个接口只会触发allMessagesDeleted这个回调，其他针对单个recentSession的回调都不会被调用
 */
- (void)deleteAllMessages:(nullable NIMDeleteMessagesOption *)option;


/**
 *  删除指定范围内的消息，如指定时间范围
 *
 *  @param session 目标会话
 *  @param option 删除消息选项
 *  @param block 完成回调
 */
- (void)deleteMessagesInSession:(NIMSession *)session
                         option:(nullable NIMBatchDeleteMessagesOption *)option
                     completion:(nullable NIMBatchDeleteMessagesBlock)block;

/**
 *  增加某个最近会话
 *
 *  @param session 待增加的最近会话
 *  @discussion 异步方法
 */
- (void)addEmptyRecentSessionBySession:(NIMSession *)session;

/**
 *  删除某个最近会话
 *
 *  @param recentSession 待删除的最近会话
 *  @discussion 异步方法，删除最近会话，但保留会话内消息
 */
- (void)deleteRecentSession:(NIMRecentSession *)recentSession;

/**
 *  设置所有会话消息为已读
 *
 *  @discussion 异步方法，消息会标记为设置的状态。不会触发单条 recentSession 更新的回调，但会触发回调 - (void)allMessagesRead
 */
- (void)markAllMessagesRead;


/**
 *  设置一个会话里所有消息置为已读
 *
 *  @param session 需设置的会话
 *  @discussion 异步方法，消息会标记为设置的状态
 */
- (void)markAllMessagesReadInSession:(NIMSession *)session;



/**
 *  更新本地已存的消息记录
 *
 *  @param message 需要更新的消息
 *  @param session 需要更新的会话
 *  @param completion 完成后的回调
 *  @discussion 为了保证存储消息的完整性,提供给上层调用的消息更新接口只允许更新如下字段:所有消息的本地拓展字段(LocalExt)和自定义消息的消息对象(messageObject)
 */
- (void)updateMessage:(NIMMessage *)message
           forSession:(NIMSession *)session
           completion:(nullable NIMUpdateMessageBlock)completion;


/**
 *  写入消息
 *
 *  @param message 需要更新的消息
 *  @param session 需要更新的会话
 *  @param completion 完成后的回调
 *  @discussion 当保存消息成功之后，会收到 NIMChatManagerDelegate 中的 onRecvMessages: 回调。不允许插入已存在的消息
 */
- (void)saveMessage:(NIMMessage *)message
         forSession:(NIMSession *)session
         completion:(nullable NIMUpdateMessageBlock)completion;



/**
 *  导入最近会话
 *
 *  @param importedRecentSession 待导入的会话集合
 *  @param completion 完成后的回调
 *  @discussion 当导入最近会话成功之后，不会收到 NIMChatManagerDelegate 中的 recentSession 变化的回调，请直接在 completion 中做处理。不允许插入已经存在的最近会话。
 */
- (void)importRecentSessions:(NSArray<NIMImportedRecentSession *> *)importedRecentSession
                  completion:(nullable NIMImportRecentSessionsBlock)completion;


/**
 *  从本地db读取一个会话里某条消息之前的若干条的消息
 *
 *  @param session 消息所属的会话
 *  @param message 当前最早的消息,没有则传入nil
 *  @param limit   个数限制
 *
 *  @return 消息列表，按时间从小到大排列
 */
- (nullable NSArray<NIMMessage *> *)messagesInSession:(NIMSession *)session
                                              message:(nullable NIMMessage *)message
                                                limit:(NSInteger)limit;


/**
 *  根据消息Id获取消息
 *
 *  @param session    消息所属会话结合
 *
 *  @param messageIds 消息Id集合
 *
 *  @return 消息列表,按时间从小到大排列
 */
- (nullable NSArray<NIMMessage *> *)messagesInSession:(NIMSession *)session
                                           messageIds:(NSArray<NSString *> *)messageIds;

/**
 *  获取所有未读数
 *  @discussion 只能在主线程调用,包括忽略提醒的会话
 *  @return 未读数
 */
- (NSInteger)allUnreadCount;


/**
 *  获取所有需要通知/不需要通知的最近会话未读数
 *  @param notify 是否需要通知
 *  @return 未读数
 *  @discussion 群只有 notify state != NIMTeamNotifyStateNone 才算是不允许通知
 */
- (NSInteger)allUnreadCount:(BOOL)notify;

/**
 *  获取所有最近会话。
 *  @return 最近会话列表
 *  @discussion SDK 以 map 的形式保存 sessions，调用这个方法时将进行排序，数据量较大 (上万) 时会比较耗时。
 *              该方法默认是同步查询所有sessions，当数据量较大（上万）会比较耗时，可能会卡主线程，这种情况下
 *              用户可以配置NIMSDKConfig中的asyncLoadRecentSessionEnabled属性为YES，此时该接口可以先返回
 *              100条最近会话，等全部加载完会回调didLoadAllRecentSessionCompletion，此后再调用该接口可以全量返回
 *              所有会话，用户需要在didLoadAllRecentSessionCompletion回调中及时更新UI展示。
 */
- (nullable NSArray<NIMRecentSession *> *)allRecentSessions;

/**
 *  获取所有最近会话
 *  @return 最近会话列表
 *  @discussion SDK 以 map 的形式保存 sessions，调用这个方法时将进行排序，数据量较大 (上万) 时会比较耗时。
 *  通过该接口获取的最近会话列表与allRecentSessions接口不同，是基于allRecentSessions接口筛选类型之后重新生成的新对象
 *  需要用户自行在外部管理，所有回调不回回调该接口查询的任何会话
 */
- (nullable NSArray<NIMRecentSession *> *)allRecentSessionsWithOption:(NIMRecentSessionOption *)option;

/**
 *  根据当前 session 返回对应的最近会话信息
 *
 *  @param session 会话
 *
 *  @return 最近会话信息，如果找不到则返回 nil
 */
- (nullable NIMRecentSession *)recentSessionBySession:(NIMSession *)session;


/**
*  从服务端分页获取历史会话列表
*
*  @param option 分页查询选项，可为空，空时默认全量获取
*
*  @param completion 完成回调
*/
- (void)fetchServerSessions:(nullable NIMFetchServerSessionOption *)option
                 completion:(nullable NIMFetchRecentSessionsHistoryBlock)completion;


/**
 *  从服务端获取会话信息
 *
 *  @param session 目标会话
 *
 *  @param completion 完成回调
 */
- (void)fetchServerSessionBySession:(NIMSession *)session
                         completion:(nullable NIMFetchRecentSessionHistoryBlock)completion;


/**
*  更新服务端获取会话扩展信息
*
*  @param ext        扩展信息
*
*  @param session    目标最近会话
*
*  @param completion 完成回调
*/
- (void)updateServerSessionExt:(NSString *)ext
                       session:(NIMSession *)session
                    completion:(nullable NIMRemoteRecentSessionBlock)completion;

/**
*  删除服务端
*
*  @param sessions 目标会话
*
*  @param completion 完成回调
*/
- (void)deleteServerSessions:(NSArray<NIMSession *> *)sessions
                  completion:(nullable NIMRemoteRecentSessionBlock)completion;
                        

/**
 *  从服务器上获取一个会话里某条消息之前的若干条的消息
 *
 *  @param session 消息所属的会话
 *  @param option  搜索选项
 *  @param result  读取的消息列表结果
 *  @discussion    此接口不支持查询聊天室消息，聊天室请参考 NIMChatroomManagerProtocol 中的查询消息接口。
 *
 */
- (void)fetchMessageHistory:(NIMSession *)session
                     option:(NIMHistoryMessageSearchOption *)option
                     result:(nullable NIMFetchMessageHistoryBlock)result;




/**
 *  根据关键字从服务器上检索消息
 *
 *  @param session 消息所属的会话
 *  @param option  检索选项
 *  @param result  读取的消息列表结果
 *  @discussion    检索消息内容，大小写不敏感；此接口不支持查询聊天室消息，聊天室请参考 NIMChatroomManagerProtocol 中的消息接口。
 *
 */
- (void)retrieveServerMessages:(NIMSession *)session
                        option:(NIMMessageServerRetrieveOption *)option
                        result:(nullable NIMRetrieveServerMessagesBlock)result;

/**
 *  搜索本地会话内消息
 *
 *  @param session 消息所属的会话
 *  @param option  搜索选项
 *  @param result  读取的消息列表结果
 *
 */
- (void)searchMessages:(NIMSession *)session
                option:(NIMMessageSearchOption *)option
                result:(nullable NIMSearchMessageBlock)result;

/**
 *  全局搜索本地消息
 *
 *  @param option 搜索选项
 *  @param result 读取的消息内容
 */
- (void)searchAllMessages:(NIMMessageSearchOption *)option
                   result:(nullable NIMGlobalSearchMessageBlock)result;



/**
 *  删除服务器端最近会话
 *
 *  @param sessions   需要删除的会话列表，内部只能是NIMSession
 *  @param completion 完成的回调
 *  @discussion       调用这个接口成功后，当前会话之前的消息都不会漫游到其他端
 */
- (void)deleteRemoteSessions:(NSArray<NIMSession *> *)sessions
                  completion:(nullable NIMRemoveRemoteSessionBlock)completion;

/**
 *  清空点对点会话对应本地和服务端的消息
 *
 *  @param session 目标会话列表
 *  @param option 清空消息选项
 *  @param completion 完成回调
 *  @discussion 只支持点对点，清空本用户的本地和服务端消息，不影响对方；如果不设置清空选项，服务端默认会同时清空漫游消息；
 */
- (void)deleteSelfRemoteSession:(NIMSession *)session
                         option:(nullable NIMClearMessagesOption *)option
                     completion:(nullable NIMRemoveRemoteSessionBlock)completion;

/**
 *  更新最近会话的本地扩展
 *
 *  @param ext           扩展信息
 *  @param recentSession 要更新的最近会话
 *  @discussion          此扩展不会漫游到其他端,上层需要保证 NSDictionary 可以转换为 JSON。
 */
- (void)updateRecentLocalExt:(nullable NSDictionary *)ext
               recentSession:(NIMRecentSession *)recentSession;


/**
 导出历史消息到本地文件

 @param delegate 自定义消息的处理 delegate
 @param progress 导出进度更新回调
 @param completion 导出完成回调
 */
- (void)exportMeessageInfosWithDelegate:(id<NIMExportMessageDelegate>)delegate
                               progress:(NIMExportMessageProgress)progress
                             completion:(NIMExportMessageComletion)completion;


/**
 导入历史消息

 @param infoFilePath 已解码并序列化了的本地历史消息文件路径
 @param delegate 自定义消息的处理 delegate
 @param progress 导入进度更新回调
 @param completion 导入完成回调
 */
- (void)importMessageInfosAtPath:(NSString *)infoFilePath
                        delegate:(id<NIMImportMessageDelegate>)delegate
                        progress:(NIMImportMessageProgress)progress
                      completion:(NIMImportMessageCompletion)completion;


/**
 取消 导出/导入 历史消息操作
 */
- (void)cancelMigrateMessages;


/**
 更新历史消息备份信息

 @param URL 历史消息备份的 URL
 @param key 历史消息备份的加密 key
 @param completion 更新信息的完成回调
 */
- (void)updateMigrateMessageInfoWithURL:(NSString *)URL key:(NSString *)key completion:(NIMUpdateMigrateMessageCompletion)completion;


/**
 获取历史消息备份信息

 @param completion 获取历史消息备份的完成回调
 */
- (void)fetchMigrateMessageInfo:(NIMFetchMigrateMessageCompletion)completion;

/**
 反序列化消息数据

 @param encodeData 序列化的数据
 @return 消息对象
 @discussion  此接口用于反序列化消息的数据，请与encodeMessageToData配套使用，用于实现消息本地序列化
*/
- (NIMMessage *)decodeMessageFromData:(NSData *)encodeData;

/**
 序列化消息

 @param message 消息对象
 @return 序列化数据
 @discussion  此接口用于序列化消息，请与decodeMessageFromData配套使用，用于实现消息本地序列化
*/
- (NSData *)encodeMessageToData:(NIMMessage *)message;

/**
 *  添加通知对象
 *
 *  @param delegate 通知对象
 */
- (void)addDelegate:(id<NIMConversationManagerDelegate>)delegate;

/**
 *  删除通知对象
 *
 *  @param delegate 通知对象
 */
- (void)removeDelegate:(id<NIMConversationManagerDelegate>)delegate;

@end

NS_ASSUME_NONNULL_END