TIMFriendshipManager Class Reference
Inherits from | NSObject |
---|---|
Declared in | TIMFriendshipManager.h |
+ sharedInstance
获取好友管理器实例
+ (TIMFriendshipManager *)sharedInstance
Return Value
管理器实例
Declared In
TIMFriendshipManager.h
– modifySelfProfile:succ:fail:
设置自己的资料
- (int)modifySelfProfile:(NSDictionary<NSString*,id> *)values succ:(TIMSucc)succ fail:(TIMFail)fail
Parameters
values |
需要更新的属性,可一次更新多个字段. 参见 TIMFriendshipDefine.h 的 TIMProfileTypeKey_XXX |
---|---|
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– getSelfProfile:fail:
获取自己的资料
- (int)getSelfProfile:(TIMGetProfileSucc)succ fail:(TIMFail)fail
Parameters
succ |
成功回调,返回 TIMUserProfile |
---|---|
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– querySelfProfile
在缓存中查询自己的资料
- (TIMUserProfile *)querySelfProfile
Return Value
返回缓存的资料,未找到返回nil
Declared In
TIMFriendshipManager.h
– getUsersProfile:forceUpdate:succ:fail:
获取指定用户资料
- (int)getUsersProfile:(NSArray<NSString*> *)identifiers forceUpdate:(BOOL)forceUpdate succ:(TIMUserProfileArraySucc)succ fail:(TIMFail)fail
Parameters
identifiers |
用户id,非好友的用户也可以 @prarm forceUpdate 强制从后台拉取 |
---|---|
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– queryUserProfile:
在缓存中查询用户的资料
- (TIMUserProfile *)queryUserProfile:(NSString *)identifier
Return Value
返回缓存的资料,未找到返回nil
Discussion
@praram identifier 用户id,非好友的用户也可以
Declared In
TIMFriendshipManager.h
– getFriendList:fail:
获取好友列表
- (int)getFriendList:(TIMFriendArraySucc)succ fail:(TIMFail)fail
Parameters
succ |
成功回调,返回好友(TIMFriend)列表 |
---|---|
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– queryFriend:
在缓存中查询用户的关系链数据
- (TIMFriend *)queryFriend:(NSString *)identifier
Return Value
返回缓存的关系链数据,未找到返回nil
Discussion
@praram identifier 用户id
Note: 缓存数据来自于上一次调用getFriendList,请确保已调用了获取好友列表方法
Declared In
TIMFriendshipManager.h
– queryFriendList
获取缓存中的关系链列表
- (NSArray<TIMFriend*> *)queryFriendList
Return Value
返回缓存的关系链数据
Discussion
Note: 缓存数据来自于上一次调用getFriendList,请确保已调用了获取好友列表方法
Declared In
TIMFriendshipManager.h
– checkFriends:succ:fail:
检查指定用户的好友关系
- (int)checkFriends:(TIMFriendCheckInfo *)checkInfo succ:(TIMCheckFriendResultArraySucc)succ fail:(TIMFail)fail
Parameters
checkInfo |
好友检查信息 |
---|---|
succ |
成功回调,返回检查结果 |
fail |
失败回调 |
Return Value
0 发送成功
Declared In
TIMFriendshipManager.h
– addFriend:succ:fail:
添加好友
- (int)addFriend:(TIMFriendRequest *)request succ:(TIMFriendResultSucc)succ fail:(TIMFail)fail
Parameters
request |
添加好友请求 |
---|---|
succ |
成功回调(TIMFriendResult) |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– doResponse:succ:fail:
响应对方好友邀请
- (int)doResponse:(TIMFriendResponse *)response succ:(TIMFriendResultSucc)succ fail:(TIMFail)fail
Parameters
response |
响应请求 |
---|---|
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– deleteFriends:delType:succ:fail:
删除好友
- (int)deleteFriends:(NSArray *)identifiers delType:(TIMDelFriendType)delType succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail
Parameters
identifiers |
好友id |
---|---|
delType |
删除类型(单向好友、双向好友) |
succ |
成功回调([TIMFriendResult]) |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– modifyFriend:values:succ:fail:
修改好友
- (int)modifyFriend:(NSString *)identifier values:(NSDictionary<NSString*,id> *)values succ:(TIMSucc)succ fail:(TIMFail)fail
Parameters
identifier |
好友id |
---|---|
values |
需要更新的属性,可一次更新多个字段. 参见 TIMFriendshipDefine.h 的 TIMFriendTypeKey_XXX |
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– getPendencyList:succ:fail:
获取未决列表
- (int)getPendencyList:(TIMFriendPendencyRequest *)pendencyRequest succ:(TIMGetFriendPendencyListSucc)succ fail:(TIMFail)fail
Parameters
pendencyRequest |
请求信息,详细参考TIMFriendPendencyRequest |
---|---|
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– deletePendency:users:succ:fail:
未决删除
- (int)deletePendency:(TIMPendencyType)type users:(NSArray *)identifiers succ:(TIMSucc)succ fail:(TIMFail)fail
Parameters
type |
未决好友类型 |
---|---|
identifiers |
要删除的未决列表 |
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– pendencyReport:succ:fail:
未决已读上报
- (int)pendencyReport:(uint64_t)timestamp succ:(TIMSucc)succ fail:(TIMFail)fail
Parameters
timestamp |
已读时间戳,此时间戳以前的消息都将置为已读 |
---|---|
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– getBlackList:fail:
获取黑名单列表
- (int)getBlackList:(TIMFriendArraySucc)succ fail:(TIMFail)fail
Parameters
succ |
成功回调,返回NSString*列表 |
---|---|
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– addBlackList:succ:fail:
添加用户到黑名单
- (int)addBlackList:(NSArray *)identifiers succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail
Parameters
identifiers |
用户列表 |
---|---|
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– deleteBlackList:succ:fail:
把用户从黑名单中删除
- (int)deleteBlackList:(NSArray *)identifiers succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail
Parameters
identifiers |
用户列表 |
---|---|
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– createFriendGroup:users:succ:fail:
新建好友分组
- (int)createFriendGroup:(NSArray *)groupNames users:(NSArray *)identifiers succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail
Parameters
groupNames |
分组名称列表,必须是当前不存在的分组 |
---|---|
identifiers |
要添加到分组中的好友 |
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– getFriendGroups:succ:fail:
获取指定的好友分组信息
- (int)getFriendGroups:(NSArray *)groupNames succ:(TIMFriendGroupArraySucc)succ fail:(TIMFail)fail
Parameters
groupNames |
要获取信息的好友分组名称列表,传入nil获得所有分组信息 |
---|---|
succ |
成功回调,返回 TIMFriendGroup* 列表 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– deleteFriendGroup:succ:fail:
删除好友分组
- (int)deleteFriendGroup:(NSArray *)groupNames succ:(TIMSucc)succ fail:(TIMFail)fail
Parameters
groupNames |
要删除的好友分组名称列表 |
---|---|
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– renameFriendGroup:newName:succ:fail:
修改好友分组的名称
- (int)renameFriendGroup:(NSString *)oldName newName:(NSString *)newName succ:(TIMSucc)succ fail:(TIMFail)fail
Parameters
oldName |
原来的分组名称 |
---|---|
newName |
新的分组名称 |
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– addFriendsToFriendGroup:users:succ:fail:
添加好友到一个好友分组
- (int)addFriendsToFriendGroup:(NSString *)groupName users:(NSArray *)identifiers succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail
Parameters
groupName |
好友分组名称 |
---|---|
identifiers |
要添加到分组中的好友 |
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h
– deleteFriendsFromFriendGroup:users:succ:fail:
从好友分组中删除好友
- (int)deleteFriendsFromFriendGroup:(NSString *)groupName users:(NSArray *)identifiers succ:(TIMFriendResultArraySucc)succ fail:(TIMFail)fail
Parameters
groupName |
好友分组名称 |
---|---|
identifiers |
要移出分组的好友 |
succ |
成功回调 |
fail |
失败回调 |
Return Value
0 发送请求成功
Declared In
TIMFriendshipManager.h