浏览 SDKs · uni-app / uni-app x
SDKsuni-app

开启或关闭全员禁言

修改群组全员禁言状态。

复制

changeGroupMute() 控制群组整体禁言。群主和管理员可以按 OpenIMServer 权限执行该操作。

参数说明

参数类型是否必填说明
groupIDstring要修改的群 ID。
isMutebooleantrue 开启全员禁言,false 关闭。
import { changeGroupMute } from '@/uni_modules/unix-openim-sdk'

await changeGroupMute({ groupID, isMute: true })

只有群主或具备服务端权限的管理员可以操作,最终权限和群状态由服务端校验。不要仅根据本地角色显示结果;服务端仍可能因群状态、角色变化或并发操作拒绝。群主和管理员通常仍可发送消息,因此群组禁言不表示所有用户都无法发言。

Wasm 文档中的 muteBypassUserIDs 商业扩展没有进入当前 uni-app / uni-app x 合同,请勿向 changeGroupMute() 传入该字段。商业服务端即使支持例外用户,也应以当前插件公开的类型和后续群资料为准。

返回结果

Promise 成功直接返回字符串结果,表示服务端完成本次群禁言设置,不等于所有成员界面已经更新。群资料随后可能通过 onGroupInfoChanged 到达,应按 groupID 合并;完整监听见群组概览。需要立即校准时重新查询群资料。

全员禁言与单个成员禁言是不同能力。商业版群资料可能包含禁言例外用户列表;公共客户端把缺失扩展视为“没有可用扩展数据”,不能自行推断例外权限。