• UIKit
  • SDK
  • 服务端 API
Chat/
SDK/
Flutter/
用户/
SDK
  • 安装即时通信 IM SDK
    • 安装
  • 初始化即时通信 IM SDK
    • 初始化
  • 登录和注销
    • 登录和注销
  • 消息
    • 消息概述
    • 发送消息
    • 接收消息
    • 历史消息
    • 转发消息
    • 修改消息
    • 消息插入
    • 删除消息
    • 清空消息
    • 撤回消息
    • 在线消息
    • 已读回执
    • 查询消息
    • 群 @ 消息
    • 定向群消息
    • 通知免打扰
    • 消息扩展
  • 会话
    • 会话概述
    • 会话列表
    • 获取会话
    • 未读会话数
    • 置顶会话
    • 删除会话
    • 会话草稿
    • 会话组
  • 群组
    • 群组概述
    • 群组管理
    • 群资料
    • 群成员管理
    • 群成员资料
    • 自定义群属性
  • 用户
    • 用户资料
    • 好友管理
    • 好友列表
    • 黑名单
  • 离线推送
    • 离线推送
  • 信令
    • 信令管理
  • 局部搜索
    • 查找消息
    • 查找好友
    • 查找群组
    • 查找群成员
  • 接口参考文档
    • 客户接口
  • 开发指引
  • 控制台指南
    • 创建和升级应用
    • 基本配置
    • 功能配置
    • 账号管理
    • 群组管理
    • 回调配置
  • 产品介绍
    • 消息管理
      • 单聊消息
      • 消息存储
      • 离线推送
      • 群消息
      • 消息格式
    • 账号系统
      • 登陆验证
      • 在线状态管理
    • 群相关
      • 群组系统
      • 群组管理
    • 用户资料和关系链
      • 资料管理
      • 关系链管理
  • 购买指南
    • 计费概述
    • 价格中心
  • 错误码

好友管理

功能描述

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

获取好友列表

IM SDK 支持好友关系链逻辑,您可以调用 getFriendList (点击查看详情) 接口获取好友列表。
示例代码如下:
// 获取好友列表
V2TimValueCallback<List<V2TimFriendInfo>> friendsList = await friendshipManager.getFriendList();

添加好友

您可以调用 addFriend (点击查看详情) 接口添加好友。
示例代码如下:
// 添加双向好友
V2TimValueCallback<V2TimFriendOperationResult> addFriend = await friendshipManager.addFriend(userID: "userID",remark:"加好友的备注",addWording:"附言",addType:FriendTypeEnum.V2TIM_FRIEND_TYPE_BOTH);
根据对方用户资料中的加好友需要验证与否,可以分为两种处理流程:

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

1. 用户 A 和 B 调用 setFriendListener 设置关系链监听器。
2. 用户 B 通过 setSelfInfo 函数里的 allowType (点击查看详情) 字段设置为加好友不需要验证(V2TIM_FRIEND_ALLOW_ANY)。
3. 用户 A 调用 addFriend 申请添加 B 为好友即可添加成功。添加成功后,按照申请参数 V2TIMFriendAddApplicationaddType 的设置有两种情况:
如果设置为双向好友 (V2TIM_FRIEND_TYPE_BOTH) ,则用户 A 和 B 都会收到 onFriendListAdded (点击查看详情) 回调;
如果设置为单向好友(V2TIM_FRIEND_TYPE_SINGLE),则只有用户 A 收到 onFriendListAdded 回调。

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

1. 用户 A 和 B 调用 setFriendListener 设置关系链监听。
2. 用户 B 通过 setSelfInfo 函数里的 allowType 字段设置为加好友需要验证(V2TIM_FRIEND_NEED_CONFIRM)。
3. 用户 A 调用 addFriend 申请添加 B 为好友,接口的成功回调参数中 resultCode 返回 30539,表示需要等待用户 B 的验证。同时 A 和 B 都会收到 onFriendApplicationListAdded (点击查看详情) 的回调。
4. 用户 B 会收到 onFriendApplicationListAdded 的回调,当参数 V2TIMFriendApplication 中的 typeV2TIM_FRIEND_APPLICATION_COME_IN 时,可以选择接受或者拒绝:
B 调用 acceptFriendApplication (点击查看详情) 接受好友请求。如果参数接受类型为仅同意加单向好友(V2TIM_FRIEND_ACCEPT_AGREE)时:
A 会收到 onFriendListAdded 回调,说明单向加好友成功。
B 会收到 onFriendApplicationListDeleted (点击查看详情) 回调,此时 B 成为 A 的好友,但 A 仍不是 B 的好友。
B 调用 acceptFriendApplication 接受好友请求,如果参数接受类型为同意加双向好友时(V2TIM_FRIEND_ACCEPT_AGREE_AND_ADD),A 和 B 都会收到 onFriendListAdded 回调,说明互相加好友成功。
B 调用 refuseFriendApplication (点击查看详情) 拒绝好友请求,双方都会收到 onFriendApplicationListDeleted 回调。

删除好友

您可以调用 deleteFromFriendList (点击查看详情) 接口删除好友关系。
示例代码如下:
// 删除双向好友
V2TimValueCallback<List<V2TimFriendOperationResult>> deleteres = await friendshipManager.deleteFromFriendList(deleteType: FriendTypeEnum.V2TIM_FRIEND_TYPE_BOTH,userIDList:['user1']);

检查好友关系

您可以调用 checkFriend (点击查看详情) 接口检查好友关系。
示例代码如下:
// 检测好友是否有双向(单向)好友关系。
V2TimValueCallback<List<V2TimFriendCheckResult>> checkres = await friendshipManager.checkFriend(checkType:FriendTypeEnum.V2TIM_FRIEND_TYPE_BOTH,userIDList: [] );

设置只能给好友发消息

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