changeGroupMute
功能介绍
说明
群主或群管理员修改群禁言状态。
注意
禁言后普通成员不能发消息,群主和管理员可以继续发消息。
相关回调:
onGroupInfoChanged
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<dynamic> changeGroupMute({
required String groupID,
required bool mute,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | String | 是 | 群ID |
mute | bool | 是 | true:开启群禁言 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
~ | ~ | 无异常抛出则设置成功 |
代码示例
await OpenIM.iMManager.groupManager.changeGroupMute(
groupID: 'groupID',
mute: true,
);
// todo
函数原型
- (void)changeGroupMute:(NSString *)groupID
isMute:(BOOL)isMute
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | NSString | 是 | 群ID |
isMute | BOOL | 是 | 是否禁言 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
onSuccess | OIMSuccessCallback | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager changeGroupMute:@""
isMute:YES
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
函数原型
public void changeGroupMute(OnBase<String> callBack, String gid, boolean mute)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callBack | OnBase | 是 | 回调接口 |
gid | String | 是 | 群ID |
mute | Boolean | 是 | true 禁言 false 取消禁言 |
返回结果
代码示例
OpenIMClient.getInstance().groupManager.changeGroupMute(new OnBase<String>() {
@Override
public void onError(int code, String error) {
}
@Override
public void onSuccess(String data) {
}
},gid,mute)
函数原型
IMSDK.changeGroupMute({
groupID: string;
isMute: boolean;
}, operationID?: string): Promise<WsResponse>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 群ID |
isMute | boolean | 是 | 是否禁言 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse> | 调用成功回调 |
Promise.catch() | Promise<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();
// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();
// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.changeGroupMute({
groupID: '',
isMute: true,
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('changeGroupMute', operationID: string, {
groupID: string;
isMute: boolean;
}): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
groupID | string | 是 | 群ID |
isMute | boolean | 是 | 是否禁言 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('changeGroupMute', IMSDK.uuid(), {
groupID: '',
isMute: true,
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.changeGroupMute({
groupID: string,
isMute: boolean,
}, operationID: string): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 群ID |
isMute | boolean | 是 | 是否禁言 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.changeGroupMute({
groupID: '',
isMute: true,
}, 'operationID')
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});