好友管理

功能描述

IM SDK 支持好友的管理,用户可以主动添加、删除好友,也可以设置仅针对好友才能发送消息。

获取好友列表

IM SDK 支持好友关系链逻辑,您可以调用 FriendshipGetFriendProfileList (点击查看详情) 接口获取好友列表。
示例代码如下:
// 获取好友列表
TIMResult res = TencentIMSDK.FriendshipGetFriendProfileList((int code, string desc, List<FriendProfile> profile_list, string user_data)=>{
// 处理异步逻辑
});

添加好友

您可以调用 FriendshipAddFriend (点击查看详情) 接口添加好友。
示例代码如下:
// 添加双向好友
FriendshipAddFriendParam param = new FriendshipAddFriendParam
{
friendship_add_friend_param_identifier = "friend_userid",
friendship_add_friend_param_friend_type = TIMFriendType.FriendTypeBoth,
friendship_add_friend_param_remark = "nickname",
friendship_add_friend_param_add_wording = "greeting"
};
TIMResult res = TencentIMSDK.FriendshipAddFriend(param, (int code, string desc, FriendResult result, string user_data)=>{
// 处理异步逻辑
});
根据对方用户资料中的加好友需要验证与否,可以分为两种处理流程:

第一种:加好友不需要对方验证

1. 用户 A 和 B 调用 SetOnAddFriendCallback 设置关系链监听器。
2. 用户 B 通过 ProfileModifySelfUserProfile 函数里的 user_profile_item_add_permission (点击查看详情) 字段设置为加好友不需要验证(kTIMProfileAddPermission_AllowAny)。
3. 用户 A 调用 FriendshipAddFriend 申请添加 B 为好友即可添加成功。添加成功后,按照申请参数 FriendshipAddFriendParamfriendship_add_friend_param_friend_type 的设置有两种情况:
如果设置为双向好友 (TIMFriendType.FriendTypeBoth) ,则用户 A 和 B 都会收到 OnAddFriendCallback (点击查看详情) 回调;
如果设置为单向好友(TIMFriendType.FriendTypeSignle),则只有用户 A 收到 OnAddFriendCallback 回调。

第二种:加好友需要通过对方验证

1. 用户 A 和 B 调用 SetOnAddFriendCallback 设置关系链监听。
2. 用户 B 通过 ProfileModifySelfUserProfile 函数里的 user_profile_item_add_permission 字段设置为加好友需要验证(kTIMProfileAddPermission_NeedConfirm)。
3. 用户 A 调用 FriendshipAddFriend 申请添加 B 为好友,接口的成功回调参数中 code 返回 30539,表示需要等待用户 B 的验证。
4. 用户 B 会收到 SetFriendAddRequestCallback 的回调,可以选择接受或者拒绝:
B 调用 FriendshipHandleFriendAddRequest (点击查看详情) 接受好友请求。如果参数接受类型为仅同意加单向好友(TIMFriendResponseAction.ResponseActionAgree)时:
A 会收到 OnAddFriendCallback 回调,说明单向加好友成功。
B 会收到 FriendApplicationListDeletedCallback (点击查看详情) 回调,此时 B 成为 A 的好友,但 A 仍不是 B 的好友。
B 调用 FriendshipHandleFriendAddRequest 接受好友请求,如果参数接受类型为同意加双向好友时(TIMFriendResponseAction.ResponseActionAgreeAndAdd),A 和 B 都会收到 OnAddFriendCallback 回调,说明互相加好友成功。
B 调用 FriendshipHandleFriendAddRequest 传参 TIMFriendResponseAction.ResponseActionReject 拒绝好友请求,双方都会收到 FriendApplicationListDeletedCallback 回调。

删除好友

您可以调用 FriendshipDeleteFriend (点击查看详情) 接口删除好友关系。
示例代码如下:
// 删除双向好友
FriendshipDeleteFriendParam param = new FriendshipDeleteFriendParam
{
friendship_delete_friend_param_friend_type = TIMFriendType.FriendTypeBoth,
friendship_delete_friend_param_identifier_array = new List<string>
{
"user_id"
}
};
TIMResult res = TencentIMSDK.FriendshipDeleteFriend(param, (int code, string desc, FriendResult result, string user_data)=>{
// 处理异步逻辑
});

检查好友关系

您可以调用 FriendshipCheckFriendType (点击查看详情) 接口检查好友关系。
示例代码如下:
// 检测好友是否有双向(单向)好友关系。
FriendshipCheckFriendTypeParam param = new FriendshipCheckFriendTypeParam
{
friendship_check_friendtype_param_check_type = TIMFriendType.FriendTypeBoth,
friendship_check_friendtype_param_identifier_array = new List<string>{
"user_id"
}
};
TIMResult res = TencentIMSDK.FriendshipCheckFriendType(param, (int code, string desc, List<FriendshipCheckFriendTypeResult> result_list, string user_data)=>{
// 处理异步逻辑
});

设置只能给好友发消息

IM SDK 在发送单聊消息的时候,默认不检查好友关系。在客服场景中,如果用户需要先加客服为好友才能进行沟通非常不方便,因此该默认设置常用于在线客服等场景。 如需先加好友,再发消息”的交互体验,您可以在 即时通信 IM 控制台 >【功能配置】>【登录与消息】>【好友关系检查】中开启"发送单聊消息检查关系链"。开启后,用户只能给好友发送消息,当用户给非好友发消息时,SDK 会报 20009 错误码。