产品动态
公告
Android&iOS&Windows&Mac
功能描述
社群是一个由于共同主题而让大家聚集在一起的超大群组，可以在社群下根据不同兴趣创建多个话题。
社群用来管理群成员。社群下的所有话题不仅可以共享社群成员，还可以独立收发消息而不相互干扰。
社群和话题的管理接口在核心类
V2TIMGroupManager(Java) / V2TIMManager+Group(Objective-C) 中。话题中的消息相关接口在核心类
V2TIMMessageManager(Java) / V2TIMManager+Message(Objective-C、Swift) 中。说明：
6.2.2363 及以上版本支持，从 7.7.5282 版本开始推荐使用 V2TIMCommunityManager 和 V2TIMCommunityListener 类。
需要 专业版、专业版Plus或企业版, 登录 控制台 并开启社群开关后方可使用，开关路径：Applications > Your App > Chat > Configuration > Group Configuration > Community。
效果展示
您可以使用本功能实现如下图所示的社群效果：
社群管理
创建社群
说明：
自定义的社群 ID 前缀必须是@TGS#_。
示例代码如下：
V2TIMGroupInfo v2TIMGroupInfo = new V2TIMGroupInfo();v2TIMGroupInfo.setGroupName("This is a Community");v2TIMGroupInfo.setGroupType(V2TIMManager.GROUP_TYPE_COMMUNITY);V2TIMManager.getCommunityManager().createCommunity(v2TIMGroupInfo, null, new V2TIMValueCallback<String>() {@Overridepublic void onSuccess(String groupID) {// 创建社群成功}@Overridepublic void onError(int code, String desc) {// 创建社群失败}});
let groupInfo = V2TIMGroupInfo()groupInfo.groupType = "Community"groupInfo.groupName = "CommunityForTestPermissionGroupSwift"groupInfo.defaultPermissions = 13;groupInfo.enablePermissionGroup = true;V2TIMManager.shared.createGroup(info: groupInfo, memberList: nil) { groupID inprint( "createPermissionGroupInCommunity succ, \\(groupID)")} fail: { code, desc inprint( "createPermissionGroupInCommunity fail, \\(code), \\(desc)")}
V2TIMGroupInfo *groupInfo = [[V2TIMGroupInfo alloc] init];;groupInfo.groupName = @"This is a Community";groupInfo.groupType = GroupType_Community;[[V2TIMManager sharedInstance] createCommunity:groupInfo memberList:nil succ:^(NSString *groupID) {// 创建社群成功} fail:^(int code, NSString *desc) {// 创建社群失败}];
template <class T>class ValueCallback final : public V2TIMValueCallback<T> {public:using SuccessCallback = std::function<void(const T&)>;using ErrorCallback = std::function<void(int, const V2TIMString&)>;ValueCallback() = default;~ValueCallback() override = default;void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {success_callback_ = std::move(success_callback);error_callback_ = std::move(error_callback);}void OnSuccess(const T& value) override {if (success_callback_) {success_callback_(value);}}void OnError(int error_code, const V2TIMString& error_message) override {if (error_callback_) {error_callback_(error_code, error_message);}}private:SuccessCallback success_callback_;ErrorCallback error_callback_;};V2TIMGroupInfo info;info.groupType = "Community";info.groupName = "This is a Community";auto callback = new ValueCallback<V2TIMString>{};callback->SetCallback([=](const V2TIMString& groupID) {// 创建社群成功delete callback;},[=](int error_code, const V2TIMString& error_message) {// 创建社群失败delete callback;});V2TIMManager::GetInstance()->GetCommunityManager()->CreateCommunity(info, {}, callback);
获取加入的社群列表
示例代码如下：
V2TIMManager.getCommunityManager().getJoinedCommunityList(new V2TIMValueCallback<List<V2TIMGroupInfo>>() {@Overridepublic void onSuccess(List<V2TIMGroupInfo> v2TIMGroupInfos) {// 获取社群列表成功}@Overridepublic void onError(int code, String desc) {// 获取社群列表失败}});
V2TIMManager.shared.getJoinedCommunityList { groupList ingroupList.forEach { item inprint( item.description)}} fail: { code, desc inprint( "getJoinedCommunityList fail, \\(code), \\(desc)")}
[[V2TIMManager sharedInstance] getJoinedCommunityList:^(NSArray<V2TIMGroupInfo *> *groupList) {// 获取社群列表成功} fail:^(int code, NSString *desc) {// 获取社群列表失败}];
template <class T>class ValueCallback final : public V2TIMValueCallback<T> {public:using SuccessCallback = std::function<void(const T&)>;using ErrorCallback = std::function<void(int, const V2TIMString&)>;ValueCallback() = default;~ValueCallback() override = default;void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {success_callback_ = std::move(success_callback);error_callback_ = std::move(error_callback);}void OnSuccess(const T& value) override {if (success_callback_) {success_callback_(value);}}void OnError(int error_code, const V2TIMString& error_message) override {if (error_callback_) {error_callback_(error_code, error_message);}}private:SuccessCallback success_callback_;ErrorCallback error_callback_;};auto callback = new ValueCallback<V2TIMGroupInfoVector>{};callback->SetCallback([=](const V2TIMGroupInfoVector& groupInfoList) {// 获取社群列表成功delete callback;},[=](int error_code, const V2TIMString& error_message) {// 获取社群列表失败delete callback;});V2TIMManager::GetInstance()->GetCommunityManager()->GetJoinedCommunityList(callback);
其他管理接口
其他功能跟普通群组使用方法一样，涉及的接口有：
分类 | 功能 | 接口 |
社群管理 | ||
| ||
| ||
| ||
| ||
社群成员管理 | ||
| ||
| ||
| ||
话题管理
同一社群下可创建多个话题，多个话题共享一套社群成员关系，但不同话题内独立收发消息、互不干扰。
说明：
登录 控制台 并开启社群开关后方可使用，开关路径：Applications > Your App > Chat > Configuration > Group Configuration > Community。
创建话题
创建话题分两步：
1. 创建
V2TIMTopicInfo (Java / Swift / Objective-C / C++) 对象。2. 调用
createTopicInCommunity (Java / Swift / Objective-C / C++) 接口创建话题。说明：
自定义的话题 ID 组成为：GroupId+@TOPIC#_+自定义部分。例如社群 ID 为 @TGS#_123，自定义部分为 TestTopic，那么话题 ID 为 @TGS#_123@TOPIC#_TestTopic。
从 8.4 版本开始，接口支持创建 “私密话题”（设置
V2TIMTopicInfo 的 topicType 为 “Private”），“私密话题” 有自己的成员列表（成员上限 10000 人），社群成员需要加入私密话题才能发言（私密话题需要购买企业版套餐包）。示例代码如下：
V2TIMTopicInfo topicInfo = new V2TIMTopicInfo();// 话题类型，"Public" ：公开话题；"Private" ：私密话题topicInfo.setTopicType(topicType);topicInfo.setTopicName(topicName);topicInfo.setTopicFaceUrl(topicFaceUrl);topicInfo.setIntroduction(topicIntroduction);topicInfo.setNotification(topicNotification);topicInfo.setCustomString(topicCustomString);// 以下字段只针对私密话题有效topicInfo.setTopicAddOpt(V2TIMTopicInfo.V2TIM_TOPIC_ADD_AUTH);topicInfo.setTopicApproveOpt(V2TIMTopicInfo.V2TIM_TOPIC_ADD_AUTH);topicInfo.setMemberMaxCount(10000);List<V2TIMCreateGroupMemberInfo> memberList = new ArrayList<>();V2TIMCreateGroupMemberInfo memberInfo = new V2TIMCreateGroupMemberInfo();memberInfo.setUserID("xixi");memberInfo.setRole(1);memberList.add(memberInfo);topicInfo.setMemberList(memberList);// groupID 填支持话题的社群 IDV2TIMManager.getCommunityManager().createTopicInCommunity(groupID, topicInfo, new V2TIMValueCallback<String>() {@Overridepublic void onSuccess(String topicID) {// 创建话题成功}@Overridepublic void onError(int code, String desc) {// 创建话题失败}});
let topicInfo = V2TIMTopicInfo()// 话题类型，"Public" ：公开话题；"Private" ：私密话题topicInfo.topicType = "Public"topicInfo.topicName = "swift topic name"topicInfo.topicFaceURL = "topicFaceUrl"topicInfo.introduction = "topicIntroduction"topicInfo.notification = "topicNotification"topicInfo.customString = "topicCustomString"// 以下字段只针对私密话题有效topicInfo.topicAddOpt = .V2TIM_GROUP_ADD_AUTHtopicInfo.topicApproveOpt = .V2TIM_GROUP_ADD_AUTHtopicInfo.memberMaxCount = 10000let memberInfo = V2TIMCreateGroupMemberInfo()memberInfo.userID = "xixi"memberInfo.role = 1topicInfo.memberList.append(memberInfo)V2TIMManager.shared.createTopicInCommunity(groupID: "groupID", topicInfo: topicInfo) { topicID inprint( "createTopicInCommunity succ, \\(topicID)")} fail: { code, desc inprint( "createTopicInCommunity fail, \\(code), \\(desc)")}
V2TIMTopicInfo *topicInfo = [[V2TIMTopicInfo alloc] init];// 话题类型，"Public" ：公开话题；"Private" ：私密话题topicInfo.topicType = @"Public";topicInfo.topicName = @"topicName";topicInfo.topicFaceURL = @"topicFaceUrl";topicInfo.introduction = @"topicIntroduction";topicInfo.notification = @"topicNotification";topicInfo.customString = @"topicCustomString";// 以下字段只针对私密话题有效topicInfo.topicAddOpt = V2TIM_GROUP_ADD_AUTH;topicInfo.topicApproveOpt = V2TIM_GROUP_ADD_AUTH;topicInfo.memberMaxCount = 10000;V2TIMCreateGroupMemberInfo *memberInfo = [[V2TIMCreateGroupMemberInfo alloc] init];memberInfo.userID = @"xixi";memberInfo.role = V2TIM_GROUP_MEMBER_ROLE_MEMBER;topicInfo.memberList = @[memberInfo];// groupID 填支持话题的社群 ID[[V2TIMManager sharedInstance] createTopicInCommunity:@"groupID" topicInfo:topicInfo succ:^(NSString *topicID) {// 创建话题成功} fail:^(int code, NSString *desc) {// 创建话题失败}];
template <class T>class ValueCallback final : public V2TIMValueCallback<T> {public:using SuccessCallback = std::function<void(const T&)>;using ErrorCallback = std::function<void(int, const V2TIMString&)>;ValueCallback() = default;~ValueCallback() override = default;void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {success_callback_ = std::move(success_callback);error_callback_ = std::move(error_callback);}void OnSuccess(const T& value) override {if (success_callback_) {success_callback_(value);}}void OnError(int error_code, const V2TIMString& error_message) override {if (error_callback_) {error_callback_(error_code, error_message);}}private:SuccessCallback success_callback_;ErrorCallback error_callback_;};V2TIMTopicInfo topicInfo;// 话题类型，"Public" ：公开话题；"Private" ：私密话题topicInfo.topicType = "Public";topicInfo.topicID = "topicID";topicInfo.topicName = "topicName";topicInfo.topicFaceURL = "topicFaceURL";topicInfo.introduction = "introduction";topicInfo.notification = "notification";// 以下字段只针对私密话题有效topicInfo.topicAddOpt = V2TIM_GROUP_ADD_AUTH;topicInfo.topicApproveOpt = V2TIM_GROUP_ADD_AUTH;topicInfo.memberMaxCount = 20;V2TIMCreateGroupMemberInfo member;member.userID = "xixi";member.role = V2TIM_GROUP_MEMBER_ROLE_MEMBER;V2TIMCreateGroupMemberInfoVector member_list;member_list.PushBack(member);topicInfo.memberlist = member_list;auto callback = new ValueCallback<V2TIMString>{};callback->SetCallback([=](const V2TIMString& string) {// 创建话题成功delete callback;},[=](int error_code, const V2TIMString& error_message) {// 创建话题失败delete callback;});// groupID 填支持话题的社群 IDV2TIMManager::GetInstance()->GetCommunityManager()->CreateTopicInCommunity("groupID", topicInfo, callback);
删除话题
示例代码如下：
V2TIMManager.getCommunityManager().deleteTopicFromCommunity(groupID, topicIDList, new V2TIMValueCallback<List<V2TIMTopicOperationResult>>() {@Overridepublic void onSuccess(List<V2TIMTopicOperationResult> v2TIMTopicOperationResults) {// 删除话题成功}@Overridepublic void onError(int code, String desc) {// 删除话题失败}});
V2TIMManager.shared.deleteTopicFromCommunity(groupID: "groupID", topicIDList: ["topic1","topic2"]) { resultList inresultList.forEach { item in// V2TIMTopicOperationResultprint( item.description)}} fail: { code, desc inprint( "deleteTopicFromCommunity fail, \\(code), \\(desc)")}
[[V2TIMManager sharedInstance] deleteTopicFromCommunity:@"groupID" topicIDList:@[@"topic1", @"topic2"] succ:^(NSMutableArray<V2TIMTopicOperationResult *> *resultList) {// 删除话题成功} fail:^(int code, NSString *desc) {// 删除话题失败}];
template <class T>class ValueCallback final : public V2TIMValueCallback<T> {public:using SuccessCallback = std::function<void(const T&)>;using ErrorCallback = std::function<void(int, const V2TIMString&)>;ValueCallback() = default;~ValueCallback() override = default;void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {success_callback_ = std::move(success_callback);error_callback_ = std::move(error_callback);}void OnSuccess(const T& value) override {if (success_callback_) {success_callback_(value);}}void OnError(int error_code, const V2TIMString& error_message) override {if (error_callback_) {error_callback_(error_code, error_message);}}private:SuccessCallback success_callback_;ErrorCallback error_callback_;};V2TIMStringVector topicIDList;topicIDList.PushBack("topic1");topicIDList.PushBack("topic2");auto callback = new ValueCallback<V2TIMTopicOperationResultVector>{};callback->SetCallback([=](const V2TIMTopicOperationResultVector& topicOperationResultList) {// 删除话题成功delete callback;},[=](int error_code, const V2TIMString& error_message) {// 删除话题失败delete callback;});V2TIMManager::GetInstance()->GetCommunityManager()->DeleteTopicFromCommunity("groupID", topicIDList, callback);
修改话题信息
修改话题信息分两步：
1. 创建
V2TIMTopicInfo (Java / Swift / Objective-C / C++) 对象，并设置需要修改的字段。2. 调用
setTopicInfo (Java / Swift / Objective-C / C++) 接口修改话题信息。示例代码如下：
V2TIMTopicInfo topicInfo = new V2TIMTopicInfo();topicInfo.setTopicID(topicID);topicInfo.setTopicName(topicName);topicInfo.setTopicFaceUrl(topicFaceUrl);topicInfo.setIntroduction(topicIntroduction);topicInfo.setNotification(topicNotification);topicInfo.setCustomString(topicCustomString);topicInfo.setDraft(topicDraft);topicInfo.setAllMute(false);V2TIMManager.getCommunityManager().setTopicInfo(topicInfo, new V2TIMCallback() {@Overridepublic void onSuccess() {// 修改话题信息成功}@Overridepublic void onError(int code, String desc) {// 修改话题信息失败}});
let topicInfo = V2TIMTopicInfo()topicInfo.topicID = "topicID"topicInfo.topicName = "swift topic name"topicInfo.topicFaceURL = "topicFaceUrl"topicInfo.introduction = "topicIntroduction"topicInfo.notification = "topicNotification"topicInfo.customString = "topicCustomString"topicInfo.draftText = "topicDraft"V2TIMManager.shared.setTopicInfo(topicInfo: topicInfo) {print( "setTopicInfo succ, \\(topicInfo.description)")} fail: { code, desc inprint( "setTopicInfo fail, \\(code), \\(desc)")}
V2TIMTopicInfo *topicInfo = [[V2TIMTopicInfo alloc] init];topicInfo.topicID = @"topicID";topicInfo.topicName = @"topicName";topicInfo.topicFaceURL = @"topicFaceUrl";topicInfo.introduction = @"topicIntroduction";topicInfo.notification = @"topicNotification";topicInfo.customString = @"topicCustomString";topicInfo.draftText = @"topicDraft";topicInfo.isAllMuted = NO;[[V2TIMManager sharedInstance] setTopicInfo:topicInfo succ:^{// 修改话题信息成功} fail:^(int code, NSString *desc) {// 修改话题信息失败}];
class Callback final : public V2TIMCallback {public:using SuccessCallback = std::function<void()>;using ErrorCallback = std::function<void(int, const V2TIMString&)>;Callback() = default;~Callback() override = default;void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {success_callback_ = std::move(success_callback);error_callback_ = std::move(error_callback);}void OnSuccess() override {if (success_callback_) {success_callback_();}}void OnError(int error_code, const V2TIMString& error_message) override {if (error_callback_) {error_callback_(error_code, error_message);}}private:SuccessCallback success_callback_;ErrorCallback error_callback_;};V2TIMTopicInfo topicInfo;topicInfo.topicID = "topicID";topicInfo.topicName = "topicName";topicInfo.notification = "topicFaceURL";topicInfo.introduction = "introduction";topicInfo.topicFaceURL = "notification";topicInfo.customString = "customString";topicInfo.modifyFlag = V2TIMTopicInfoModifyFlag::V2TIM_COMMUNITY_MODIFY_FLAG_TOPIC_NAME |V2TIMTopicInfoModifyFlag::V2TIM_COMMUNITY_MODIFY_FLAG_TOPIC_NOTIFICATION |V2TIMTopicInfoModifyFlag::V2TIM_COMMUNITY_MODIFY_FLAG_TOPIC_INTRODUCTION |V2TIMTopicInfoModifyFlag::V2TIM_COMMUNITY_MODIFY_FLAG_TOPIC_FACE_URL |V2TIMTopicInfoModifyFlag::V2TIM_COMMUNITY_MODIFY_FLAG_TOPIC_CUSTOM_STRING;auto callback = new Callback;callback->SetCallback([=]() {// 修改话题信息成功delete callback;},[=](int error_code, const V2TIMString& error_message) {// 修改话题信息失败delete callback;});V2TIMManager::GetInstance()->GetCommunityManager()->SetTopicInfo(topicInfo, callback);
话题的消息接收选项可以选择是否继承自社群，接口为
setInheritMessageReceiveOptionFromCommunity（Java / Swift / Objective-C / C++）。示例代码如下：
V2TIMTopicInfo topicInfo = new V2TIMTopicInfo();topicInfo.setTopicID(topicID);topicInfo.setInheritMessageReceiveOptionFromCommunity(true, new V2TIMCallback() {@Overridepublic void onSuccess() {// 继承成功}@Overridepublic void onError(int code, String desc) {// 继承失败}});
let topicInfo = V2TIMTopicInfo()topicInfo.topicID = "@TGS#_@TGS#cIIYRJIM62C6@TOPIC#_@TOPIC#cKIYRJIM62CD"topicInfo.setInheritMessageReceiveOptionFromCommunity(isInherit: true) {print( "enableTopitInheritMsgFlagFromCommunity success")} fail: { code, desc inprint( "enableTopitInheritMsgFlagFromCommunity fail, \\(code), \\(desc)")}
V2TIMTopicInfo *topicInfo = [[V2TIMTopicInfo alloc] init];topicInfo.topicID = @"topicID";[topicInfo setInheritMessageReceiveOptionFromCommunity:YES succ:^{// 继承成功} fail:^(int code, NSString *desc) {// 继承失败}];
class Callback final : public V2TIMCallback {public:using SuccessCallback = std::function<void()>;using ErrorCallback = std::function<void(int, const V2TIMString&)>;Callback() = default;~Callback() override = default;void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {success_callback_ = std::move(success_callback);error_callback_ = std::move(error_callback);}void OnSuccess() override {if (success_callback_) {success_callback_();}}void OnError(int error_code, const V2TIMString& error_message) override {if (error_callback_) {error_callback_(error_code, error_message);}}private:SuccessCallback success_callback_;ErrorCallback error_callback_;};auto callback = new Callback;callback->SetCallback([=]() {// 继承成功delete callback;},[=](int error_code, const V2TIMString& error_message) {// 继承失败delete callback;});V2TIMTopicInfo topicInfo;topicInfo.topicID = "topicID";topicInfo.SetInheritMessageReceiveOptionFromCommunity(true, callback);
获取话题列表
当 topicIDList 列表为空时，为获取该社群下的所有话题列表。
当 topicIDList 填入指定的话题 ID 时，为获取填入的话题列表。
示例代码如下：
V2TIMManager.getCommunityManager().getTopicInfoList(groupID, topicIDList, new V2TIMValueCallback<List<V2TIMTopicInfoResult>>() {@Overridepublic void onSuccess(List<V2TIMTopicInfoResult> v2TIMTopicInfoResults) {// 获取话题列表成功}@Overridepublic void onError(int code, String desc) {// 获取话题列表失败}});
V2TIMManager.shared.getTopicInfoList(groupID: "groupID", topicIDList: ["topic1","topic2"]) { resultList inresultList.forEach { item in// V2TIMTopicInfoResultprint( "\\(item.description)")}} fail: { code, desc inprint( "getTopicInfoList fail, \\(code), \\(desc)")}
[[V2TIMManager sharedInstance] getTopicInfoList:@"groupID" topicIDList:@[@"topic1", @"topic2"] succ:^(NSMutableArray<V2TIMTopicInfoResult *> *resultList) {// 获取话题列表成功} fail:^(int code, NSString *desc) {// 获取话题列表失败}];
template <class T>class ValueCallback final : public V2TIMValueCallback<T> {public:using SuccessCallback = std::function<void(const T&)>;using ErrorCallback = std::function<void(int, const V2TIMString&)>;ValueCallback() = default;~ValueCallback() override = default;void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {success_callback_ = std::move(success_callback);error_callback_ = std::move(error_callback);}void OnSuccess(const T& value) override {if (success_callback_) {success_callback_(value);}}void OnError(int error_code, const V2TIMString& error_message) override {if (error_callback_) {error_callback_(error_code, error_message);}}private:SuccessCallback success_callback_;ErrorCallback error_callback_;};V2TIMStringVector topicIDList;topicIDList.PushBack("topic1");topicIDList.PushBack("topic2");auto callback = new ValueCallback<V2TIMTopicInfoResultVector>{};callback->SetCallback([=](const V2TIMTopicInfoResultVector& topicInfoResultList) {// 获取话题列表成功delete callback;},[=](int error_code, const V2TIMString& error_message) {// 获取话题列表失败delete callback;});V2TIMManager::GetInstance()->GetCommunityManager()->GetTopicInfoList("groupID", topicIDList, callback);
实现话题分组
社群-分组-话题三级结构中的分组实现原理为：
社群资料的
customInfo (Java / Swift / Objective-C / C++) 中定义一个字段保存该社群的话题分组列表；每个话题所属的分组，存储于话题资料的 customString (Java / Swift / Objective-C / C++) 字段中。加载社群时，根据社群（群组）资料中的
customInfo 的话题分组列表字段，展示分组列表。加载社群下的 Topic 列表时，通过话题资料中的
customString 获取分组名分配到所属分组中。说明：
社群（群组）中
customInfo 的话题分组列表字段名，key 值，可由您自行定义。以下示例代码中，将其命名为 topic_category 。配置社群的分组列表
此处直接修改群组
groupInfo 的 customInfo 即可。此处为一个 Map，key 值是您定义的话题分组列表字段名。示例代码如下：
List<String> categoryList = new ArrayList<>();categoryList.add("分组1");categoryList.add("分组2");byte[] categoriesByteArray = gson.toJson(categoryList).getBytes();Map<String, byte[]> customMap = new HashMap<>();// 需要先在控制台配置群自定义字段 topic_categorycustomMap.put("topic_category", categoriesByteArray);V2TIMGroupInfo modifyInfo = new V2TIMGroupInfo();modifyInfo.setGroupID(groupID);modifyInfo.setCustomInfo(customMap);V2TIMManager.getGroupManager().setGroupInfo(modifyInfo, new V2TIMCallback() {@Overridepublic void onSuccess() {// 修改群资料成功}@Overridepublic void onError(int code, String desc) {// 修改群资料失败}});
let info = V2TIMGroupMemberFullInfo()info.userID = "userA"info.nameCard = "userA_namecard"info.customInfo = ["topic_category": "value1".data(using: .utf8) ?? Data()]V2TIMManager.shared.setGroupMemberInfo(groupID: "groupID", info: info) {print( info.description)} fail: { code, desc inprint( "setGroupMemberInfo fail, \\(code), \\(desc)")}
NSArray *categoryList = @[@"分组 1", @"分组 2"];NSError *error = nil;NSData *data = [NSJSONSerialization dataWithJSONObject:categoryListoptions:NSJSONWritingPrettyPrintederror:&error];if ([data length] > 0 && error == nil) {// 需要先在控制台配置群自定义字段 topic_categoryNSDictionary *customInfo = @{@"topic_category": data};V2TIMGroupInfo *info = [[V2TIMGroupInfo alloc] init];info.groupID = @"需要修改的群 ID";info.customInfo = customInfo;[[V2TIMManager sharedInstance] setGroupInfo:infosucc:^{// 修改群资料成功} fail:^(int code, NSString *desc) {// 修改群资料失败}];}
class Callback final : public V2TIMCallback {public:using SuccessCallback = std::function<void()>;using ErrorCallback = std::function<void(int, const V2TIMString&)>;Callback() = default;~Callback() override = default;void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {success_callback_ = std::move(success_callback);error_callback_ = std::move(error_callback);}void OnSuccess() override {if (success_callback_) {success_callback_();}}void OnError(int error_code, const V2TIMString& error_message) override {if (error_callback_) {error_callback_(error_code, error_message);}}private:SuccessCallback success_callback_;ErrorCallback error_callback_;};V2TIMGroupInfo info;info.groupID = "groupA";V2TIMCustomInfo customInfo;std::string str{u8"[\\"分组1\\", \\"分组2\\"]"};// 需要先在控制台配置群自定义字段 topic_categorycustomInfo.Insert("topic_category", {reinterpret_cast<const uint8_t*>(str.data()), str.size()});info.modifyFlag = V2TIMGroupInfoModifyFlag::V2TIM_GROUP_INFO_MODIFY_FLAG_CUSTOM_INFO;auto callback = new Callback;callback->SetCallback([=]() {// 修改群资料成功delete callback;},[=](int error_code, const V2TIMString& error_message) {// 修改群资料失败delete callback;});V2TIMManager::GetInstance()->GetGroupManager()->SetGroupInfo(info, callback);
获取社群的分组列表
示例代码如下：
String groupID = "group1";List<String> groupIDList = new ArrayList<>();groupIDList.add(groupID);V2TIMManager.getGroupManager().getGroupsInfo(groupIDList, new V2TIMValueCallback<List<V2TIMGroupInfoResult>>() {@Overridepublic void onSuccess(List<V2TIMGroupInfoResult> v2TIMGroupInfos) {if (v2TIMGroupInfos.size() == 0) {return;}V2TIMGroupInfoResult v2TIMGroupInfoResult = v2TIMGroupInfos.get(0);if (v2TIMGroupInfoResult.getResultCode() == BaseConstants.ERR_SUCC) {byte[] topicCategoryBytes = v2TIMGroupInfoResult.getGroupInfo().getCustomInfo().get("topic_category");List<String> topicCategories = null;if (topicCategoryBytes != null) {Gson gson = new Gson();try {// 解析出分组列表topicCategories = gson.fromJson(new String(topicCategoryBytes), List.class);} catch (JsonParseException e) {}}}}@Overridepublic void onError(int code, String desc) {}});
let groupIDList = ["group1"]V2TIMManager.shared.getGroupsInfo(groupIDList: groupIDList, succ: { groupResultList in// 获取成功if groupResultList.isEmpty {return}let result = groupResultList.first!if result.resultCode != 0 {return}guard let categoryData = result.info?.customInfo?["topic_category"] as? Data else {return}var categoryList: [Any]?do {let jsonObject = try JSONSerialization.jsonObject(with: categoryData, options: .allowFragments)// 解析出分组列表if let jsonArray = jsonObject as? [Any] {categoryList = jsonArray}} catch {// 处理 JSON 解析错误}}, fail: { code, desc in// 获取失败})
NSArray *groupIDList = @[@"group1"];[[V2TIMManager sharedInstance] getGroupsInfo:groupIDListsucc:^(NSArray<V2TIMGroupInfoResult *> *groupResultList) {// 获取成功if (groupResultList.count == 0) {return;}V2TIMGroupInfoResult *result = groupResultList.firstObject;if (result.resultCode != 0) {return;}NSData *categoryData = result.info.customInfo[@"topic_category"];if (categoryData == nil) {return;}NSArray *categoryList;NSError *error = nil;id jsonObject = [NSJSONSerialization JSONObjectWithData:categoryDataoptions:NSJSONReadingAllowFragmentserror:nil];if (jsonObject != nil && error == nil) {// 解析出分组列表categoryList = (NSArray *)jsonObject;}} fail:^(int code, NSString *desc) {// 获取失败}];
template <class T>class ValueCallback final : public V2TIMValueCallback<T> {public:using SuccessCallback = std::function<void(const T&)>;using ErrorCallback = std::function<void(int, const V2TIMString&)>;ValueCallback() = default;~ValueCallback() override = default;void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {success_callback_ = std::move(success_callback);error_callback_ = std::move(error_callback);}void OnSuccess(const T& value) override {if (success_callback_) {success_callback_(value);}}void OnError(int error_code, const V2TIMString& error_message) override {if (error_callback_) {error_callback_(error_code, error_message);}}private:SuccessCallback success_callback_;ErrorCallback error_callback_;};V2TIMStringVector groupIDList;groupIDList.PushBack("group1");auto callback = new ValueCallback<V2TIMGroupInfoResultVector>{};callback->SetCallback([=](const V2TIMGroupInfoResultVector& groupInfoResultList) {if (groupInfoResultList.Size() == 1) {const V2TIMGroupInfoResult& groupInfoResult = groupInfoResultList[0];if (groupInfoResult.resultCode == 0) {V2TIMGroupInfo info = groupInfoResult.info;V2TIMCustomInfo customInfo = info.customInfo;if (customInfo.Count("topic_category")) {const V2TIMBuffer& topicCategory = customInfo.Get("topic_category");// 解析出分组列表 ...}}}delete callback;},[=](int error_code, const V2TIMString& error_message) {// 获取社群的分组列表失败delete callback;});V2TIMManager::GetInstance()->GetGroupManager()->GetGroupsInfo(groupIDList, callback);
为话题添加分组
话题所属的分组可以使用话题的
customString 字段来保存。示例代码如下：
Map<String, Object> map = new HashMap<>();map.put("category", "分组1");Gson gson = new Gson();V2TIMTopicInfo topicInfo = new V2TIMTopicInfo();topicInfo.setTopicID(topicID);topicInfo.setCustomString(gson.toJson(map));V2TIMManager.getCommunityManager().setTopicInfo(topicInfo, new V2TIMCallback() {@Overridepublic void onSuccess() {// 修改话题信息成功}@Overridepublic void onError(int code, String desc) {// 修改话题信息失败}});
let topicInfo = V2TIMTopicInfo()topicInfo.topicID = "topicID"topicInfo.topicName = "topicName swift"topicInfo.customString = "customString"V2TIMManager.shared.setTopicInfo(topicInfo: topicInfo) {print( "setTopicInfo succ, \\(topicInfo.description)")} fail: { code, desc inprint( "setTopicInfo fail, \\(code), \\(desc)")}
NSDictionary *dict = @{@"category": @"分组 1"};NSError *error = nil;NSData *data = [NSJSONSerialization dataWithJSONObject:dictoptions:0error:&error];if ([data length] > 0 && error == nil) {NSString *dataStr = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];V2TIMTopicInfo *info = [[V2TIMTopicInfo alloc] init];info.topicID = @"需要设置的话题 ID";info.customString = dataStr;[[V2TIMManager sharedInstance] setTopicInfo:info succ:^{// 设置话题资料成功} fail:^(int code, NSString *desc) {// 设置话题资料失败}];}
class Callback final : public V2TIMCallback {public:using SuccessCallback = std::function<void()>;using ErrorCallback = std::function<void(int, const V2TIMString&)>;Callback() = default;~Callback() override = default;void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {success_callback_ = std::move(success_callback);error_callback_ = std::move(error_callback);}void OnSuccess() override {if (success_callback_) {success_callback_();}}void OnError(int error_code, const V2TIMString& error_message) override {if (error_callback_) {error_callback_(error_code, error_message);}}private:SuccessCallback success_callback_;ErrorCallback error_callback_;};V2TIMTopicInfo topicInfo;topicInfo.topicID = "topicID";topicInfo.customString = u8"{\\"category\\": \\"分组1\\"}}";topicInfo.modifyFlag = V2TIMTopicInfoModifyFlag::V2TIM_COMMUNITY_MODIFY_FLAG_TOPIC_CUSTOM_STRING;auto callback = new Callback;callback->SetCallback([=]() {// 修改话题信息成功delete callback;},[=](int error_code, const V2TIMString& error_message) {// 修改话题信息失败delete callback;});V2TIMManager::GetInstance()->GetCommunityManager()->SetTopicInfo(topicInfo, callback);
获取话题所在分组
监听话题回调
在
V2TIMGroupListener (Java / Swift / Objective-C / C++) 中增加了话题相关的回调方法，onTopicCreated，onTopicDeleted，onTopicInfoChanged，用来监听话题事件。 示例代码如下：
V2TIMCommunityListener v2TIMCommunityListener = new V2TIMCommunityListener() {@Overridepublic void onCreateTopic(String groupID, String topicID) {// 监听话题创建通知}@Overridepublic void onDeleteTopic(String groupID, List<String> topicIDList) {// 监听话题删除通知}@Overridepublic void onChangeTopicInfo(String groupID, V2TIMTopicInfo topicInfo) {// 监听话题信息更新通知}@Overridepublic void onReceiveTopicRESTCustomData(String topicID, byte[] customData) {// 收到 RESTAPI 下发的话题自定义系统消息}};V2TIMManager.getCommunityManager().addCommunityListener(v2TIMCommunityListener);
V2TIMManager.shared.addCommunityListener(listener: self)func onCreateTopic(groupID: String, topicID: String) {print( "groupID:\\(groupID), topicID:\\(topicID)")}func onDeleteTopic(groupID: String, topicIDList: Array<String>) {print( "groupID:\\(groupID), topicIDList:\\(topicIDList)")}func onChangeTopicInfo(groupID: String, topicInfo: V2TIMTopicInfo) {print( "groupID:\\(groupID), topicInfo:\\(topicInfo.description), inheritMsgFlag:\\(topicInfo.isInheritMessageReceiveOptionFromCommunity())")}func onReceiveTopicRESTCustomData(topicID: String, data: Data?) {print( "\\(topicID), data:\\(data?.description ?? "nil")")}
[[V2TIMManager sharedInstance] addCommunityListener:self];- (void)onCreateTopic:(NSString *)groupID topicID:(NSString *)topicID {// 监听话题创建通知}- (void)onDeleteTopic:(NSString *)groupID topicIDList:(NSArray<NSString *> *)topicIDList {// 监听话题删除通知}- (void)onChangeTopicInfo:(NSString *)groupID topicInfo:(V2TIMTopicInfo *)topicInfo {// 监听话题信息更新通知}- (void)onReceiveTopicRESTCustomData:(NSString *)topicID data:(NSData *)data {// 收到 RESTAPI 下发的话题自定义系统消息}
class CommunityListener final : public V2TIMCommunityListener {public:CommunityListener() = default;~CommunityListener() override = default;void OnCreateTopic(const V2TIMString& groupID, const V2TIMString& topicID) override {// 监听话题创建通知}void OnDeleteTopic(const V2TIMString& groupID, const V2TIMStringVector& topicIDList) override {// 监听话题删除通知}void OnChangeTopicInfo(const V2TIMString& groupID, const V2TIMTopicInfo& topicInfo) override {// 监听话题信息更新通知}void OnReceiveTopicRESTCustomData(const V2TIMString &topicID, const V2TIMBuffer &customData) {// 收到 RESTAPI 下发的话题自定义系统消息}};// 添加群事件监听器，注意在移除监听器之前需要保持 groupListener 的生命期，以免接收不到事件回调CommunityListener communityListener;V2TIMManager::GetInstance()->GetCommunityManager()->AddCommunityListener(&communityListener);
话题消息
话题消息相关功能跟普通消息使用方法一样，涉及的接口有：
功能 | 接口 | 说明 |
参数 groupID 填为话题 topicID | ||
消息中的 groupID 即为话题 topicID | ||
参数 groupID 填为话题 topicID | ||
参数 groupID 填为话题 topicID | ||
参数 groupID 填为话题 topicID |
文档反馈