IMSDK
即时通信 IM 提供全球接入、单聊、群聊、消息推送、资料关系链托管、帐号鉴权等全方位解决方案,并提供完备的 App 接入、后台管理接口。
V2TIMFriendshipManagerabstract

详细描述

关系链接口,包含了好友的添加和删除,黑名单的添加和删除等逻辑

Public 成员函数

abstract void setFriendListener (V2TIMFriendshipListener listener)
 
abstract void getFriendList (V2TIMValueCallback< List< V2TIMFriendInfo >> callback)
 
abstract void getFriendsInfo (List< String > userIDList, V2TIMValueCallback< List< V2TIMFriendInfoResult >> callback)
 
abstract void setFriendInfo (V2TIMFriendInfo info, V2TIMCallback callback)
 
abstract void addFriend (V2TIMFriendAddApplication application, V2TIMValueCallback< V2TIMFriendOperationResult > callback)
 
abstract void deleteFromFriendList (List< String > userIDList, int deleteType, V2TIMValueCallback< List< V2TIMFriendOperationResult >> callback)
 
abstract void checkFriend (List< String > userIDList, int checkType, V2TIMValueCallback< List< V2TIMFriendCheckResult >> callback)
 
abstract void getFriendApplicationList (V2TIMValueCallback< V2TIMFriendApplicationResult > callback)
 
abstract void acceptFriendApplication (V2TIMFriendApplication application, int responseType, V2TIMValueCallback< V2TIMFriendOperationResult > callback)
 
abstract void refuseFriendApplication (V2TIMFriendApplication application, V2TIMValueCallback< V2TIMFriendOperationResult > callback)
 
abstract void deleteFriendApplication (V2TIMFriendApplication application, V2TIMCallback callback)
 
abstract void setFriendApplicationRead (V2TIMCallback callback)
 
abstract void addToBlackList (List< String > userIDList, V2TIMValueCallback< List< V2TIMFriendOperationResult >> callback)
 
abstract void deleteFromBlackList (List< String > userIDList, V2TIMValueCallback< List< V2TIMFriendOperationResult >> callback)
 
abstract void getBlackList (V2TIMValueCallback< List< V2TIMFriendInfo >> callback)
 
abstract void createFriendGroup (String groupName, List< String > userIDList, final V2TIMValueCallback< List< V2TIMFriendOperationResult >> callback)
 
abstract void getFriendGroups (List< String > groupNameList, final V2TIMValueCallback< List< V2TIMFriendGroup >> callback)
 
abstract void deleteFriendGroup (List< String > groupNameList, final V2TIMCallback callback)
 
abstract void renameFriendGroup (String oldName, String newName, V2TIMCallback callback)
 
abstract void addFriendsToFriendGroup (String groupName, List< String > userIDList, V2TIMValueCallback< List< V2TIMFriendOperationResult >> callback)
 
abstract void deleteFriendsFromFriendGroup (String groupName, List< String > userIDList, V2TIMValueCallback< List< V2TIMFriendOperationResult >> callback)
 

成员函数说明

◆ setFriendListener()

abstract void setFriendListener ( V2TIMFriendshipListener  listener)
abstract

1.1 设置关系链监听器

◆ getFriendList()

abstract void getFriendList ( V2TIMValueCallback< List< V2TIMFriendInfo >>  callback)
abstract

2.1 获取好友列表

◆ getFriendsInfo()

abstract void getFriendsInfo ( List< String >  userIDList,
V2TIMValueCallback< List< V2TIMFriendInfoResult >>  callback 
)
abstract

2.2 获取指定好友资料

参数
userIDList好友 userID 列表
  • ID 建议一次最大 100 个,因为数量过多可能会导致数据包太大被后台拒绝,后台限制数据包最大为 1M。

◆ setFriendInfo()

abstract void setFriendInfo ( V2TIMFriendInfo  info,
V2TIMCallback  callback 
)
abstract

2.3 设置指定好友资料

◆ addFriend()

abstract void addFriend ( V2TIMFriendAddApplication  application,
V2TIMValueCallback< V2TIMFriendOperationResult callback 
)
abstract

2.4 添加好友

◆ deleteFromFriendList()

abstract void deleteFromFriendList ( List< String >  userIDList,
int  deleteType,
V2TIMValueCallback< List< V2TIMFriendOperationResult >>  callback 
)
abstract

2.5 删除好友

参数
userIDList要删除的好友 userID 列表
  • ID 建议一次最大 100 个,因为数量过多可能会导致数据包太大被后台拒绝,后台限制数据包最大为 1M。
deleteType删除类型
  • V2TIMFriendInfo.V2TIM_FRIEND_TYPE_SINGLE:单向好友
  • V2TIMFriendInfo.V2TIM_FRIEND_TYPE_BOTH:双向好友

◆ checkFriend()

