• UIKit
  • SDK
  • 服务端 API
Chat/
SDK/
Web/
用户/
SDK
  • 集成 SDK
  • 初始化
  • 登录登出
  • 接口列表
  • 更新日志
  • 消息
    • 介绍
    • 发送消息
    • 接收消息
    • 历史消息
    • 转发消息
    • 修改消息
    • 删除消息
    • 清空消息
    • 撤回消息
    • 在线消息
    • 已读回执
    • 查询消息
    • 群定向消息
    • 消息免打扰
    • 消息扩展
    • 消息翻译
  • 会话
    • 介绍
    • 会话列表
    • 获取会话
    • 会话未读数
    • 置顶会话
    • 删除会话
    • 会话标记
    • 会话分组
  • 群组
    • 介绍
    • 管理群组
    • 群资料
    • 管理群成员
    • 群成员资料
    • 自定义属性
    • 群计数器
  • 社群话题
    • 管理社群
  • 用户
    • 用户资料
    • 用户状态
    • 管理好友
    • 好友列表
    • 黑名单
  • 开发指引
  • 控制台指南
    • 创建和升级应用
    • 基本配置
    • 功能配置
    • 账号管理
    • 群组管理
    • 回调配置
  • 产品介绍
    • 消息管理
      • 单聊消息
      • 消息存储
      • 离线推送
      • 群消息
      • 消息格式
    • 账号系统
      • 登陆验证
      • 在线状态管理
    • 群相关
      • 群组系统
      • 群组管理
    • 用户资料和关系链
      • 资料管理
      • 关系链管理
  • 购买指南
    • 计费概述
    • 价格中心
  • 错误码

好友列表

功能描述

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

好友分组

新建好友分组

接口
chat.createFriendGroup(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name
Type
Description
name
String
分组名称
userIDList
Array
要添加到分组的好友 userID 列表
返回值
Promise
示例
let promise = chat.createFriendGroup({
name: '我的好友分组1',
userIDList: ['user0','user1']
});
promise.then(function(imResponse) {
const { friendGroup,failureUserIDList } = imResponse;
// friendGroup - 好友分组实例
// failureUserIDList - 失败的 userID 列表
// 创建成功后,SDK 会触发 TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED 事件
}).catch(function(imError) {
console.warn('getFriendGroupInfo error:', imError); // 获取失败
});

删除好友分组

接口
chat.deleteFriendGroup(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name
Type
Description
name
String
分组名称
返回值
Promise
示例
let promise = chat.deleteFriendGroup({
name: '我的好友分组1',
});
promise.then(function(imResponse) {
console.log(imResponse.data); // 被删除的分组实例
// 删除成功后,SDK 会触发 TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED 事件
}).catch(function(imError) {
console.warn('deleteFriendGroup error:', imError); // 获取失败
});

重命名好友分组

接口
chat.renameFriendGroup(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name
Type
Description
oldName
String
旧的分组名称
newName
String
新的分组名称
返回值
Promise
示例
let promise = chat.renameFriendGroup({
oldName: '好友',
newName: '闺蜜'
});
promise.then(function(imResponse) {
console.log(imResponse.data); // FriendGroup 实例
// 修改成功后,SDK 会触发 TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED 事件
}).catch(function(imError) {
console.warn('updateMyProfile error:', imError);
});

获取好友分组

获取 SDK 缓存的好友分组列表。当好友分组列表有更新时,SDK 会派发事件 TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED
接口
chat.getFriendGroupList();
参数
返回值
Promise
示例
let promise = chat.getFriendGroupList();
promise.then(function(imResponse) {
const friendGroupList = imResponse.data; // 好友分组列表
}).catch(function(imError) {
console.warn('getFriendGroupList error:', imError); // 获取好友分组列表失败的相关信息
});

添加好友到一个分组

接口
chat.addToFriendGroup(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name
Type
Description
name
String
分组名称
userIDList
Array
要添加的好友 userID 列表
返回值
Promise
示例
let promise = chat.addToFriendGroup({
name: '我的好友分组1',
userIDList: ['user1','user2'],
});
promise.then(function(imResponse) {
const { friendGroup, failureUserIDList } = imResponse.data;
// friendGroup - 好友分组实例
// failureUserIDList - 失败的 userID 列表
// 添加成功后,SDK 会触发 TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED 事件
}).catch(function(imError) {
console.warn('addToFriendGroup error:', imError); // 获取失败
});

从分组中删除某好友

接口
chat.removeFromFriendGroup(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name
Type
Description
name
String
分组名称
userIDList
Array
要移除的好友 userID 列表
返回值
Promise
示例
let promise = chat.removeFromFriendGroup({
name: '我的好友分组1',
userIDList: ['user1','user2'],
});
promise.then(function(imResponse) {
const { friendGroup, failureUserIDList } = imResponse.data;
// friendGroup - 好友分组实例
// failureUserIDList - 失败的 userID 列表
// 移除成功后,SDK 会触发 TencentCloudChat.EVENT.FRIEND_GROUP_LIST_UPDATED 事件
}).catch(function(imError) {
console.warn('addToFriendGroup error:', imError); // 获取失败
});