浏览 SDKs · HarmonyOS
平台
SDKsHarmonyOS商业版

设置群组全员禁言

开启或关闭群组整体禁言,并配置允许发言的例外成员。

复制

通过设置全员禁言,可控制群组整体发言权限,具体操作权限由 OpenIMServer 校验。muteBypassUserIDs 用于指定全员禁言期间仍可发言的白名单成员。

参数说明

参数类型是否必填说明
groupIDstring是目标群组 ID。
muteboolean是true 开启全员禁言,false 关闭。
muteBypassUserIDsstring[]是禁言期间允许发言的用户 ID;不设置例外时传空数组。
import sdk, { ChangeGroupMuteReq } from '@openimsdk/imsdk';

const request: ChangeGroupMuteReq = {
  groupID: groupID,
  mute: true,
  muteBypassUserIDs: ['user_002'],
};
await sdk.changeGroupMute(request);

Promise 成功表示设置请求已经完成,不表示群资料变更事件已经到达。收到事件通知后按 groupID 更新群资料,完整监听代码请参考群组概览;需要校准时可通过查询指定群组资料获取最新状态。