群管理
群主与管理员可修改群资料、转让群主、设置管理员与成员禁言。
契约预留
本平台为 reserved:以下签名来自已冻结绑定,示例为契约样例,不承诺可运行。
平台调用风格
异步风格:Promise<RcResult<T>>(不 reject;错误码在 RcResult.code);uint64/int64 映射为 number,超出安全整数时由实现改用 string。
接口一览
| 操作 | 语义 | 传输 | 返回 |
|---|---|---|---|
updateGroupName | 修改群名(群主/管理员)。 | REST(客户端) | Group |
updateGroupNotice | 设置群公告(群主/管理员,<=500 字,空串清除)。 | REST(客户端) | Group |
transferGroupOwner | 转让群主(新群主须为成员)。 | REST(客户端) | Group |
addGroupAdmin | 设置管理员(群主,幂等)。 | REST(客户端) | Group |
removeGroupAdmin | 取消管理员(群主)。 | REST(客户端) | Group |
muteGroupMember | 禁言/解禁(群主/管理员;不能禁言群主;管理员不能禁言管理员)。 | REST(客户端) | {groupId:string,userId:string,mutedUntil:uint64,group:Group} |
本页 6 个操作,其中 6 个在本平台绑定中声明了方法签名。
跨端方法名
| 操作 | Android | Web | Electron | macOS | Flutter | Native (C ABI) | iOS |
|---|---|---|---|---|---|---|---|
updateGroupName | updateGroupName | updateGroupName | updateGroupName | updateGroupName | updateGroupName | — | func |
updateGroupNotice | updateGroupNotice | updateGroupNotice | updateGroupNotice | updateGroupNotice | updateGroupNotice | — | func |
transferGroupOwner | transferGroupOwner | transferGroupOwner | transferGroupOwner | transferGroupOwner | transferGroupOwner | — | func |
addGroupAdmin | addGroupAdmin | addGroupAdmin | addGroupAdmin | addGroupAdmin | addGroupAdmin | — | func |
removeGroupAdmin | removeGroupAdmin | removeGroupAdmin | removeGroupAdmin | removeGroupAdmin | removeGroupAdmin | — | func |
muteGroupMember | muteGroupMember | muteGroupMember | muteGroupMember | muteGroupMember | muteGroupMember | — | func |
方法名在 GA 平台之间保持一致(规则 A);Native C ABI 只覆盖部分操作,其余操作以 — 标注。
updateGroupName
修改群名(群主/管理员)。
updateGroupName(groupId: string, name: string): Promise<RcResult<Group>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
name | string | 必填;名称(群名 / 聊天室名 / 文件名) |
返回
Group 群资料
示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.updateGroupName('g_1001', '产品群');
if (res.code !== 0) { console.error(res.msg); }错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
updateGroupNotice
设置群公告(群主/管理员,<=500 字,空串清除)。
updateGroupNotice(groupId: string, notice: string): Promise<RcResult<Group>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
notice | string | 必填;群公告文本(<=500 字,空串清除) |
返回
Group 群资料
示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.updateGroupNotice('g_1001', '本周五 20:00 全员复盘');
if (res.code !== 0) { console.error(res.msg); }错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
transferGroupOwner
转让群主(新群主须为成员)。
transferGroupOwner(groupId: string, newOwner: string): Promise<RcResult<Group>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
newOwner | string | 必填;新群主用户 ID(必须是群成员) |
返回
Group 群资料
示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.transferGroupOwner('g_1001', 'user2');
if (res.code !== 0) { console.error(res.msg); }错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1004 | USER_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 用户不存在 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
addGroupAdmin
设置管理员(群主,幂等)。
addGroupAdmin(groupId: string, userId: string): Promise<RcResult<Group>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
userId | string | 必填;用户 ID |
返回
Group 群资料
示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.addGroupAdmin('g_1001', 'user2');
if (res.code !== 0) { console.error(res.msg); }错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1004 | USER_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 用户不存在 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
removeGroupAdmin
取消管理员(群主)。
removeGroupAdmin(groupId: string, userId: string): Promise<RcResult<Group>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
userId | string | 必填;用户 ID |
返回
Group 群资料
示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.removeGroupAdmin('g_1001', 'user2');
if (res.code !== 0) { console.error(res.msg); }错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
muteGroupMember
禁言/解禁(群主/管理员;不能禁言群主;管理员不能禁言管理员)。
muteGroupMember(groupId: string, userId: string, mutedUntil: number): Promise<RcResult<MuteGroupMemberResult>>参数
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 必填;群组 ID |
userId | string | 必填;用户 ID |
mutedUntil | uint64 | 必填;禁言到期时间(epoch 毫秒;0 表示解除禁言) |
返回
{groupId:string,userId:string,mutedUntil:uint64,group:Group} 成功返回的数据;失败时按错误码处理
示例
TypeScript
// HarmonyOS 绑定为契约预留,以下为声明样例
const res = await client.muteGroupMember('g_1001', 'user2', 0);
if (res.code !== 0) { console.error(res.msg); }错误码
| 错误码 | 名称 | 分类 | HTTP | 可重试 | 说明 |
|---|---|---|---|---|---|
1001 | INVALID_PARAMETER | 客户端 / 参数 / 权限 | 400 | 否 | 参数错误 |
1003 | FORBIDDEN | 客户端 / 参数 / 权限 | 403 | 否 | 无权限 |
1004 | USER_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 用户不存在 |
1005 | GROUP_NOT_FOUND | 客户端 / 参数 / 权限 | 404 | 否 | 群组不存在 |
1006 | NOT_GROUP_MEMBER | 客户端 / 参数 / 权限 | 403 | 否 | 未加入群组 |
相关文档
- 功能列表:103 个操作与签名
- 状态码:错误码与重试策略
- API 参考:类与成员
- IMLib 集成指南