一、新建好友分组
接口
chat.createFriendGroup(options);
参数
参数 options 为 Object 类型，包含的属性值如下：
| 参数 | 类型 | 说明 |
| 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 | 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 类型，包含的属性值如下：
| 参数 | 类型 | 说明 |
| 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 | 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 | 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); // 获取失败});