TIMGroupModifyGroupInfo

功能介绍

修改群信息

修改群主(群转让)的权限说明:

只有群主才有权限进行群转让操作。

直播大群不能进行群转让操作。

修改群其他信息的权限说明:

对于公开群、聊天室和直播大群,只有群主或者管理员可以修改群简介。

对于私有群,任何人可修改群简介。

参数详解

参数名称 参数类型 是否必填 描述
modifyGroupParams ModifyGroupParams 修改群信息的参数

返回模板

Promise<commonResult<string>>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: string | undefined;
    json_params?: string | undefined; // 兼容
    user_data?: string | undefined;
}

返回值详解

名称 数值类型 描述
code TIMResultTIMErrCode 返回状态码
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 { ModifyGroupParams,GroupInfoCustemString } from "im_electron_sdk/dist/interfaces";
let groupId = ''

let customString:GroupInfoCustemString={
    group_info_custom_string_info_key:'',   //必填
    group_info_custom_string_info_value:''   //必填
}

let param : ModifyGroupParams = {
    params: {
    group_modify_info_param_group_id: groupId,   //必填
    group_modify_info_param_modify_flag: 1,   //必填
    group_modify_info_param_notification: '',   //选填
    group_modify_info_param_group_name: '',   //选填
    group_modify_info_param_introduction: '',   //选填
    group_modify_info_param_face_url: '',   //选填
    group_modify_info_param_add_option: 0,   //选填
    group_modify_info_param_max_member_num: 0,   //选填
    group_modify_info_param_visible: 0,   //选填
    group_modify_info_param_searchable: 0,   //选填
    group_modify_info_param_is_shutup_all: false,   //选填
    group_modify_info_param_owner: '',   //选填
    group_modify_info_param_custom_info: [customString]   //选填
    },
    data: 'test data'
  }
const {code} = await timRenderInstance.TIMGroupModifyGroupInfo(param)
if(code == 0){
    // 修改成功
}

results matching ""

    No results matching ""