- 动态与公告
- 产品简介
- 购买指南
- 体验 Demo
- 下载中心
- 快速入门
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 客服场景
- 智能机器人
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
- 动态与公告
- 产品简介
- 购买指南
- 体验 Demo
- 下载中心
- 快速入门
- 聊天互动（含 UI）
- 视频通话（含 UI）
- 客服场景
- 智能机器人
- 更多实践
- 无 UI 集成
- 客户端 API
- 服务端 API
- 控制台指南
- 常见问题
- 协议与认证
- IM 政策
- 平滑迁移方案
- 错误码
- 联系我们
TUIKit API (Android)
最后更新时间：2024-02-07 17:08:25
会话列表界面 ConversationLayout
会话列表窗口 ConversationLayout 由标题区 TitleBarLayout 与列表区 ConversationListLayout 组成，每部分都会提供 UI 样式以及事件注册的接口可供修改。
API | 描述 |
获取会话列表 List。 | |
置顶会话。 | |
删除会话。 |
聊天界面 ChatLayout
聊天窗口 ChatLayout 提供消息的展示与发送等功能，界面布局从上到下分为以下四个部分，每个区域都提供多样化的方法以满足定制需求。
标题区 TitleBarLayout
提醒区 NoticeLayout
消息区 MessageLayout
输入区 InputLayout
API | 描述 |
获取聊天窗口 Input 区域 Layout。 | |
获取聊天窗口 Message 区域 Layout。 | |
获取聊天窗口 Notice 区域 Layout。 | |
设置当前的会话 ID，会话面板会依据该 ID 加载会话所需的相关信息，例如消息记录、用户（群）信息等。 | |
退出聊天，释放相关资源（一般在 activity finish 时调用）。 | |
初始化参数。 | |
加载聊天消息。 | |
发送消息。 |
通知区域 NoticeLayout
通知区域 NoticeLayout 位置固定，只能显示或隐藏，位置不会随聊天内容的滚动而变化，可以用来展示待处理的群消息或者广播等。该区域分为两部分，可以用来展示内容主题以及辅助主题。可以设置点击事件来响应用户操作。
API | 描述 |
获取通知的主题信息 View。 | |
获取通知的进一步操作 View。 | |
设置通知的点击事件。 | |
设置通知区域是否一直显示。 |
消息展示区域 MessageLayout
消息区域 MessageLayout 继承自 RecyclerView，提供消息的展示功能。本类提供了大量的方法以满足定制需求，包括外观设置、点击事件以及自定义消息的展示等。
设置头像
API | 描述 |
设置默认头像，默认左右双方的头像相同。 | |
获取默认头像。 | |
设置头像圆角。 | |
获取头像圆角。 | |
设置头像大小。 | |
获得头像大小。 |
设置昵称样式
API | 描述 |
设置昵称文字大小。 | |
获得昵称文字大小。 | |
设置昵称文字颜色。 | |
获取昵称文字颜色。 | |
设置左边昵称是否显示。 | |
获取左边昵称显示状态。 | |
设置右边昵称是否显示。 | |
获取右边昵称显示状态。 |
设置气泡
API | 描述 |
设置右边聊天气泡的背景。 | |
获取右边聊天气泡的背景。 | |
设置左边聊天气泡的背景。 | |
获取左边聊天气泡的背景。 |
设置聊天内容
API | 描述 |
设置聊天内容字体大小。 | |
获取聊天内容字体大小。 | |
设置右边聊天内容字体颜色。 | |
获取右边聊天内容字体颜色。 | |
获取左边聊天内容字体颜色。 | |
设置左边聊天内容字体颜色。 |
设置聊天时间
API | 描述 |
设置聊天时间的背景。 | |
获取聊天时间的背景。 | |
设置聊天时间的字体大小。 | |
获取聊天时间的文字大小。 | |
设置聊天时间的字体颜色。 | |
获取聊天时间的字体颜色。 |
设置聊天的提示信息
API | 描述 |
设置聊天提示信息的背景。 | |
获取聊天提示信息的背景。 | |
设置聊天提示信息的文字大小。 | |
获取聊天提示信息的文字大小。 | |
设置聊天提示信息的文字颜色。 | |
获取聊天提示信息的文字颜色。 |
设置其他信息
API | 描述 |
设置消息列表的适配器 MessageListAdapter。 | |
设置消息列表的事件监听器 MessageLayout.OnItemClickListener。 | |
获得消息列表的点击事件。 | |
获取 PopMenu 的 Action 列表。 | |
给 PopMenu 加入一条自定义 action。 | |
设置自定义的消息渲染时的回调，当 TUIKit 内部在刷新自定义消息时会调用这个回调。 |
输入区域 InputLayout
输入区域 InputLayout 实现一般消息的输入，包括文本、表情、图片、音频、视频与文件等，配合 MessageLayout.setOnCustomMessageDrawListener 使用可以实现自定义消息的发送与展示。同时，您可以根据实际业务需求隐藏、替换或新增输入区域的功能入口。
API | 描述 |
disable 语音输入后，会隐藏按钮。 | |
disable 表情输入后，会隐藏按钮。 | |
disable 更多功能后，会隐藏按钮。 | |
替换单击“+”弹出的面板。 | |
替换单击“+”响应的事件。 | |
disable 发送图片后，会隐藏更多面板上的按钮。 | |
disable 拍照后，会隐藏更多面板上的按钮。 | |
disable 录像后，会隐藏更多面板上的按钮。 | |
disable 发送文件后，会隐藏更多面板上的按钮。 | |
增加更多面板上的事件单元。 |
标题区 TitleBarLayout
会话列表窗口 ConversationLayout、聊天窗口 ChatLayout 等都自带标题栏。标题栏设计分为左中右三部分，其中，左边和右边都可以为图片 + 文字，中间只能为文字，这些区域返回的都是标准的 Android View，您可以根据实际业务需要对这些 View 进行交互响应处理。
API | 描述 |
设置左边标题的图片。 | |
设置右边标题的图片。 | |
设置左边标题的点击事件。 | |
设置右边标题的点击事件。 | |
设置文字标题，根据 position参数指定文字所在位置。 | |
返回左边标题区域。 | |
返回右边标题区域。 | |
返回左边标题的图片。 | |
返回右边标题的图片。 | |
返回左边标题的文字。 | |
返回中间标题的文字。 | |
返回右边标题的文字。 |
是
否
本页内容是否解决了您的问题？