跳到主要内容

退出聊天室

退出聊天室支持以下几种情况:

  • 被动退出聊天室:聊天室具有离线成员自动踢出机制。该机制被触发时,融云服务端会将用户踢出聊天室。用户如被封禁,也会被踢出聊天室。
  • 主动退出聊天室:客户端提供 API,支持由用户主动退出聊天室。

聊天室离线成员自动退出机制

聊天室具有离线成员自动退出机制。用户离线后,如满足以下默认预设条件,融云服务端会自动将该用户踢出聊天室:

  • 从用户离线开始 30 秒内,聊天室中产生第 31 条消息时,触发自动踢出。
  • 或用户已离线 30 秒后,聊天室有新消息产生时,触发自动踢出。
提示
  • 默认预设条件均要求聊天室中必须要有新消息产生,否则无法触发踢出动作。如果聊天室中没有消息产生,则无法将异常用户踢出聊天室。
  • 如需修改默认行为对新消息的依赖,请提交工单申请开通聊天室成员异常掉线实时踢出。开通该服务后,服务端会通过 SDK 行为判断用户是否处于异常状态,最迟 5 分钟可以将异常用户踢出聊天室。
  • 如需保护特定用户,即不自动踢出指定用户(如某些应用场景下可能希望用户驻留聊天室),可使用 Server API 提供的聊天室用户白名单功能。

主动退出聊天室

客户端用户可主动退出聊天室。

方法

Future<int> leaveChatRoom(String targetId, {IRCIMIWLeaveChatRoomCallback? callback});

参数说明

参数名参数类型描述
targetIdString聊天室会话 ID
callbackIRCIMIWLeaveChatRoomCallback事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数,仅触发 callback 回调。

返回值

返回值描述
Future<int>当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码

代码示例

IRCIMIWLeaveChatRoomCallback? callback = IRCIMIWLeaveChatRoomCallback(onChatRoomLeft: (int? code, String? targetId) {
//...
});

int? ret = await engine?.leaveChatRoom(targetId, callback:callback);

回调方法

  • onChatRoomLeft
Function(int? code, String? targetId)? onChatRoomLeft;

参数说明

参数名参数类型描述
codeint接口回调的状态码,0 代表成功,非 0 代表出现异常
targetIdString会话 ID

代码示例

engine?.onChatRoomLeft = (int? code, String? targetId) {
//...
};