com.tencent.imsdk

类 TIMFriendshipManager

java.lang.Object

com.tencent.imsdk.TIMFriendshipManager

public class TIMFriendshipManager
extends java.lang.Object

资料关系链管理模块，负责好友的添加、删除、获取、资料的修改等功能。

方法概要

限定符和类型	方法和说明
void	addBlackList(java.util.List<java.lang.String> userIDList, TIMValueCallBack<java.util.List<TIMFriendResult>> cb) 添加用户到黑名单
void	addFriend(TIMFriendRequest timFriendRequest, TIMValueCallBack<TIMFriendResult> cb) 添加好友
void	addFriendsToFriendGroup(java.lang.String groupName, java.util.List<java.lang.String> userIDList, TIMValueCallBack<java.util.List<TIMFriendResult>> cb) 添加好友到某分组
void	checkFriends(TIMFriendCheckInfo checkInfo, TIMValueCallBack<java.util.List<TIMCheckFriendResult>> cb) 检查指定用户的好友关系。
void	createFriendGroup(java.util.List<java.lang.String> groupNames, java.util.List<java.lang.String> identifiers, TIMValueCallBack<java.util.List<TIMFriendResult>> cb) 新建好友分组
void	deleteBlackList(java.util.List<java.lang.String> userIDList, TIMValueCallBack<java.util.List<TIMFriendResult>> cb) 从黑名单中删除指定用户
void	deleteFriendGroup(java.util.List<java.lang.String> groupNames, TIMCallBack cb) 删除好友分组
void	deleteFriends(java.util.List<java.lang.String> userIDList, int delFriendType, TIMValueCallBack<java.util.List<TIMFriendResult>> cb) 删除好友
void	deleteFriendsFromFriendGroup(java.lang.String groupName, java.util.List<java.lang.String> userIDList, TIMValueCallBack<java.util.List<TIMFriendResult>> cb) 从某分组删除好友
void	deletePendency(int pendencyType, java.util.List<java.lang.String> userIDList, TIMValueCallBack<java.util.List<TIMFriendResult>> cb) 未决删除
void	doResponse(TIMFriendResponse response, TIMValueCallBack<TIMFriendResult> cb) 处理好友请求
void	getBlackList(TIMValueCallBack<java.util.List<TIMFriend>> cb) 获取黑名单列表
void	getFriendGroups(java.util.List<java.lang.String> groupNames, TIMValueCallBack<java.util.List<TIMFriendGroup>> cb) 获取指定的好友分组，传入 null 获得所有分组信息
void	getFriendList(java.util.List<java.lang.String> userIDList, TIMValueCallBack<java.util.List<TIMFriendGetResult>> callBack) 获取指定的好友，限制数量100个 注意：如果用户列表有重复的用户，回调结果会去除重复。
void	getFriendList(TIMValueCallBack<java.util.List<TIMFriend>> cb) 获取好友列表
static TIMFriendshipManager	getInstance() 获取好友管理器实例。
void	getPendencyList(TIMFriendPendencyRequest timFriendPendencyRequest, TIMValueCallBack<TIMFriendPendencyResponse> cb) 获取未决列表
int	getSelfProfile(TIMValueCallBack<TIMUserProfile> cb) 获取自己资料
void	getUsersProfile(java.util.List<java.lang.String> identifiers, boolean forceUpdate, TIMValueCallBack<java.util.List<TIMUserProfile>> cb) 获取指定用户资料
void	init() 初始化 TIMFriendshipManager
void	modifyFriend(java.lang.String identifier, java.util.HashMap<java.lang.String,java.lang.Object> profileMap, TIMCallBack cb) 修改好友资料
void	modifySelfProfile(java.util.HashMap<java.lang.String,java.lang.Object> profileMap, TIMCallBack cb) 修改自己的资料
void	pendencyReport(long timestamp, TIMCallBack cb) 未决已读上报
TIMFriend	queryFriend(java.lang.String identifier) 在缓存中查询用户的关系链数据，缓存数据来自于上一次调用 getFriendList(TIMValueCallBack) 的返回结果，请确保已调用过 getFriendList
java.util.List<TIMFriend>	queryFriendList() 获取缓存中的关系链列表，缓存数据来自于上一次调用 getFriendList(TIMValueCallBack) 的返回结果，请确保已调用过 getFriendList
TIMUserProfile	querySelfProfile() 获取本地自己的资料，没有则返回 null
TIMUserProfile	queryUserProfile(java.lang.String identifier) 获取本地用户资料，没有则返回 null
void	renameFriendGroup(java.lang.String oldName, java.lang.String newName, TIMCallBack cb) 重命名好友分组

