加入与退出

聊天室只有在线用户可收发消息；加入后最多获取最近 50 条消息。

平台调用风格

进程模型：main（客户端 + 本地库，单写者）/ preload（contextBridge 具名方法）/ renderer（薄代理）。renderer 不直连网络与数据库。

接口一览​

操作语义传输返回
createChatroom创建聊天室（客户端能力；服务端 Open API 亦可创建）。chatroomId 可指定或服务端生成。REST（客户端）Chatroom
joinChatroom加入聊天室：发送 chatroom_join，收到 chatroom_joined；房内广播 member_changed。WS 长连接Chatroom
leaveChatroom离开聊天室。WS 长连接null

本页 3 个操作，其中 3 个在本平台绑定中声明了方法签名。

跨端方法名​

操作AndroidWebElectronmacOSFlutterNative (C ABI)iOS
createChatroomcreateChatroomcreateChatroomcreateChatroomcreateChatroomcreateChatroom—func
joinChatroomjoinChatroomjoinChatroomjoinChatroomjoinChatroomjoinChatroomim_client_chatroom_joinfunc
leaveChatroomleaveChatroomleaveChatroomleaveChatroomleaveChatroomleaveChatroomim_client_chatroom_leavefunc

方法名在 GA 平台之间保持一致（规则 A）；Native C ABI 只覆盖部分操作，其余操作以 — 标注。

createChatroom​

创建聊天室（客户端能力；服务端 Open API 亦可创建）。chatroomId 可指定或服务端生成。

createChatroom(options: {chatroomId?: string; name: string; owner?: string}): Promise<RcResult<Chatroom>>
REST（客户端）since 1.0.0
参数
参数类型说明
options{chatroomId?:string, name:string, owner?:string}必填；选项对象（字段见类型列）：{ chatroomId?:string, name:string, owner?:string }
返回

Chatroom 聊天室资料

示例
JavaScript
const res = await client.createChatroom({ name: '产品群' });
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1003FORBIDDEN客户端 / 参数 / 权限403否无权限
1015MEMBERSHIP_LIMIT客户端 / 参数 / 权限400否成员数量超出上限
1021SERVICE_NOT_ACTIVATEDOpen API 签名与开通403否服务未开通

joinChatroom​

加入聊天室：发送 chatroom_join，收到 chatroom_joined；房内广播 member_changed。

joinChatroom(chatroomId: string): Promise<RcResult<Chatroom>>
WS 长连接幂等since 1.0.0
参数
参数类型说明
chatroomIdstring必填；聊天室 ID
返回

Chatroom 聊天室资料

示例
JavaScript
const res = await client.joinChatroom('cr_2001');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1012CHATROOM_NOT_FOUND客户端 / 参数 / 权限404否聊天室不存在
1013CHATROOM_CLOSED客户端 / 参数 / 权限410否聊天室已销毁
3001SDK_NOT_CONNECTEDSDK 本地0是长连接未就绪

leaveChatroom​

离开聊天室。

leaveChatroom(chatroomId: string): Promise<RcResult<null>>
WS 长连接幂等since 1.0.0
参数
参数类型说明
chatroomIdstring必填；聊天室 ID
返回

null 无返回数据；成功与否通过错误码判断

示例
JavaScript
await client.leaveChatroom('cr_2001'); /* code === 0 为成功 */
错误码
错误码名称分类HTTP可重试说明
1001INVALID_PARAMETER客户端 / 参数 / 权限400否参数错误
1012CHATROOM_NOT_FOUND客户端 / 参数 / 权限404否聊天室不存在
3001SDK_NOT_CONNECTEDSDK 本地0是长连接未就绪

相关文档​