TUIKit API (Android)

最近更新时间:2019-08-15 11:49:46

会话列表界面 ConversationLayout

会话列表窗口 ConversationLayout 由标题区 TitleBarLayout 与列表区 ConversationListLayout 组成,每部分都会提供 UI 样式以及事件注册的接口可供修改。

API 描述
getConversationList 获取会话列表 List。
setConversationTop 置顶会话。
deleteConversation 删除会话。

聊天界面 ChatLayout

聊天窗口 ChatLayout 提供消息的展示与发送等功能,界面布局从上到下分为以下四个部分,每个区域都提供多样化的方法以满足定制需求。

  • 标题区 TitleBarLayout
  • 提醒区 NoticeLayout
  • 消息区 MessageLayout
  • 输入区 InputLayout
API 描述
getInputLayout 获取聊天窗口 Input 区域 Layout。
getMessageLayout 获取聊天窗口 Message 区域 Layout。
getNoticeLayout 获取聊天窗口 Message 区域 Layout。
setChatInfo 设置当前的会话 ID,会话面板会依据该 ID 加载会话所需的相关信息,例如消息记录、用户(群)信息等。
exitChat 退出聊天,释放相关资源(一般在 activity finish 时调用)。
initDefault 初始化参数。
loadMessages 加载聊天消息。
sendMessage 发送消息。

通知区域 NoticeLayout

通知区域 NoticeLayout 位置固定,只能显示或隐藏,位置不会随聊天内容的滚动而变化,可以用来展示待处理的群消息或者广播等。该区域分为两部分,可以用来展示内容主题以及辅助主题。可以设置点击事件来响应用户操作。

API 描述
getContent 获取通知的主题信息 View。
getContentExtra 获取通知的进一步操作 View。
setOnNoticeClickListener 设置通知的点击事件。
alwaysShow 设置通知区域是否一直显示。

消息展示区域 MessageLayout

消息区域 MessageLayout 继承自 RecyclerView,提供消息的展示功能。本类提供了大量的方法以满足定制需求,包括外观设置、点击事件以及自定义消息的展示等。

设置头像

API 描述
setAvatar 设置默认头像,默认左右双方的头像相同。
getAvatar 获取默认头像。
setAvatarRadius 设置头像圆角。
getAvatarRadius 获取头像圆角。
setAvatarSize 设置头像大小。
getAvatarSize 获得头像大小。

设置昵称样式

API 描述
setNameFontSize 设置昵称文字大小。
getNameFontSize 获得昵称文字大小。
setNameFontColor 设置昵称文字颜色。
getNameFontColor 获取昵称文字颜色。
setLeftNameVisibility 设置左边昵称是否显示。
getLeftNameVisibility 获取左边昵称显示状态。
setRightNameVisibility 设置右边昵称是否显示。
getRightNameVisibility 获取右边昵称显示状态。

设置气泡

API 描述
setRightBubble 设置右边聊天气泡的背景。
getRightBubble 获取右边聊天气泡的背景。
setLeftBubble 设置左边聊天气泡的背景。
getLeftBubble 获取左边聊天气泡的背景。

设置聊天内容

API 描述
setChatContextFontSize 设置聊天内容字体大小。
getChatContextFontSize 获取聊天内容字体大小。
setRightChatContentFontColor 设置右边聊天内容字体颜色。
getRightChatContentFontColor 获取右边聊天内容字体颜色。
getLeftChatContentFontColor 获取左边聊天内容字体颜色。
setLeftChatContentFontColor 设置左边聊天内容字体颜色。

设置聊天时间

API 描述
setChatTimeBubble 设置聊天时间的背景。
getChatTimeBubble 获取聊天时间的背景。
setChatTimeFontSize 设置聊天时间的字体大小。
getChatTimeFontSize 获取聊天时间的文字大小。
setChatTimeFontColor 设置聊天时间的字体颜色。
getChatTimeFontColor 获取聊天时间的字体颜色。

设置聊天的提示信息

API 描述
setTipsMessageBubble 设置聊天提示信息的背景。
getTipsMessageBubble 获取聊天提示信息的背景。
setTipsMessageFontSize 设置聊天提示信息的文字大小。
getTipsMessageFontSize 获取聊天提示信息的文字大小。
setTipsMessageFontColor 设置聊天提示信息的文字颜色。
getTipsMessageFontColor 获取聊天提示信息的文字颜色。

设置其他信息

API 描述
setAdapter 设置消息列表的适配器 MessageListAdapter。
setOnItemClickListener 设置消息列表的事件监听器 MessageLayout.OnItemClickListener。
getOnItemClickListener 获得消息列表的点击事件。
getPopActions 获取 PopMenu 的 Action 列表。
addPopAction 给 PopMenu 加入一条自定义 action。
setOnCustomMessageDrawListener 设置自定义的消息渲染时的回调,当 TUIKit 内部在刷新自定义消息时会调用这个回调。

输入区域 InputLayout

输入区域 InputLayout 实现一般消息的输入,包括文本、表情、图片、音频、视频与文件等,配合 MessageLayout.setOnCustomMessageDrawListener 使用可以实现自定义消息的发送与展示。同时,您可以根据实际业务需求隐藏、替换或新增输入区域的功能入口。

API 描述
disableAudioInput disable 语音输入后,会隐藏按钮。
disableEmojiInput disable 表情输入后,会隐藏按钮。
disableMoreInput disable 更多功能后,会隐藏按钮。
replaceMoreInput 替换单击“+”弹出的面板。
replaceMoreInput 替换单击“+”响应的事件。
disableSendPhotoAction disable 发送图片后,会隐藏更多面板上的按钮。
disableCaptureAction disable 拍照后,会隐藏更多面板上的按钮。
disableVideoRecordAction disable 录像后,会隐藏更多面板上的按钮。
disableSendFileAction disable 发送文件后,会隐藏更多面板上的按钮。
addAction 增加更多面板上的事件单元。

标题区 TitleBarLayout

会话列表窗口 ConversationLayout、聊天窗口 ChatLayout 等都自带标题栏。标题栏设计分为左中右三部分,其中,左边和右边都可以为图片 + 文字,中间只能为文字,这些区域返回的都是标准的 Android View,您可以根据实际业务需要对这些 View 进行交互响应处理。

API 描述
setLeftIcon 设置左边标题的图片。
setRightIcon 设置右边标题的图片。
setOnLeftClickListener 设置左边标题的点击事件。
setOnRightClickListener 设置右边标题的点击事件。
setTitle 设置文字标题,根据position参数指定文字所在位置。
getLeftGroup 返回左边标题区域。
getRightGroup 返回右边标题区域。
getLeftIcon 返回左边标题的图片。
getRightIcon 返回右边标题的图片。
getLeftTitle 返回左边标题的文字。
getMiddleTitle 返回中间标题的文字。
getRightTitle 返回右边标题的文字。