跳到主要内容

监听聊天室事件

聊天室业务为客户端 App 提供三种类型的事件监听器:聊天室状态监听器、聊天室成员变化监听器、聊天室事件通知监听器。

通过 SDK 提供的以上监听器,客户端 App 可以从融云服务端获取聊天室销毁状态、用户在当前及其他客户端加入退出聊天室的状态、聊天室中成员进出的事件通知、以及聊天室中成员禁言、封禁相关的信息。

监听器名称说明
ChatRoomAdvancedActionListener聊天室状态监听器接收在当前客户端登录的用户加入、退出聊天室的事件与聊天室销毁状态的信息。
ChatRoomMemberActionListener聊天室成员变化监听器接收当前用户所在聊天室中其他用户加入、退出聊天室的信息。
ChatRoomNotifyEventListener聊天室事件通知监听器接收当前所在聊天室中成员禁言、封禁相关的信息;接收当前用户在其他端加入、退出聊天室相关的信息。

监听聊天室状态

应用程序可以监听当前客户端上用户加入、退出聊天室的事件与聊天室销毁状态变更。

使用 RongChatRoomClientaddChatRoomAdvanceActionListener setChatRoomAdvancedActionListener 添加或设置 ChatRoomAdvancedActionListener 监听器。

// addChatRoomAdvanceActionListener,since 5.2.5
RongChatRoomClient.addChatRoomAdvanceActionListener(
new ChatRoomAdvancedActionListener() {
@Override
public void onJoining(String chatRoomId) {
// default implementation ignored
}

@Override
public void onJoined(String chatRoomId) {
// 加入聊天室成功,已废弃
// default implementation ignored
}

@Override
public void onJoined(String chatRoomId, JoinChatRoomResponse joinChatRoomResponse) {
// 加入聊天室成功 since 5.6.3
// default implementation ignored
}

@Override
public void onReset(String chatRoomId) {
// default implementation ignored
}

@Override
public void onQuited(String chatRoomId) {
// default implementation ignored
}

@Override
public void onDestroyed(String chatRoomId, ChatRoomDestroyType type) {
data.setFirstAndNotify(Pair.create(chatRoomId, type));
}

@Override
public void onError(String chatRoomId, CoreErrorCode code) {
// default implementation ignored
}
});


// setChatRoomAdvanceActionListener
RongChatRoomClient.setChatRoomAdvanceActionListener(listener);

移除监听器:

// removeChatRoomAdvanceActionListener,since 5.2.5
RongChatRoomClient.addChatRoomAdvanceActionListener(listener);
// setChatRoomAdvanceActionListener
RongChatRoomClient.setChatRoomAdvanceActionListener(null);

聊天室状态事件

下方列出了聊天室操作监听器 ChatRoomAdvancedActionListener 提供的事件列表及回调方法。

回调方法触发时机说明
onJoining(String chatRoomId)当前用户正在加入聊天室返回数据包括:聊天室 ID
onJoined(String chatRoomId, JoinChatRoomResponse)当前用户已加入聊天室(5.6.3 开始提供)。返回数据包括:聊天室 ID,聊天室房间信息、用户在聊天室的状态。
onJoined(String chatRoomId)当前用户已加入聊天室(从 5.6.3 开始废弃)返回数据包括:聊天室 ID
onReset(String chatRoomId)用户所在聊天室被重置。返回数据包括:聊天室 ID。注意,加入聊天室成功,但是聊天室被重置,接收到此回调后,还会立刻收到 onJoiningonJoined 回调。
onQuited(String chatRoomId)当前用户退出聊天室返回数据包括:聊天室 ID
onDestroyed(String chatRoomId, IRongCoreEnum.ChatRoomDestroyType type)当前用户在线,且所在聊天室被销毁返回数据包括:聊天室 ID、聊天室销毁类型。聊天室销毁类型为 ChatRoomDestroyType.MANUAL,表示主动调用 IM Server API 销毁聊天室。ChatRoomDestroyType.AUTO 表示聊天室自动销毁。
onError(String chatRoomId, IRongCoreEnum.CoreErrorCode code)聊天室操作异常返回数据包括:聊天室 ID、错误码。

监听聊天室成员变化

提示

SDK 从 5.1.4 版本开始支持监听聊天室成员变化。

从 5.1.4 版本,SDK 开始在 RongChatRoomClient 中提供 ChatRoomMemberActionListener,支持当前登录用户监听所在聊天室中其它成员的加入、退出行为。

