TIMGroupModifyMemberInfo
功能介绍
修改群成员信息
只有群主或者管理员可以进行对群成员的身份进行修改。
直播大群不支持修改用户群内身份。
只有群主或者管理员可以进行对群成员进行禁言。
kTIMGroupModifyMemberInfoParamModifyFlag 可以按位或设置多个值,不同的flag设置不同的键。请参考interface下的 ModifyMemberInfoParams
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
modifyMemberInfoParams | ModifyMemberInfoParams | 是 | 修改群成员信息的参数 |
返回模板
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | TIMResult | TIMErrCode | 返回状态码 |
desc | string | undefined | 返回描述 |
json_param | string | undefined | 根据具具体接口返回 |
json_params | string | undefined | 兼容的字段,某些情况下会返回这个,根据具体接口返回 |
user_data | string | undefined | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { ModifyMemberInfoParams,GroupMemberInfoCustemString } from "im_electron_sdk/dist/interfaces";
let groupId=''
let identifier=''
let flag = 0
let customInfo:GroupMemberInfoCustemString={
group_member_info_custom_string_info_key : '',//必填
group_member_info_custom_string_info_value:''//必填
}
let param : ModifyMemberInfoParams = {
params: {
group_modify_member_info_group_id: groupId, //必填
group_modify_member_info_identifier: identifier,//必填
group_modify_member_info_modify_flag: flag,//必填
group_modify_member_info_name_card: '',//选填
group_modify_member_info_msg_flag: 0,//选填
group_modify_member_info_member_role: 0,//选填
group_modify_member_info_shutup_time: 0,//选填
group_modify_member_info_custom_info: [customInfo],//选填
},
data: 'test data'
}
const {code} = await timRenderInstance.TIMGroupModifyMemberInfo(param)
if(code == 0){
// 修改成功
}