TIMGroupCreate
功能介绍
创建群组
创建群组时可以指定群ID，若未指定时IM通讯云服务器会生成一个唯一的ID，以便后续操作，群组ID通过创建群组时传入的回调返回
不支持在同一个 SDKAppID 下创建两个相同 groupID 的群
memberList 指定初始的群成员（直播群 AVChatRoom 不支持指定初始群成员，memberList 请传 null）
专业版或旗舰版 SDKAppID 下，所有群类型日净增群组数上限为 1 万个。免费峰值群组数为 10 万个/月，超出免费量将产生 套餐外超量费用。
社群（Community）功能需 购买旗舰版套餐包 并 申请开通 后方可使用。
社群是一个由于共同主题而让大家聚集在一起的超大群组，可以在社群下根据不同兴趣创建多个话题。
社群用来管理群成员。社群下的所有话题不仅可以共享社群成员，还可以独立收发消息而不相互干扰。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| createGroupParams | CreateGroupParams | 是 | 创建群组的参数 |
返回模板
Promise<commonResult<GroupParams>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: GroupParams | undefined;
json_params?: GroupParams | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | GroupParams ｜ undefined | 根据具具体接口返回 |
| json_params | GroupParams ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { GroupParams,CreateGroupParams,GroupInfoCustemString,GroupMemberInfo,GroupMemberInfoCustemString } from "im_electron_sdk/dist/interfaces";
let custom_info:GroupInfoCustemString = {
group_info_custom_string_info_key: '',//必填
group_info_custom_string_info_value: ''//必填
}
let member_custom_info:GroupMemberInfoCustemString = {
group_member_info_custom_string_info_key:'',//必填
group_member_info_custom_string_info_value:'',//必填
}
let member_info :GroupMemberInfo={
group_member_info_identifier: '', //必填
group_member_info_join_time: 0,// 选填
group_member_info_member_role: 0,// 选填，参考[TIMGroupMemberRole]
group_member_info_msg_flag: 0,// 选填
group_member_info_msg_seq: 0,// 选填
group_member_info_shutup_time: 0,// 选填
group_member_info_name_card: '',// 选填
group_member_info_custom_info:[member_custom_info]// 选填
}
let group_param:GroupParams = {
create_group_param_add_option: 0,// 选填
create_group_param_group_name: '', //必填
create_group_param_group_type: 0,// 选填
create_group_param_custom_info: [custom_info],// 选填
create_group_param_face_url: '',// 选填
create_group_param_group_member_array: [member_info],// 选填
create_group_param_introduction: '',// 选填
create_group_param_notification: ''// 选填
}
let param:CreateGroupParams={
params:group_param,
data: ""
}
let {code} = await timRenderInstance.TIMGroupCreate(param);
if(code == 0){
// 创建成功
}