开通服务

此功能需要开通服务后方可使用。如有需求,请提交工单,申请开通聊天室成员变化监听

设置聊天室成员变化监听器

设置聊天室成员变化监听器 ChatRoomMemberActionListener。从 5.6.7 版本 开始,新增返回 ChatRoomMemberActionModel 对象的回调方法,其中增加了当前聊天室人数。

RongChatRoomClient.setChatRoomMemberListener(new RongChatRoomClient.ChatRoomMemberActionListener() {
/**
* @param chatRoomMemberActions
* @param roomId
*/
@Override
public void onMemberChange(List<ChatRoomMemberAction> chatRoomMemberActions, String chatRoomId) {
// Handle the member change with the list of ChatRoomMemberAction objects and the chatRoomId
}

/**
* @since 5.6.7
*/
@Override
public void onMemberChange(ChatRoomMemberActionModel model) {
// Handle the member change with the ChatRoomMemberActionModel object
String chatroomId = model.getRoomId();
List<ChatRoomMemberAction> chatRoomMemberActions = model.getChatRoomMemberActions();
int memberCount = model.getMemberCount();

for (ChatRoomMemberAction action : chatRoomMemberActions) {
// Access the properties of ChatRoomMemberAction object
String userId = action.getUserId();
ChatRoomMemberAction.ChatRoomMemberActionType actionType = action.getChatRoomMemberAction();

if (actionType == ChatRoomMemberAction.ChatRoomMemberActionType.CHAT_ROOM_MEMBER_JOIN) {
System.out.println("Action Type: Join");
} else if (actionType == ChatRoomMemberAction.ChatRoomMemberActionType.CHAT_ROOM_MEMBER_QUIT) {
System.out.println("Action Type: Leave");
}
}
}
});

聊天室中有其他用户加入或退出时,SDK 会同时触发两个 onMemberChange 回调方法,都在 UI 线程回调。ChatRoomMemberAction 列表中包含了当前聊天室中加入或退出聊天室的成员信息。ChatRoomMemberActionModel 额外封装了聊天室当前人数(指已加入未退出的人数)。推荐使用返回 ChatRoomMemberActionModel 对象的 onMemberChange 方法。

如果当前用户由于网络原因和聊天室断开连接,则无法监听到断开连接期间的其他成员的加入、退出行为。

监听聊天室事件通知

提示

SDK 从 5.4.5 版本开始支持监听聊天室事件通知。

应用程序可以监听当前聊天室中成员禁言、封禁相关的通知,以及当前用户在其他端加入、退出聊天室相关的通知。

使用 RongChatRoomClientaddChatRoomNotifyEventListener 方法添加一个ChatRoomNotifyEventListener 监听器。SDK 从 5.4.5 版本开始支持 RCChatRoomNotifyEventListener 监听器。

// Since 5.4.5
RongChatRoomClient.addChatRoomNotifyEventListener(
new RongChatRoomClient.ChatRoomNotifyEventListener() {
@Override
public void onChatRoomNotifyMultiLoginSync(ChatRoomSyncEvent event) {

}

@Override
public void onChatRoomNotifyBlock(ChatRoomMemberBlockEvent event) {

}

@Override
public void onChatRoomNotifyBan(ChatRoomMemberBanEvent event) {

}
});

// Remove
RongChatRoomClient.removeChatRoomNotifyEventListener(listener);
回调方法触发时机说明
onChatRoomNotifyMultiLoginSync(ChatRoomSyncEvent event)在用户在多端登录情况下,在其他客户端加入、退出聊天室接收在当前客户端上用户加入、退出聊天室的事件
onChatRoomNotifyBlock(ChatRoomMemberBlockEvent event)用户所在聊天室中发生了禁言、解除禁言相关的事件是否接收通知取决于调用服务端封禁、解封的相关 API 时是否指定了 needNotifytrue
onChatRoomNotifyBan(ChatRoomMemberBanEvent event)用户所在聊天室发生了封禁用户、解除封禁相关的事件是否接收通知取决于调用服务端封禁、解封的相关 API 时是否指定了 needNotifytrue

多端登录事件通知

在用户在多端登录情况下,在其他客户端加入、退出聊天室时,触发 onChatRoomNotifyMultiLoginSync(ChatRoomSyncEvent event) 方法。

