跳到主要内容

加入聊天室

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

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

加入聊天室

方法

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

参数说明

参数类型说明
targetIdstring聊天室 ID
messageCountnumber拉取聊天消息记录数.
1. -1 表示不获取任何历史消息;
2. 0 表示使用 sdk 默认的设置(默认为10 条);
3. 获取的消息数量 最大值为 50 条
autoCreateboolean是否创建聊天室
TRUE 如果聊天室不存在,sdk 会创建聊天室并加入,如果已存在,则直接加入。
FALSE 聊天室不存在不会自动创建,加入失败

返回值

返回值描述
Promise<number>当次接口操作状态码,并不代表最终操作结果,状态码详细信息

代码示例

engine.joinChatRoom(
targetId,
messageCount,
autoCreate
)
.then((code: number) => {});

回调方法

  • setOnChatRoomJoinedListener
setOnChatRoomJoinedListener(listener?: (targetId: string) => void): void;

参数说明

参数类型说明
targetIdstring会话ID

代码示例

engine.setOnChatRoomJoinedListener(
(
targetId: string
) => {}
);
  • onChatRoomJoining

正在加入聊天室的回调

setOnChatRoomJoiningListener(listener?: (targetId: string) => void): void;

参数说明

参数类型说明
targetIdstring会话ID

代码示例

engine.setOnChatRoomJoiningListener(
(
targetId: string
) => {}
);
  • SDK 提供聊天室重连机制,待链接状态恢复后,如果曾经加入过聊天室,没有退出,则重新加入聊天室。