/******************************************************************************
 *
 *  本文件声明了用于实现消息收发逻辑的控制器类。
 *  消息控制器负责统一显示您发送/收到的消息，同时在您对这些消息进行交互（点击/长按等）时提供响应回调。
 *  消息控制器还负责对您发送的消息进行统一的数据处理，使其变为可以通过 IM SDK 发送的数据格式并进行发送。
 *  也就是说，当您使用本控制器时，您可以省去很大部分的数据处理上的工作，从而能够更快捷、更方便的接入 IM SDK。
 *
 *  TMessageControllerDelegate 协议和 TUIMessageController 类。
 *  TUIMessageController 是聊天界面的核心类，负责聊天界面大部分核心业务逻辑的处理与运算。
 *  该类的详细属性与功能，请参展本文件中 TUIMessageController 的具体声明。
 *
 ******************************************************************************/
#import <UIKit/UIKit.h>
#import "TUIMessageCell.h"

#import "TUIMessageControllerDelegate.h"
#import "TUIChatConversationModel.h"

@class TUIConversationCellData;
@class TUIMessageController;
@class TUIReplyMessageCell;

typedef NS_ENUM(NSInteger, TUIMultiResultOption) {
    TUIMultiResultOptionAll     = 0,                            // 获取所有选中的结果
    TUIMultiResultOptionFiterUnsupportRelay = 1 << 0,           // 过滤掉不支持转发
};

/////////////////////////////////////////////////////////////////////////////////
//
//                         TUIMessageController
//
/////////////////////////////////////////////////////////////////////////////////

/** 腾讯云 TUIKit
 * 【模块名称】TUIMessageController
 * 【功能说明】消息控制器，负责实现消息的接收、发送、显示等一系列业务逻辑。
 *  本类提供了接收/显示新消息、显示/隐藏菜单、点击消息头像等交互操作的回调接口。
 *  同时本类提供了图像、视频、文件信息的发送功能，直接整合调用了 IM SDK 实现发送功能。
 */
@interface TUIMessageController : UITableViewController

/**
 *  执行 TUIMessageControllerDelegate 协议的委托
 *
 *  我们不建议您直接修改 TUIMessageController 中的回调委托。
 *  TUIMessageController 的回调委托在 TUIBaseChatController 中实现，负责大部分核心功能。如果您对此修改，可能会对一系列回调委托的调用关系造成破坏。
 *  如果您需要实现 onNewMessage、onShowMessageData 的回调，您可以参照 Section\Chat\TUIChatController.h 中的链接与注释进行调用并实现自定义消息处理。
 */
@property (nonatomic, weak) id<TUIMessageControllerDelegate> delegate;

/**
 *  是否在当前 VC 界面
 */
@property (nonatomic, assign) BOOL isInVC;

/**
 *  发送消息
 */
- (void)sendMessage:(V2TIMMessage *)msg;

/**
 *  滚动至底部
 *  通过对 tableView 进行设置，使当前视图滚动至底部。
 *  建议在需要返回至消息视图底部或者需要浏览最新信息时调用，比如每次发送消息、接收消息、撤回消息、删除消息时。
 *  本函数的实现调用了 tableView 的滑动函数：
 * <pre>
 *  [self.tableView scrollToRowAtIndexPath:[NSIndexPath indexPathForRow:uiMsgs.count - 1 inSection:0] atScrollPosition:UITableViewScrollPositionBottom animated:animate];
 * </pre>
 *  其中第一个参数出现的 uiMsgs，即当前消息控制器中已接收到并展示的消息数组。
 *
 *  @param animate 动画标志位。YES：启用动画；NO：禁用动画。
 */
- (void)scrollToBottom:(BOOL)animate;

/**
 *  设置会话
 *
 */
- (void)setConversation:(TUIChatConversationModel *)conversationData;

/**
 * 开启多选模式
 *
 * @param enable 是否开启多选模式
 */
- (void)enableMultiSelectedMode:(BOOL)enable;

/**
 * 开启多选模式后，获取当前选中的结果
 * 如果多选模式关闭，返回空数组
 *
 * @param option 获取结果的选项
 * @return 选中的数据
 */
- (NSArray<TUIMessageCellData *> *)multiSelectedResult:(TUIMultiResultOption)option;

/**
 * 批量删除消息
 *
 * @param uiMsgs 待删除的数据
 */
- (void)deleteMessages:(NSArray<TUIMessageCellData *> *)uiMsgs;

/**
 * 子类实现点击回复消息
 */
- (void)showReplyMessage:(TUIReplyMessageCell *)cell;

/*
 * 子类监听媒体消息的显示和关闭
 */
- (void)willShowMediaMessage:(TUIMessageCell *)cell;
- (void)didCloseMediaMessage:(TUIMessageCell *)cell;

@end