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

详细描述

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

Public 成员函数

virtual ~V2TIMFriendshipManager ()
 
virtual void AddFriendListener (V2TIMFriendshipListener *listener)=0
 
virtual void RemoveFriendListener (V2TIMFriendshipListener *listener)=0
 
virtual void GetFriendList (V2TIMValueCallback< V2TIMFriendInfoVector > *callback)=0
 
virtual void GetFriendsInfo (const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMFriendInfoResultVector > *callback)=0
 
virtual void SetFriendInfo (const V2TIMFriendInfo &info, V2TIMCallback *callback)=0
 
virtual void SearchFriends (const V2TIMFriendSearchParam &searchParam, V2TIMValueCallback< V2TIMFriendInfoResultVector > *callback)=0
 
virtual void AddFriend (const V2TIMFriendAddApplication &application, V2TIMValueCallback< V2TIMFriendOperationResult > *callback)=0
 
virtual void DeleteFromFriendList (const V2TIMStringVector &userIDList, V2TIMFriendType deleteType, V2TIMValueCallback< V2TIMFriendOperationResultVector > *callback)=0
 
virtual void CheckFriend (const V2TIMStringVector &userIDList, V2TIMFriendType checkType, V2TIMValueCallback< V2TIMFriendCheckResultVector > *callback)=0
 
virtual void GetFriendApplicationList (V2TIMValueCallback< V2TIMFriendApplicationResult > *callback)=0
 
virtual void AcceptFriendApplication (const V2TIMFriendApplication &application, V2TIMFriendAcceptType acceptType, V2TIMValueCallback< V2TIMFriendOperationResult > *callback)=0
 
virtual void AcceptFriendApplication (const V2TIMFriendApplication &application, V2TIMFriendAcceptType acceptType, const V2TIMString &remark, V2TIMValueCallback< V2TIMFriendOperationResult > *callback)=0
 
virtual void RefuseFriendApplication (const V2TIMFriendApplication &application, V2TIMValueCallback< V2TIMFriendOperationResult > *callback)=0
 
virtual void DeleteFriendApplication (const V2TIMFriendApplication &application, V2TIMCallback *callback)=0
 
virtual void SetFriendApplicationRead (V2TIMCallback *callback)=0
 
virtual void AddToBlackList (const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMFriendOperationResultVector > *callback)=0
 
virtual void DeleteFromBlackList (const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMFriendOperationResultVector > *callback)=0
 
virtual void GetBlackList (V2TIMValueCallback< V2TIMFriendInfoVector > *callback)=0
 
virtual void CreateFriendGroup (const V2TIMString &groupName, const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMFriendOperationResultVector > *callback)=0
 
virtual void GetFriendGroups (const V2TIMStringVector &groupNameList, V2TIMValueCallback< V2TIMFriendGroupVector > *callback)=0
 
virtual void DeleteFriendGroup (const V2TIMStringVector &groupNameList, V2TIMCallback *callback)=0
 
virtual void RenameFriendGroup (const V2TIMString &oldName, const V2TIMString &newName, V2TIMCallback *callback)=0
 
virtual void AddFriendsToFriendGroup (const V2TIMString &groupName, const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMFriendOperationResultVector > *callback)=0
 
virtual void DeleteFriendsFromFriendGroup (const V2TIMString &groupName, const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMFriendOperationResultVector > *callback)=0
 
virtual void SubscribeOfficialAccount (const V2TIMString &officialAccountID, V2TIMCallback *callback)=0
 
virtual void UnsubscribeOfficialAccount (const V2TIMString &officialAccountID, V2TIMCallback *callback)=0
 
virtual void GetOfficialAccountsInfo (const V2TIMStringVector &officialAccountIDList, V2TIMValueCallback< V2TIMOfficialAccountInfoResultVector > *callback)=0
 
virtual void FollowUser (const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMFollowOperationResultVector > *callback)=0
 
virtual void UnfollowUser (const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMFollowOperationResultVector > *callback)=0
 
virtual void GetMyFollowingList (const V2TIMString &nextCursor, V2TIMValueCallback< V2TIMUserInfoResult > *callback)=0
 
virtual void GetMyFollowersList (const V2TIMString &nextCursor, V2TIMValueCallback< V2TIMUserInfoResult > *callback)=0
 
virtual void GetMutualFollowersList (const V2TIMString &nextCursor, V2TIMValueCallback< V2TIMUserInfoResult > *callback)=0
 
virtual void GetUserFollowInfo (const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMFollowInfoVector > *callback)=0
 
virtual void CheckFollowType (const V2TIMStringVector &userIDList, V2TIMValueCallback< V2TIMFollowTypeCheckResultVector > *callback)=0
 

构造及析构函数说明

◆ ~V2TIMFriendshipManager()

virtual ~V2TIMFriendshipManager ( )
inlinevirtual

成员函数说明

