本页包含 IBRTMChatEventListener、IBRTMChatManager、IBRTMMessageModel 接口/回调说明。涵盖了关于聊天相关的各种操作以及相关事件回调监听。

IBRTMChatEventListener

IBRTMChatEventListener 是聊天消息变更时的监听器，您必须实现此接口来获取房间内的聊天消息。

函数列表	描述
onReceiveMessage	聊天消息回调
onGetMessageAll	登录或重连后获取到所有消息回调

---

onReceiveMessage
聊天消息回调

void onReceiveMessage(IBRTMMessageModel messageModel)

参数

Name	Type	Description
messageModel	IBRTMMessageModel	聊天消息封装对象

返回

---

onGetMessageAll
登录或重连后获取到所有消息回调

void onGetMessageAll(List<IBRTMMessageModel> messageAll)

参数

Name	Type	Description
messageAll	List	一定数量的历史聊天消息

返回
无

说明
服务器默认下发最近的 10 条聊天记录。

IBRTMChatManager

IBRTMChatManager 包含聊天相关的功能。主要有发送聊天消息、获取历史聊天记录以及注册聊天消息监听的功能。

函数列表	描述
registerChatEventListener	注册聊天消息监听
sendMessage [1/2]	发送文字消息-广播
sendMessage [2/2]	发送文字消息-私聊
getMessageHistory	获取当前的历史聊天记录

---

registerChatEventListener

注册聊天事件监听器

void registerChatEventListener(IBRTMChatEventListener brtmChatEventListener)

参数

Name	Type	Description
brtmChatEventListener	IBRTMChatEventListener	聊天消息监听器

返回

无

---

sendMessage[1/2]

发送文字消息-广播

void sendMessage(String message)

参数

Name	Type	Description
message	String	要发送的内容

返回

无

---

sendMessage[2/2]

发送文字消息-私聊

void sendMessage(@Nullable IUserModel toUser, String message)

参数

Name	Type	Description
toUser	IUserModel	要发送的人。如果设置为 null，表示广播给所有人
message	String	要发送的内容

返回

---

getMessageHistory
发送文字消息-私聊

List<IBRTMMessageModel> getMessageHistory()

参数

无

返回

聊天记录列表

---

IBRTMMessageModel

IBRTMMessageModel 是一条具体的聊天内容相关信息的封装。从下面方法命名中也可以看出，可以通过它来获取某条聊天的各种详细信息。

函数列表	描述
getContent	获取消息主文本
getFrom	获取发送这条消息的人
getTo	获取该条消息发送给的人
getToUser	获取私聊目标人的全部信息
getId	消息 id 消息的唯一标识
getTimestamp	消息发送时间戳
isPrivateChat	是否为私聊

---

getContent

获取消息主文本

String getContent()

参数

无

返回

返回的文本内容

---

getFrom

获取发送这条消息的用户信息

IUserModel getFrom()

参数

无

返回

IUserModel 发送人的信息

---

getTo

获取该条消息发送的目标用户 ID

String getTo()

参数

无

返回

如果是私聊，则返回目标用户的用户 ID；非私聊则为字符串“-1”

---

getToUser

获取该条消息发送的目标用户信息

IUserModel getFrom()

参数

无

返回

IUserModel 目标用户（聊天消息接收者）用户信息

---

getId

获取消息的唯一标识

String getId()

参数

无

返回

字符串格式的标识

---

getTimestamp

获取消息发送时间

Date getTimestamp()

参数

无

返回

Date : 消息发送时间对象

---

isPrivateChat

获取是否为私聊

boolean isPrivateChat();

参数

无

返回

如果是私聊，返回 true，否则返回 false