在某些场景下,您可能需要对好友进行分组,例如分为 "大学同学"、"公司同事" 等,您可以调用以下接口实现。
注意:v2.13.0起支持,升级指引。
接口
tim.createFriendGroup(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name | Type | Description |
---|---|---|
name | String | 分组名称 |
userIDList | Array | 要添加到分组的好友 userID 列表 |
返回值
Promise
对象。
示例
let promise = tim.createFriendGroup({
name: '我的好友分组1',
userIDList: ['user0','user1']
});
promise.then(function(imResponse) {
const { friendGroup,failureUserIDList } = imResponse;
// friendGroup - 好友分组实例
// failureUserIDList - 失败的 userID 列表
// 创建成功后,SDK 会触发 TIM.EVENT.FRIEND_GROUP_LIST_UPDATED 事件
}).catch(function(imError) {
console.warn('getFriendGroupInfo error:', imError); // 获取失败
});
注意:v2.13.0起支持,升级指引。
接口
tim.deleteFriendGroup(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name | Type | Description |
---|---|---|
name | String | 分组名称 |
返回值
Promise
对象。
示例
let promise = tim.deleteFriendGroup({
name: '我的好友分组1',
});
promise.then(function(imResponse) {
console.log(imResponse.data); // 被删除的分组实例
// 删除成功后,SDK 会触发 TIM.EVENT.FRIEND_GROUP_LIST_UPDATED 事件
}).catch(function(imError) {
console.warn('deleteFriendGroup error:', imError); // 获取失败
});
注意:v2.13.0起支持,升级指引。
接口
tim.renameFriendGroup(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name | Type | Description |
---|---|---|
oldName | String | 旧的分组名称 |
newName | String | 新的分组名称 |
返回值
Promise
对象。
示例
let promise = tim.renameFriendGroup({
oldName: '好友',
newName: '闺蜜'
});
promise.then(function(imResponse) {
console.log(imResponse.data); // FriendGroup 实例
// 修改成功后,SDK 会触发 TIM.EVENT.FRIEND_GROUP_LIST_UPDATED 事件
}).catch(function(imError) {
console.warn('updateMyProfile error:', imError);
});
获取 SDK 缓存的好友分组列表。当好友分组列表有更新时,SDK 会派发事件 TIM.EVENT.FRIEND_GROUP_LIST_UPDATED。
注意:v2.13.0起支持,升级指引。
接口
tim.getFriendGroupList();
参数
无
返回值
Promise
对象。
示例
let promise = tim.getFriendGroupList();
promise.then(function(imResponse) {
const friendGroupList = imResponse.data; // 好友分组列表
}).catch(function(imError) {
console.warn('getFriendGroupList error:', imError); // 获取好友分组列表失败的相关信息
});
注意:v2.13.0起支持,升级指引。
接口
tim.addToFriendGroup(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name | Type | Description |
---|---|---|
name | String | 分组名称 |
userIDList | Array | 要添加的好友 userID 列表 |
返回值
Promise
对象。
示例
let promise = tim.addToFriendGroup({
name: '我的好友分组1',
userIDList: ['user1','user2'],
});
promise.then(function(imResponse) {
const { friendGroup, failureUserIDList } = imResponse.data;
// friendGroup - 好友分组实例
// failureUserIDList - 失败的 userID 列表
// 添加成功后,SDK 会触发 TIM.EVENT.FRIEND_GROUP_LIST_UPDATED 事件
}).catch(function(imError) {
console.warn('addToFriendGroup error:', imError); // 获取失败
});
注意:v2.13.0起支持,升级指引。
接口
tim.removeFromFriendGroup(options);
参数
参数 options 为 Object 类型,包含的属性值如下:
Name | Type | Description |
---|---|---|
name | String | 分组名称 |
userIDList | Array | 要移除的好友 userID 列表 |
返回值
Promise
对象。
示例
let promise = tim.removeFromFriendGroup({
name: '我的好友分组1',
userIDList: ['user1','user2'],
});
promise.then(function(imResponse) {
const { friendGroup, failureUserIDList } = imResponse.data;
// friendGroup - 好友分组实例
// failureUserIDList - 失败的 userID 列表
// 移除成功后,SDK 会触发 TIM.EVENT.FRIEND_GROUP_LIST_UPDATED 事件
}).catch(function(imError) {
console.warn('addToFriendGroup error:', imError); // 获取失败
});
本页内容是否解决了您的问题?