加入聊天室

默认同一用户不能同时加入多个聊天室，加入新的聊天室后，会自动退出之前的聊天室。

如需支持单个用户加入多个聊天室，请在控制台打开该配置，详见聊天室服务配置。

加入聊天室

方法

joinChatRoom(
  targetId: string,
  messageCount: number,
  autoCreate: boolean,
  callback: IRCIMIWJoinChatRoomCallback
): Promise<number>;

参数说明

参数名	参数类型	描述
targetId	string	聊天室会话 ID
messageCount	number	进入聊天室拉取消息数目，-1 时不拉取任何消息，0 时拉取 10 条消息，最多只能拉取 50
autoCreate	boolean	是否创建聊天室，TRUE 如果聊天室不存在，sdk 会创建聊天室并加入，如果已存在，则直接加入
callback	IRCIMIWJoinChatRoomCallback	事件回调。SDK 从 5.3.1 版本开始支持 callback 方式回调。从 5.4.0 版本废弃该接口的其他回调方式。如果传入了 callback 参数，仅触发 callback 回调。

返回值

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

代码示例

let callback = {
onChatRoomJoined:(res) => {
//...
}};
let code = await engine.joinChatRoom(targetId, messageCount, autoCreate, callback);

回调方法

• setOnChatRoomJoinedListener

setOnChatRoomJoinedListener(listener?: ({code, targetId}) => void): void;

参数说明

参数名	参数类型	描述
code	number	接口回调的状态码，0 代表成功，非 0 代表出现异常
targetId	string	会话 ID

代码示例

engine.setOnChatRoomJoinedListener((res) => {
    //...
});

• setOnChatRoomJoiningListener

正在加入聊天室的回调

setOnChatRoomJoiningListener(listener?: ({targetId}) => void): void;

参数说明

参数名	参数类型	描述
targetId	string	聊天室 ID

代码示例

engine.setOnChatRoomJoiningListener((res) => {
    //...
});

• SDK 提供聊天室重连机制，待链接状态恢复后，如果曾经加入过聊天室，没有退出，则重新加入聊天室。