触发场景通知范围说明
用户多端登录,在一台设备上加入聊天室当前加入的用户当前用户在一端加入聊天室时,其他端的在线设备上会接收通知,不在线的设备不会通知。返回数据包括:聊天室 ID、加入时间。
用户多端登录,在一台设备上退出聊天室当前退出的用户当前用户在一端退出聊天室时,其他端的在线设备上会接收通知,不在线的设备不会通知。 返回数据包括:聊天室 ID、退出时间。
用户多端登录且已在聊天室中,加入一个新的聊天室导致被踢出上一个聊天室当前用户,和被踢出的聊天室所有成员如果在控制台开通了单个用户加入多个聊天室,则不会通知。返回数据包括:聊天室 ID、被踢出的时间。

ChatRoomSyncEvent 具体属性定义如下:

属性类型说明
chatroomIdString聊天室 ID。
statusChatRoomSyncStatus变更的状态,Quit(0):离开。Join(1):加入。
reasonChatRoomSyncStatusReason如果 statusQuit 的情况,区分离开类型:LeaveOnMyOwn(1) 表示自己主动离开。OtherDeviceLogin(2) 表示多端加入互踢导致离开。如果 statusJoin 的情况,无需关心 reason 值。
timelong用户加入/退出/被踢的时间戳,精确到毫秒。
extraString附加信息。

封禁相关事件通知

用户所在聊天室发生了封禁、解封的事件,且调用相关 Server API 时指定了需要通知(指定 needNotifytrue),触发 onChatRoomNotifyBlock(ChatRoomMemberBlockEvent event) 方法。

触发场景通知范围说明
封禁聊天室用户聊天室中所有成员返回数据包括:聊天室 ID、被封禁成员用户 ID 列表、封禁时间与持续时长、附加信息。
解除封禁聊天室用户被解除封禁的成员返回数据包括:聊天室 ID、当前用户 ID、附加信息。

ChatRoomMemberBlockEvent 具体属性定义如下:

属性类型说明
chatroomIdString聊天室 ID。
operateTypeChatRoomOperateType封禁类型。Deblock(0) :解封。Blocked(1):封禁。
durationTimelong封禁时长,单位为毫秒,最大值为 43200分钟(1个月), 最小值 1分钟。 operateTypeBlocked 时,该字段有效。
operateTimelong操作时间戳(毫秒)。
userIdListList<String>被封禁的用户 ID 列表。解封时为当前用户 ID。
extraString附加信息。

禁言相关事件通知

用户所在聊天室发生了禁言、解除禁言相关的事件,且调用相关 Server API 时指定了需要通知(指定 needNotifytrue),触发 onChatRoomNotifyBan(ChatRoomMemberBanEvent event) 方法。

触发场景通知范围说明
禁言指定聊天室用户聊天室中所有成员返回数据包括:聊天室 ID、被封禁成员用户 ID 列表、禁言时间与持续时长、附加信息。
取消禁言指定聊天室用户聊天室中所有成员返回数据包括:聊天室 ID、被封禁成员用户 ID 列表、解除禁言时间、附加信息。
设置聊天室全体禁言聊天室中所有成员返回数据包括:聊天室 ID、禁言时间、附加信息。
取消聊天室全体禁言聊天室中所有成员返回数据包括:聊天室 ID、解除禁言时间、附加信息。
加入聊天室全体禁言白名单聊天室中所有成员返回数据包括:聊天室 ID、被添加白名单的用户 ID 列表、设置白名单时间、附加信息。
移出聊天室全体禁言白名单聊天室中所有成员返回数据包括:聊天室 ID、被移出白名单的用户 ID 列表、移出白名单时间、附加信息。
全局禁言用户被全局禁言的用户返回数据包括:聊天室 ID、禁言时间与持续时长、附加信息。
取消全局禁言用户被解除全局禁言的用户返回数据包括:聊天室 ID、解除禁言时间、附加信息。

ChatRoomMemberBanEvent 具体属性定义如下:

属性类型说明
chatroomIdString聊天室 ID。
banTypeChatRoomMemberBanType聊天室禁言/解除禁言操作类型枚举
durationTimelong禁言时长,单位为毫秒:最大值为 43200 分钟(1个月),最小值1分钟。 banType 为禁言类型时,该字段有效。
operateTimelong操作时间戳(毫秒)。
userIdListList<String>被封禁的用户 ID 列表。解封时为当前用户 ID。
extraString附加信息。