会话列表的基本设置

本文介绍如何通过 ChatUIKitConversationListFragment 实现会话列表的基本设置，包括会话列表空页面和设置会话事件监听。

会话列表 ChatUIKitConversationListFragment

基本设置

使用示例

ChatUIKitConversationListFragment 提供了 Builder 构建方式，支持会话自定义设置。使用示例如下：

ChatUIKitConversationListFragment.Builder()
    .useTitleBar(true)
    .setTitleBarTitle("title")
    .enableTitleBarPressBack(true)
    .setTitleBarBackPressListener(onBackPressListener)
    .useSearchBar(false)
    .setItemClickListener(onItemClickListener)
    .setOnItemLongClickListener(onItemLongClickListener)
    .setOnMenuItemClickListener(onMenuItemClickListener)
    .setConversationChangeListener(conversationChangeListener)
    .setEmptyLayout(R.layout.layout_conversation_empty)
    .setCustomAdapter(customAdapter)
    .setCustomFragment(myConversationListFragment)
    .build()

方法列表

ChatUIKitConversationListFragment#Builder 提供的方法如下表所示：

方法	描述
useTitleBar()	是否使用默认的标题栏 ChatUIKitTitleBar。 - true：是。 - (默认) false: 否。 详见 设置页面标题栏。
setTitleBarTitle()	设置标题栏的标题。 详见 设置页面标题栏。
useSearchBar()	设置是否使用搜索栏。 - true：是。 - (默认) false: 否。
enableTitleBarPressBack()	设置是否支持显示返回按钮，默认为不显示。 - true：显示。 - (默认) false: 不显示。 详见 设置页面标题栏。
setTitleBarBackPressListener()	设置点击标题栏返回按钮的监听器。 详见 设置页面标题栏。
setItemClickListener()	设置会话条目点击事件监听器。
setOnItemLongClickListener()	设置会话条目长按事件监听器。
setOnMenuItemClickListener()	设置会话菜单点击事件监听器。
setConversationChangeListener()	设置会话变化的监听器。
setEmptyLayout()	设置会话列表的空白页面。
setCustomAdapter()	设置自定义的适配器，默认为 ChatUIKitConversationListAdapter。
setCustomFragment()	设置自定义会话列表 Fragment，需要继承自 ChatUIKitConversationListFragment。

默认会话操作

长按会话条目会显示会话操作菜单。会话列表页面使用 ChatUIKitConversationListViewModel 中提供的方法默认实现以下操作：

会话操作	描述
会话免打扰	- makeSilentForConversation：设置会话免打扰。 - cancelSilentForConversation ：取消会话免打扰。
会话置顶	- pinConversation：置顶会话。 - unpinConversation：取消置顶。
会话标记已读	makeConversationRead：标记会话为已读状态。
会话删除	deleteConversation：删除会话。

会话长按显示的操作

设置会话列表空页面

ChatUIKitConversationListFragment#Builder 提供 setEmptyLayout() 设置会话列表的空页面。

ChatUIKitConversationListFragment.Builder()
    .setEmptyLayout(R.layout.layout_conversation_empty)
    .build()

设置事件监听

ChatUIKitConversationListFragment.Builder 提供针对会话条目及长按菜单的事件监听配置。建议通过 Builder 进行统一设置。

ChatUIKitConversationListFragment.Builder()
    .setItemClickListener(onItemClickListener)
    .setOnItemLongClickListener(onItemLongClickListener)
    .setOnMenuItemClickListener(onMenuItemClickListener)
    .setConversationChangeListener(conversationChangeListener)
    .build()

方法	描述
setItemClickListener	设置会话条目点击事件监听器。
setOnItemLongClickListener	设置会话条目长按事件监听器。
setOnMenuItemClickListener	设置会话条目长按后弹出的菜单项的点击事件监听器。
setConversationChangeListener	设置会话变化的监听器，例如会话被删除时触发。

可重载方法标记

其他标记为 open / override fun 的方法均为可重载方法。如有需要，可重载对应方法实现自己业务逻辑。