从类继承的方法 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

方法详细资料

getInstance

public static TIMFriendshipManager getInstance()

获取好友管理器实例。

返回:

TIMFriendshipManager 实例

init

public void init()

初始化 TIMFriendshipManager

getUsersProfile

public void getUsersProfile(@NonNull
                            java.util.List<java.lang.String> identifiers,
                            boolean forceUpdate,
                            TIMValueCallBack<java.util.List<TIMUserProfile>> cb)

获取指定用户资料

参数:

identifiers - 用户的identifier列表

forceUpdate - 强制从后台拉取

cb - 回调

getSelfProfile

public int getSelfProfile(TIMValueCallBack<TIMUserProfile> cb)

获取自己资料

参数:

cb - 回调

返回:

0表示成功，-1表示参数为空

querySelfProfile

public TIMUserProfile querySelfProfile()

获取本地自己的资料，没有则返回 null

返回:

TIMUserProfile

queryUserProfile

public TIMUserProfile queryUserProfile(java.lang.String identifier)

获取本地用户资料，没有则返回 null

参数:

identifier -

返回:

TIMUserProfile

modifySelfProfile

public void modifySelfProfile(@NonNull
                              java.util.HashMap<java.lang.String,java.lang.Object> profileMap,
                              TIMCallBack cb)

修改自己的资料

参数:

profileMap - 需要修改的字段放在hashMap中，key 值取 TIMUserProfile 中的常量 TIM_PROFILE_TYPE_KEY_XXX

cb - 回调

getFriendList

public void getFriendList(TIMValueCallBack<java.util.List<TIMFriend>> cb)

获取好友列表

参数:

cb - 回调 TIMFriend 列表

getFriendList

public void getFriendList(java.util.List<java.lang.String> userIDList,
                          TIMValueCallBack<java.util.List<TIMFriendGetResult>> callBack)

获取指定的好友，限制数量100个

注意：如果用户列表有重复的用户，回调结果会去除重复。

参数:

userIDList - 指定用户列表

callBack - 回调

queryFriendList

public java.util.List<TIMFriend> queryFriendList()

获取缓存中的关系链列表，缓存数据来自于上一次调用 getFriendList(TIMValueCallBack) 的返回结果，请确保已调用过 getFriendList

返回:

返回缓存的关系链数据

queryFriend

public TIMFriend queryFriend(java.lang.String identifier)

在缓存中查询用户的关系链数据，缓存数据来自于上一次调用 getFriendList(TIMValueCallBack) 的返回结果，请确保已调用过 getFriendList

参数:

identifier - 用户id

返回:

返回缓存的关系链数据，未找到返回null

addFriend

public void addFriend(@NonNull
                      TIMFriendRequest timFriendRequest,
                      TIMValueCallBack<TIMFriendResult> cb)

添加好友

参数:

timFriendRequest - 添加请求

cb - 回调

deleteFriends

public void deleteFriends(@NonNull
                          java.util.List<java.lang.String> userIDList,
                          @NonNull
                          int delFriendType,
                          TIMValueCallBack<java.util.List<TIMFriendResult>> cb)

删除好友

参数:

userIDList - 好友列表

delFriendType - 删除类型

cb - 回调

modifyFriend

public void modifyFriend(@NonNull
                         java.lang.String identifier,
                         @NonNull
                         java.util.HashMap<java.lang.String,java.lang.Object> profileMap,
                         TIMCallBack cb)

修改好友资料

参数:

identifier - 好友标识