◆ AddFriendListener()

virtual void AddFriendListener ( V2TIMFriendshipListener listener)
pure virtual

1.1 添加关系链监听器

◆ RemoveFriendListener()

virtual void RemoveFriendListener ( V2TIMFriendshipListener listener)
pure virtual

1.2 移除关系链监听器

◆ GetFriendList()

virtual void GetFriendList ( V2TIMValueCallback< V2TIMFriendInfoVector > *  callback)
pure virtual

2.1 获取好友列表

◆ GetFriendsInfo()

virtual void GetFriendsInfo ( const V2TIMStringVector userIDList,
V2TIMValueCallback< V2TIMFriendInfoResultVector > *  callback 
)
pure virtual

2.2 获取指定好友资料

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

◆ SetFriendInfo()

virtual void SetFriendInfo ( const V2TIMFriendInfo info,
V2TIMCallback callback 
)
pure virtual

2.3 设置指定好友资料

◆ SearchFriends()

virtual void SearchFriends ( const V2TIMFriendSearchParam searchParam,
V2TIMValueCallback< V2TIMFriendInfoResultVector > *  callback 
)
pure virtual

2.4 搜索好友(5.4.666 及以上版本支持,需要您购买旗舰版套餐)

注意
  • 接口返回本地存储的用户资料,可以根据 V2TIMFriendInfoResult 中的 getRelation 来判断是否为好友。
  • 该功能为 IM 旗舰版功能,购买旗舰版套餐包后可使用,详见价格说明

◆ AddFriend()

virtual void AddFriend ( const V2TIMFriendAddApplication application,
V2TIMValueCallback< V2TIMFriendOperationResult > *  callback 
)
pure virtual

2.5 添加好友

◆ DeleteFromFriendList()

virtual void DeleteFromFriendList ( const V2TIMStringVector userIDList,
V2TIMFriendType  deleteType,
V2TIMValueCallback< V2TIMFriendOperationResultVector > *  callback 
)
pure virtual

2.6 删除好友

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

◆ CheckFriend()

virtual void CheckFriend ( const V2TIMStringVector userIDList,
V2TIMFriendType  checkType,
V2TIMValueCallback< V2TIMFriendCheckResultVector > *  callback 
)
pure virtual

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

参数
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()

virtual void GetFriendApplicationList ( V2TIMValueCallback< V2TIMFriendApplicationResult > *  callback)
pure virtual

3.1 获取好友申请列表

注意
  • 好友申请列表包括发起的好友申请和收到的好友申请。
  • 最多支持100个。

◆ AcceptFriendApplication() [1/2]

virtual void AcceptFriendApplication ( const V2TIMFriendApplication application,
V2TIMFriendAcceptType  acceptType,
V2TIMValueCallback< V2TIMFriendOperationResult > *  callback 
)
pure virtual

3.2 同意好友申请

参数
application好友申请信息,GetFriendApplicationList 成功后会返回
responseType建立单向/双向好友关系

◆ AcceptFriendApplication() [2/2]

virtual void AcceptFriendApplication ( const V2TIMFriendApplication application,
V2TIMFriendAcceptType  acceptType,
const V2TIMString remark,
V2TIMValueCallback< V2TIMFriendOperationResult > *  callback 
)
pure virtual

3.3 同意好友申请,并设置备注

参数
application好友申请信息,GetFriendApplicationList 成功后会返回
responseType建立单向/双向好友关系
remark好友备注,最长 96 个字节

◆ RefuseFriendApplication()

virtual void RefuseFriendApplication ( const V2TIMFriendApplication application,
V2TIMValueCallback< V2TIMFriendOperationResult > *  callback 
)
pure virtual

3.4 拒绝好友申请

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

◆ DeleteFriendApplication()

virtual void DeleteFriendApplication ( const V2TIMFriendApplication application,
V2TIMCallback callback 
)
pure virtual

3.5 删除好友申请

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

◆ SetFriendApplicationRead()

virtual void SetFriendApplicationRead ( V2TIMCallback callback)
pure virtual

3.6 设置好友申请已读

◆ AddToBlackList()

virtual void AddToBlackList ( const V2TIMStringVector userIDList,
V2TIMValueCallback< V2TIMFriendOperationResultVector > *  callback 
)
pure virtual

4.1 添加用户到黑名单

◆ DeleteFromBlackList()

virtual void DeleteFromBlackList ( const V2TIMStringVector userIDList,
V2TIMValueCallback< V2TIMFriendOperationResultVector > *  callback 
)
pure virtual

4.2 把用户从黑名单中删除

◆ GetBlackList()

virtual void GetBlackList ( V2TIMValueCallback< V2TIMFriendInfoVector > *  callback)
pure virtual

4.3 获取黑名单列表

◆ CreateFriendGroup()