abstract void checkFriend ( List< String >  userIDList,
int  checkType,
V2TIMValueCallback< List< V2TIMFriendCheckResult >>  callback 
)
abstract

2.6 检查指定用户的好友关系

参数
userIDList要检查的 userID 列表
checkType检查类型 (单向好友检查、双向好友检查)
注意
checkType 的使用需要注意:
  • checkType 如果传入 V2TIM_FRIEND_TYPE_SINGLE,结果返回:V2TIM_FRIEND_RELATION_TYPE_NONE、V2TIM_FRIEND_RELATION_TYPE_IN_MY_FRIEND_LIST 两种情况
  • checkType 如果传入 V2TIM_FRIEND_TYPE_BOTH,结果返回:V2TIM_FRIEND_RELATION_TYPE_NONE、V2TIM_FRIEND_RELATION_TYPE_IN_MY_FRIEND_LIST、 V2TIM_FRIEND_RELATION_TYPE_IN_OTHER_FRIEND_LIST、V2TIM_FRIEND_RELATION_TYPE_BOTH_WAY 四种情况

◆ getFriendApplicationList()

abstract void getFriendApplicationList ( V2TIMValueCallback< V2TIMFriendApplicationResult callback)
abstract

3.1 获取好友申请列表

◆ acceptFriendApplication()

abstract void acceptFriendApplication ( V2TIMFriendApplication  application,
int  responseType,
V2TIMValueCallback< V2TIMFriendOperationResult callback 
)
abstract

3.2 同意好友申请

参数
application好友申请信息,getFriendApplicationList 成功后会返回
responseType建立单向/双向好友关系
  • V2TIMFriendApplication.V2TIM_FRIEND_ACCEPT_AGREE:同意添加单向好友
  • V2TIMFriendApplication.V2TIM_FRIEND_ACCEPT_AGREE_AND_ADD:同意并添加为双向好友

◆ refuseFriendApplication()

abstract void refuseFriendApplication ( V2TIMFriendApplication  application,
V2TIMValueCallback< V2TIMFriendOperationResult callback 
)
abstract

3.3 拒绝好友申请

参数
application好友申请信息,getFriendApplicationList 成功后会返回

◆ deleteFriendApplication()

abstract void deleteFriendApplication ( V2TIMFriendApplication  application,
V2TIMCallback  callback 
)
abstract

3.4 删除好友申请

参数
application好友申请信息,getFriendApplicationList 成功后会返回

◆ setFriendApplicationRead()

abstract void setFriendApplicationRead ( V2TIMCallback  callback)
abstract

3.5 设置好友申请已读

◆ addToBlackList()

abstract void addToBlackList ( List< String >  userIDList,
V2TIMValueCallback< List< V2TIMFriendOperationResult >>  callback 
)
abstract

4.1 添加用户到黑名单

◆ deleteFromBlackList()

abstract void deleteFromBlackList ( List< String >  userIDList,
V2TIMValueCallback< List< V2TIMFriendOperationResult >>  callback 
)
abstract

4.2 把用户从黑名单中删除

◆ getBlackList()

abstract void getBlackList ( V2TIMValueCallback< List< V2TIMFriendInfo >>  callback)
abstract

4.3 获取黑名单列表

◆ createFriendGroup()

abstract void createFriendGroup ( String  groupName,
List< String >  userIDList,
final V2TIMValueCallback< List< V2TIMFriendOperationResult >>  callback 
)
abstract

5.1 新建好友分组

参数
groupName分组名称
userIDList要添加到分组中的好友 userID 列表

◆ getFriendGroups()

abstract void getFriendGroups ( List< String >  groupNameList,
final V2TIMValueCallback< List< V2TIMFriendGroup >>  callback 
)
abstract

5.2 获取分组信息

参数
groupNameList要获取信息的好友分组名称列表,传入 null 获得所有分组信息

◆ deleteFriendGroup()

abstract void deleteFriendGroup ( List< String >  groupNameList,
final V2TIMCallback  callback 
)
abstract

5.3 删除好友分组

◆ renameFriendGroup()

abstract void renameFriendGroup ( String  oldName,
String  newName,
V2TIMCallback  callback 
)
abstract

修改好友分组的名称

参数
oldName旧的分组名称
newName新的分组名称
callback回调

◆ addFriendsToFriendGroup()

abstract void addFriendsToFriendGroup ( String  groupName,
List< String >  userIDList,
V2TIMValueCallback< List< V2TIMFriendOperationResult >>  callback 
)
abstract

5.4 添加好友到一个好友分组

◆ deleteFriendsFromFriendGroup()

abstract void deleteFriendsFromFriendGroup ( String  groupName,
List< String >  userIDList,
V2TIMValueCallback< List< V2TIMFriendOperationResult >>  callback 
)
abstract

5.5 从好友分组中删除好友