profileMap - 修改的字段，见TIMFriend中的TIM_FRIEND_PROFILE_TYPE_KEY_XXX

cb - 回调

doResponse

public void doResponse(TIMFriendResponse response,
                       TIMValueCallBack<TIMFriendResult> cb)

处理好友请求

参数:

response - 请求参数，包含好友id，预备注，回应类型

cb -

createFriendGroup

public void createFriendGroup(java.util.List<java.lang.String> groupNames,
                              java.util.List<java.lang.String> identifiers,
                              TIMValueCallBack<java.util.List<TIMFriendResult>> cb)

新建好友分组

参数:

groupNames - 分组名称列表,必须是当前不存在的分组

identifiers - 要添加到分组中的好友

cb - 回调

getFriendGroups

public void getFriendGroups(java.util.List<java.lang.String> groupNames,
                            TIMValueCallBack<java.util.List<TIMFriendGroup>> cb)

获取指定的好友分组，传入 null 获得所有分组信息

参数:

groupNames - 要获取信息的好友分组名称列表

cb -

deleteFriendGroup

public void deleteFriendGroup(java.util.List<java.lang.String> groupNames,
                              TIMCallBack cb)

删除好友分组

参数:

groupNames - 要删除的好友分组名称列表

cb - 回调

renameFriendGroup

public void renameFriendGroup(java.lang.String oldName,
                              java.lang.String newName,
                              TIMCallBack cb)

重命名好友分组

参数:

oldName - 原来的分组名称

newName - 新的分组名称

cb - 回调

addFriendsToFriendGroup

public void addFriendsToFriendGroup(java.lang.String groupName,
                                    java.util.List<java.lang.String> userIDList,
                                    TIMValueCallBack<java.util.List<TIMFriendResult>> cb)

添加好友到某分组

参数:

groupName - 好友分组名称

userIDList - 要添加到分组中的好友列表

cb - 回调

deleteFriendsFromFriendGroup

public void deleteFriendsFromFriendGroup(java.lang.String groupName,
                                         java.util.List<java.lang.String> userIDList,
                                         TIMValueCallBack<java.util.List<TIMFriendResult>> cb)

从某分组删除好友

参数:

groupName - 好友分组名称

userIDList - 要移除分组的好友列表

cb - 回调

getPendencyList

public void getPendencyList(TIMFriendPendencyRequest timFriendPendencyRequest,
                            TIMValueCallBack<TIMFriendPendencyResponse> cb)

获取未决列表

参数:

timFriendPendencyRequest -

cb -

deletePendency

public void deletePendency(int pendencyType,
                           java.util.List<java.lang.String> userIDList,
                           TIMValueCallBack<java.util.List<TIMFriendResult>> cb)

未决删除

参数:

pendencyType - 未决类型，见 TIMPendencyType, 删除只支持 TIM_PENDENCY_COME_IN 和 TIM_PENDENCY_SEND_OUT

userIDList - 要删除的未决用户 id 列表

cb - 回调

pendencyReport

public void pendencyReport(long timestamp,
                           TIMCallBack cb)

未决已读上报

参数:

timestamp - 已读时间戳，此时间戳以前的消息都将置为已读

cb - 回调

getBlackList

public void getBlackList(TIMValueCallBack<java.util.List<TIMFriend>> cb)

获取黑名单列表

参数:

cb - 回调

addBlackList

public void addBlackList(java.util.List<java.lang.String> userIDList,
                         TIMValueCallBack<java.util.List<TIMFriendResult>> cb)

添加用户到黑名单

参数:

userIDList - 用户列表

cb - 回调

deleteBlackList

public void deleteBlackList(@NonNull
                            java.util.List<java.lang.String> userIDList,
                            TIMValueCallBack<java.util.List<TIMFriendResult>> cb)

从黑名单中删除指定用户

参数:

userIDList - 用户列表

cb - 回调

checkFriends

public void checkFriends(@NonNull
                         TIMFriendCheckInfo checkInfo,
                         TIMValueCallBack<java.util.List<TIMCheckFriendResult>> cb)

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

参数:

checkInfo - 好友检查信息

cb - 回调