virtual void CreateFriendGroup ( const V2TIMString groupName,
const V2TIMStringVector userIDList,
V2TIMValueCallback< V2TIMFriendOperationResultVector > *  callback 
)
pure virtual

5.1 新建好友分组

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

◆ GetFriendGroups()

virtual void GetFriendGroups ( const V2TIMStringVector groupNameList,
V2TIMValueCallback< V2TIMFriendGroupVector > *  callback 
)
pure virtual

5.2 获取分组信息

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

◆ DeleteFriendGroup()

virtual void DeleteFriendGroup ( const V2TIMStringVector groupNameList,
V2TIMCallback callback 
)
pure virtual

5.3 删除好友分组

◆ RenameFriendGroup()

virtual void RenameFriendGroup ( const V2TIMString oldName,
const V2TIMString newName,
V2TIMCallback callback 
)
pure virtual

修改好友分组的名称

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

◆ AddFriendsToFriendGroup()

virtual void AddFriendsToFriendGroup ( const V2TIMString groupName,
const V2TIMStringVector userIDList,
V2TIMValueCallback< V2TIMFriendOperationResultVector > *  callback 
)
pure virtual

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

◆ DeleteFriendsFromFriendGroup()

virtual void DeleteFriendsFromFriendGroup ( const V2TIMString groupName,
const V2TIMStringVector userIDList,
V2TIMValueCallback< V2TIMFriendOperationResultVector > *  callback 
)
pure virtual

5.5 从好友分组中删除好友

◆ SubscribeOfficialAccount()

virtual void SubscribeOfficialAccount ( const V2TIMString officialAccountID,
V2TIMCallback callback 
)
pure virtual

6.1 订阅公众号(7.6 及其以上版本支持)

◆ UnsubscribeOfficialAccount()

virtual void UnsubscribeOfficialAccount ( const V2TIMString officialAccountID,
V2TIMCallback callback 
)
pure virtual

6.2 取消订阅公众号(7.6 及其以上版本支持)

◆ GetOfficialAccountsInfo()

virtual void GetOfficialAccountsInfo ( const V2TIMStringVector officialAccountIDList,
V2TIMValueCallback< V2TIMOfficialAccountInfoResultVector > *  callback 
)
pure virtual

6.3 获取公众号列表(7.6 及其以上版本支持)

注意
officialAccountIDList 传空时,获取订阅的公众号列表

◆ FollowUser()

virtual void FollowUser ( const V2TIMStringVector userIDList,
V2TIMValueCallback< V2TIMFollowOperationResultVector > *  callback 
)
pure virtual

7.1 关注用户(从 7.8 版本开始支持)

注意

◆ UnfollowUser()

virtual void UnfollowUser ( const V2TIMStringVector userIDList,
V2TIMValueCallback< V2TIMFollowOperationResultVector > *  callback 
)
pure virtual

7.2 取消关注用户(从 7.8 版本开始支持)

注意

◆ GetMyFollowingList()

virtual void GetMyFollowingList ( const V2TIMString nextCursor,
V2TIMValueCallback< V2TIMUserInfoResult > *  callback 
)
pure virtual

7.3 获取我的关注列表(从 7.8 版本开始支持)

参数
nextCursor分页拉取标志,第一次拉取填 "",回调成功如果 nextCursor 不为 "",需要分页,可以传入该值再次拉取,直至 nextCursor 返回为 ""
注意

◆ GetMyFollowersList()

virtual void GetMyFollowersList ( const V2TIMString nextCursor,
V2TIMValueCallback< V2TIMUserInfoResult > *  callback 
)
pure virtual

7.4 获取我的粉丝列表(从 7.8 版本开始支持)

参数
nextCursor分页拉取标志,第一次拉取填 "",回调成功如果 nextCursor 不为 "",需要分页,可以传入该值再次拉取,直至 nextCursor 返回为 ""
注意

◆ GetMutualFollowersList()

virtual void GetMutualFollowersList ( const V2TIMString nextCursor,
V2TIMValueCallback< V2TIMUserInfoResult > *  callback 
)
pure virtual

7.5 获取我的互关列表(从 7.8 版本开始支持)

参数
nextCursor分页拉取标志,第一次拉取填 "",回调成功如果 nextCursor 不为 "",需要分页,可以传入该值再次拉取,直至 nextCursor 返回为 ""
注意

◆ GetUserFollowInfo()

virtual void GetUserFollowInfo ( const V2TIMStringVector userIDList,
V2TIMValueCallback< V2TIMFollowInfoVector > *  callback 
)
pure virtual

7.6 获取指定用户的 关注/粉丝/互关 数量信息(从 7.8 版本开始支持)

注意

◆ CheckFollowType()

virtual void CheckFollowType ( const V2TIMStringVector userIDList,
V2TIMValueCallback< V2TIMFollowTypeCheckResultVector > *  callback 
)
pure virtual

7.7 检查指定用户的关注类型(从 7.8 版本开始支持)

注意