tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

Android&iOS&Windows&Mac

PDF
聚焦模式
字号
最后更新时间: 2025-01-03 10:36:20

功能描述

在某些场景下,您可能需要对好友进行分组,例如分为 "大学同学"、"公司同事" 等,您可以调用以下接口实现。

新建好友分组

您可以调用 createFriendGroup (Java / Swift / Objective-C / C++) 接口新建好友分组。
示例代码如下:
Java
Swift
Objective-C
C++
List<String> userIDList = new ArrayList<>();
userIDList.add("user1");
userIDList.add("user2");
V2TIMManager.getFriendshipManager().createFriendGroup("大学好友", userIDList, new V2TIMValueCallback<List<V2TIMFriendOperationResult>>() {
@Override
public void onSuccess(List<V2TIMFriendOperationResult> v2TIMFriendOperationResults) {
// 创建好友分组成功
}

@Override
public void onError(int code, String desc) {
// 创建好友分组失败
}
});
V2TIMManager.shared.createFriendGroup(groupName: "大学好友", userIDList: ["userID1", "userID2"]) { resultList in
resultList.forEach { item in
// V2TIMFriendOperationResult
print( item.description)
}
} fail: { code, desc in
print( "createFriendGroup fail, \\(code), \\(desc)")
}
// 创建好友分组
[[V2TIMManager sharedInstance] createFriendGroup:@"大学好友" userIDList:@[@"user1", @"user2"] succ:^(NSArray<V2TIMFriendOperationResult *> *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_;
};

V2TIMString groupName = u8"大学好友";
V2TIMStringVector userIDList;
userIDList.PushBack(u8"user1");
userIDList.PushBack(u8"user2");

auto callback = new ValueCallback<V2TIMFriendOperationResultVector>{};
callback->SetCallback(
[=](const V2TIMFriendOperationResultVector& friendOperationResultList) {
// 创建好友分组成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 创建好友分组失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->CreateFriendGroup(groupName, userIDList, callback);

删除好友分组

您可以调用 deleteFriendGroup (Java / Swift / Objective-C / C++) 接口删除好友分组。删除好友分组不会删除好友关系。
示例代码如下:
Java
Swift
Objective-C
C++
List<String> friendGroupList = new ArrayList<>();
friendGroupList.add("大学好友");
V2TIMManager.getFriendshipManager().deleteFriendGroup(friendGroupList, new V2TIMCallback() {
@Override
public void onSuccess() {
// 删除好友分组成功
}

@Override
public void onError(int code, String desc) {
// 删除好友分组失败
}
});
// 删除好友分组
V2TIMManager.shared.deleteFriendGroup(groupNameList: ["大学好友"]) {
print( "deleteFriendGroup succ")
} fail: { code, desc in
print( "deleteFriendGroup fail, \\(code), \\(desc)")
}
// 删除好友分组
[[V2TIMManager sharedInstance] deleteFriendGroup:@[@"大学好友"] 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_;
};

V2TIMStringVector groupNameList;
groupNameList.PushBack(u8"大学好友");

auto callback = new Callback{};
callback->SetCallback(
[=]() {
// 删除好友分组成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 删除好友分组失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->DeleteFriendGroup(groupNameList, callback);

重命名好友分组

您可以调用 renameFriendGroup (Java / Swift / Objective-C / C++) 接口重命名好友分组。
示例代码如下:
Java
Swift
Objective-C
C++
V2TIMManager.getFriendshipManager().renameFriendGroup("大学好友", "中学好友", new V2TIMCallback() {
@Override
public void onSuccess() {
// 修改好友分组成功
}

@Override
public void onError(int code, String desc) {
// 修改好友分组失败
}
});
// 修改好友分组
V2TIMManager.shared.renameFriendGroup(oldName: "大学好友", newName: "中学好友") {
print( "renameFriendGroup succ")
} fail: { code, desc in
print( "renameFriendGroup fail, \\(code), \\(desc)")
}
// 修改好友分组
[[V2TIMManager sharedInstance] renameFriendGroup:@"大学好友" newName:@"中学好友" 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_;
};

V2TIMString oldName = u8"大学好友";
V2TIMString newName = u8"中学好友";

auto callback = new Callback{};
callback->SetCallback(
[=]() {
// 修改好友分组成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 修改好友分组失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->RenameFriendGroup(oldName, newName, callback);

获取好友分组

您可以调用 getFriendGroupList (Java / Swift / Objective-C / C++) 接口获取好友分组列表。
示例代码如下:
Java
Swift
Objective-C
C++
List<String> friendGroups = new ArrayList<>();
friendGroups.add("大学好友");
V2TIMManager.getFriendshipManager().getFriendGroups(friendGroups, new V2TIMValueCallback<List<V2TIMFriendGroup>>() {
@Override
public void onSuccess(List<V2TIMFriendGroup> v2TIMFriendGroups) {
// 获取好友分组成功
}

@Override
public void onError(int code, String desc) {
// 获取好友分组失败
}
});
// 获取好友分组
V2TIMManager.shared.getFriendGroupList(groupNameList: ["大学好友"]) { groups in
groups.forEach { item in
// V2TIMFriendGroup
print( item.description)
}
} fail: { code, desc in
print( "getFriendGroupList fail, \\(code), \\(desc)")
}
// 获取好友分组
[[V2TIMManager sharedInstance] getFriendGroupList:@[@"大学好友"] succ:^(NSArray<V2TIMFriendGroup *> *groups) {
// 获取好友分组成功
} 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 groupNameList;
groupNameList.PushBack(u8"大学好友");

auto callback = new ValueCallback<V2TIMFriendGroupVector>{};
callback->SetCallback(
[=](const V2TIMFriendGroupVector& friendGroupList) {
// 获取好友分组成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 获取好友分组失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->GetFriendGroups(groupNameList, callback);

添加好友到一个分组

您可以调用 addFriendsToFriendGroup (Java / Swift / Objective-C / C++) 接口添加好友到一个分组。
示例代码如下:
Java
Swift
Objective-C
C++
List<String> userIDList = new ArrayList<>();
userIDList.add("user1");
userIDList.add("user2");
V2TIMManager.getFriendshipManager().addFriendsToFriendGroup("大学好友", userIDList, new V2TIMValueCallback<List<V2TIMFriendOperationResult>>() {
@Override
public void onSuccess(List<V2TIMFriendOperationResult> v2TIMFriendOperationResults) {
// 添加成功
}

@Override
public void onError(int code, String desc) {
// 添加失败
}
});
V2TIMManager.shared.addFriendsToFriendGroup(groupName: "大学好友", userIDList: ["user1","user2"]) { resultList in
resultList.forEach { item in
// V2TIMFriendOperationResult
print( item.description)
}
print( "addFriendsToFriendGroup succ")
} fail: { code, desc in
print( "addFriendsToFriendGroup fail, \\(code), \\(desc)")
}
// 添加好友到一个分组
[[V2TIMManager sharedInstance] addFriendsToFriendGroup:@"大学好友" userIDList:@[@"user1", @"user2"] succ:^(NSArray<V2TIMFriendOperationResult *> *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_;
};

V2TIMString groupName = u8"大学好友";
V2TIMStringVector userIDList;
userIDList.PushBack(u8"user1");
userIDList.PushBack(u8"user2");

auto callback = new ValueCallback<V2TIMFriendOperationResultVector>{};
callback->SetCallback(
[=](const V2TIMFriendOperationResultVector& friendOperationResultList) {
// 添加成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 添加失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->AddFriendsToFriendGroup(groupName, userIDList, callback);

从分组中删除某好友

您可以调用 deleteFriendsFromFriendGroup (Java / Swift / Objective-C / C++) 从分组中删除某好友。从该分组中删除好友,只会将好友移出分组,不会删除好友关系。
示例代码如下:
Java
Swift
Objective-C
C++
List<String> userIDList = new ArrayList<>();
userIDList.add("user1");
userIDList.add("user2");
V2TIMManager.getFriendshipManager().deleteFriendsFromFriendGroup("大学好友", userIDList, new V2TIMValueCallback<List<V2TIMFriendOperationResult>>() {
@Override
public void onSuccess(List<V2TIMFriendOperationResult> v2TIMFriendOperationResults) {
// 删除成功
}

@Override
public void onError(int code, String desc) {
// 删除失败
}
});
V2TIMManager.shared.deleteFriendsFromFriendGroup(groupName: "大学好友", userIDList: ["user1","user2"]) { resultList in
resultList.forEach { item in
// V2TIMFriendOperationResult
print( item.description)
}
print( "addFriendsToFriendGroup succ")
} fail: { code, desc in
print( "addFriendsToFriendGroup fail, \\(code), \\(desc)")
}
// 从分组中删除某好友
[[V2TIMManager sharedInstance] deleteFriendsFromFriendGroup:@"大学好友" userIDList:@[@"user1", @"user2"] succ:^(NSArray<V2TIMFriendOperationResult *> *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_;
};

V2TIMString groupName = u8"大学好友";
V2TIMStringVector userIDList;
userIDList.PushBack(u8"user1");
userIDList.PushBack(u8"user2");

auto callback = new ValueCallback<V2TIMFriendOperationResultVector>{};
callback->SetCallback(
[=](const V2TIMFriendOperationResultVector& friendOperationResultList) {
// 删除成功
delete callback;
},
[=](int error_code, const V2TIMString& error_message) {
// 删除失败
delete callback;
});

V2TIMManager::GetInstance()->GetFriendshipManager()->DeleteFriendsFromFriendGroup(groupName, userIDList,
callback);

监听好友分组变更通知

您可以通过 addFriendListener (Java / Swift / Objective-C / C++) 接口来监听好友分组变更的通知。
示例代码如下:
Java
Swift
Objective-C
C++
V2TIMFriendshipListener v2TIMFriendshipListener = new V2TIMFriendshipListener() {
@Override
public void onFriendGroupCreated(String groupName, List<V2TIMFriendInfo> friendInfoList) {
// 收到好友分组被创建通知
}

@Override
public void onFriendGroupDeleted(List<String> groupNameList) {
// 收到好友分组被删除通知
}

@Override
public void onFriendGroupNameChanged(String oldGroupName, String newGroupName) {
// 收到好友分组重命名通知
}

@Override
public void onFriendsAddedToGroup(String groupName, List<V2TIMFriendInfo> friendInfoList) {
// 收到向好友分组添加好友通知
}

@Override
public void onFriendsDeletedFromGroup(String groupName, List<String> friendIDList) {
// 收到从好友分组中删除好友通知
}
};

// 添加关系链监听器
V2TIMManager.getFriendshipManager().addFriendListener(v2TIMFriendshipListener);
// 添加关系链监听器
V2TIMManager.shared.addFriendListener(listener: self)
func onFriendGroupCreated(groupName: String, friendInfoList: Array<V2TIMFriendInfo>) {
print( "groupName: \\(groupName)|friendInfoList: \\(friendInfoList)")
}

func onFriendGroupDeleted(groupNameList: Array<String>) {
print( groupNameList)
}

func onFriendGroupNameChanged(oldGroupName: String, newGroupName: String) {
print( "oldGroupName: \\(oldGroupName)|newGroupName: \\(newGroupName)")
}

func onFriendsAddedToGroup(groupName: String, friendInfoList: Array<V2TIMFriendInfo>) {
print( "groupName: \\(groupName)|friendInfoList: \\(friendInfoList)")
}

// 添加关系链监听器
[[V2TIMManager sharedInstance] addFriendListener:self];

- (void)onFriendGroupCreated:(NSString *)groupName friendInfoList:(NSArray<V2TIMFriendInfo *> *)friendInfoList {
// 到好友分组被创建通知
}

- (void)onFriendGroupDeleted:(NSArray<NSString *> *)groupNameList {
// 收到好友分组被删除通知
}

- (void)onFriendGroupNameChanged:(NSString *)oldGroupName newGroupName:(NSString *)newGroupName {
// 收到好友分组重命名通知
}

- (void)onFriendsAddedToGroup:(NSString *)groupName friendInfoList:(NSArray<V2TIMFriendInfo *> *)friendInfoList {
// 收到向好友分组添加好友通知
}

- (void)onFriendsDeletedFromGroup:(NSString *)groupName friendIDList:(NSArray<NSString *> *)friendIDList {
// 收到从好友分组中删除好友通知
}
class FriendshipListener final : public V2TIMFriendshipListener {
public:
FriendshipListener() = default;
~FriendshipListener() override = default;

void OnFriendGroupCreated(const V2TIMString &groupName, const V2TIMFriendInfoVector &friendInfoList) override {
// 收到好友分组被创建通知
}

void OnFriendGroupDeleted(const V2TIMStringVector &groupNameList) override {
// 收到好友分组被删除通知
}

void OnFriendGroupNameChanged(const V2TIMString &oldGroupName, const V2TIMString &newGroupName) override {
// 收到好友分组重命名通知
}

void OnFriendsAddedToGroup(const V2TIMString &groupName, const V2TIMFriendInfoVector &friendInfoList) override {
// 收到向好友分组添加好友通知
}

void OnFriendsDeletedFromGroup(const V2TIMString &groupName, const V2TIMStringVector &friendIDList) override {
// 收到从好友分组中删除好友通知
}

// 其他成员函数 ...
};

// 添加关系链事件监听器,注意在移除监听器之前需要保持 friendshipListener 的生命期,以免接收不到事件回调
FriendshipListener friendshipListener;
V2TIMManager::GetInstance()->GetFriendshipManager()->AddFriendListener(&friendshipListener);
说明:
好友分组变更通知仅增强版 SDK 8.0 及以上版本支持。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