createGroup
功能介绍
创建自定义群组
不支持在同一个 SDKAppID 下创建两个相同 groupID 的群
memberList 指定初始的群成员(直播群 AVChatRoom 不支持指定初始群成员,memberList 请传 null)
专业版或旗舰版 SDKAppID 下,所有群类型日净增群组数上限为 1 万个。免费峰值群组数为 10 万个/月,超出免费量将产生 套餐外超量费用。
社群(Community)功能需购买旗舰版套餐包 并 申请开通 后方可使用。
社群是一个由于共同主题而让大家聚集在一起的超大群组,可以在社群下根据不同兴趣创建多个话题。
社群用来管理群成员。社群下的所有话题不仅可以共享社群成员,还可以独立收发消息而不相互干扰。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 否 | 自定义群组 ID 此参数为参数对象中的值 |
groupType | string | 是 | 群类型 此参数为参数对象中的值 |
groupName | string | 是 | 群名称,不能为 null。 此参数为参数对象中的值 |
notification | string | 否 | 群公告 此参数为参数对象中的值 |
introduction | string | 否 | 群介绍 此参数为参数对象中的值 |
faceUrl | string | 否 | 群头像Url 此参数为参数对象中的值 |
boolean | string | 否 | 是否全体禁言 此参数为参数对象中的值 |
addOpt | GroupAddOptEnum | 否 | 加群选项 此参数为参数对象中的值 |
memberList | V2TimGroupMember[] | 是 | 初始成员列表 此参数为参数对象中的值 |
isSupportTopic | boolean | 否 | 群组是否支持话题 此参数为参数对象中的值 |
返回模板
V2TimValueCallback<string>
{
code : number
desc : string
data : string // 创建的群组id
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | number | 请求结果错误码 |
desc | string | 请求结果描述符 |
data | string | 创建的群组id |
代码示例
import { TencentImSDKPlugin, GroupAddOptEnum } from 'react-native-tim-js';
// 创建群组
const createGroupRes = await TencentImSDKPlugin.v2TIMManager
.getGroupManager()
.createGroup({
groupType: 'Public', // 群类型
groupName: 'groupName', // 群名称,不能为 null。
notification: '', // 群公告
introduction: '', // 群介绍
faceUrl: '', // 群头像Url
isAllMuted: false, // 是否全体禁言
isSupportTopic: false, // 是否支持话题
addOpt: GroupAddOptEnum.V2TIM_GROUP_ADD_AUTH, // 添加群设置
memberList: [], // 初始成员列表
});
if (createGroupRes.code === 0) {
// 创建成功
createGroupRes.data; // 创建的群号
}