聊天室信息
获取聊天室资料与在线成员列表;成员数不设上限。
平台调用风格
进程模型:main(客户端 + 本地库,单写者)/ preload(contextBridge 具名方法)/ renderer(薄代理)。renderer 不直连网络与数据库。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
getChatroomInfo | 聊天室信息(含在线数)。 | REST(客户端) | Chatroom |
getChatroomMembers | 聊天室在线成员列表。 | REST(客户端) | {members:ChatroomMember[], total:uint32} |
本页 2 个操作,其中 2 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
getChatroomInfo | getChatroomInfo | getChatroomInfo | getChatroomInfo | getChatroomInfo | getChatroomInfo | im_client_chatroom_info | func |
getChatroomMembers | getChatroomMembers | getChatroomMembers | getChatroomMembers | getChatroomMembers | getChatroomMembers | — | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
getChatroomInfo
聊天室信息(含在线数)。
getChatroomInfo(chatroomId: string): Promise<RcResult<Chatroom>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
chatroomId | string | 必填;聊天室 ID |
返回
Chatroom 聊天室资料
示例
JavaScript
const res = await client.getChatroomInfo('cr_2001');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1012 | CHATROOM_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 聊天室不存在 |
getChatroomMembers
聊天室在线成员列表。
getChatroomMembers(chatroomId: string, options?: {offset?: number; limit?: number}): Promise<RcResult<{members: ChatroomMember[]; total: number}>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
chatroomId | string | 必填;聊天室 ID |
options | {offset?:uint32,limit?:uint32} | 可选;选项对象(字段见类型列):{ offset?:uint32, limit?:uint32 } |
返回
{members:ChatroomMember[], total:uint32} 在线成员页与总数
示例
JavaScript
const res = await client.getChatroomMembers('cr_2001');
if (res.code !== 0) throw new Error(res.msg);
const data = res.data;错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1012 | CHATROOM_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 聊天室不存在 |
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南