常规集成(无 UI 库)

服务端 API

用户资料与关系链(Android)

最近更新时间:2020-05-29 09:01:41

用户资料管理

查询和修改自己的资料

查询自己的资料接口为 getUsersInfo,其中参数 userIDList 需填入自己的 UserID。
修改自己的资料接口为 setSelfInfo。修改自己的资料成功后,会收到 onSelfInfoUpdated 回调。

查询非好友用户资料

查询非好友资料接口同查询自己的资料 getUsersInfo,参数 userIDList 填入非好友的 UserID 即可。

查询和修改好友的资料

查询指定的好友资料接口为 getFriendsInfo,从回调信息中通过 V2TIMFriendInfoResultgetRelation() 可以得到该用户与自己的关系:

  • V2TIMFriendCheckResult.V2TIM_FRIEND_RELATION_TYPE_NONE 表示不是好友。
  • V2TIMFriendCheckResult.V2TIM_FRIEND_RELATION_TYPE_BOTH_WAY 表示互为好友。
  • V2TIMFriendCheckResult.V2TIM_FRIEND_RELATION_TYPE_IN_MY_FRIEND_LIST 表示对方在我的好友列表中。
  • V2TIMFriendCheckResult.V2TIM_FRIEND_RELATION_TYPE_IN_OTHER_FRIEND_LIST 表示我在对方的好友列表中。

修改指定的好友信息接口为 setFriendInfo ,可修改好友备注等资料。

屏蔽某人消息

  • 拉黑某人
    如需屏蔽某人的消息,请调用 addToBlackList 接口把该用户加入黑名单,即拉黑该用户。
    被拉黑的用户默认不会感知到“被拉黑”的状态,消息发送后不会返回已被对方拉黑的错误码。如果希望被拉黑的用户在发消息时返回已被对方拉黑的错误提醒,可以参考 被拉黑的用户发消息怎么给错误提示

  • 解除拉黑
    从黑名单中移除对方后可再次接收对方的消息,可调用 deleteFromBlackList

  • 获取黑名单列表
    您可以通过 getBlackList 查看已拉黑多少用户,并对黑名单人员进行管理。

好友管理

是否需要加好友

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

好友列表管理

IM SDK 支持好友关系链逻辑,您可以调用 getFriendList 接口获取好友列表,调用 deleteFromFriendList 接口删除好友关系,也可以调用 addFriend 接口添加好友。

根据对方用户资料中的加好友需要验证与否,可以分为两种处理流程:

第一种 加好友不需要验证

  1. 用户 A 和 B 调用 setFriendListener 设置关系链监听。
  2. 用户 B 调用 setSelfInfo 接口并将参数 info 通过接口 setAllowType 设置为加好友不需要验证 V2TIM_FRIEND_ALLOW_ANY
  3. 用户 A 调用 addFriend 申请添加 B 为好友即可添加成功。如果申请参数 V2TIMFriendAddApplicationsetAddType 设置为双向好友即 V2TIMFriendInfo.V2TIM_FRIEND_TYPE_BOTH,则用户 A 和 B 都会收到 onFriendListAdded 回调;
    如果设置为单向好友即 V2TIMFriendInfo.V2TIM_FRIEND_TYPE_SINGLE,则只有用户 A 收到 onFriendListAdded 回调。

第二种 加好友需要验证

  1. 用户 A 和 B 调用 setFriendListener 设置关系链监听。
  2. 用户 B 调用 setSelfInfo 接口并将参数 info 通过接口 setAllowType 设置为加好友需要验证 V2TIM_FRIEND_NEED_CONFIRM
  3. 用户 A 调用 addFriend 申请添加 B 为好友,接口的成功回调参数中 V2TIMFriendOperationResult 中的 getResultCode 返回30539,表示需要等待用户 B 的验证,同时 A 和 B 都会收到 onFriendApplicationListAdded 的回调。
  4. 用户 B 会收到 onFriendApplicationListAdded 的回调,当参数 V2TIMFriendApplication 中的 getTypeV2TIMFriendApplication.V2TIM_FRIEND_APPLICATION_COME_IN 时,可以选择接受或者拒绝

好友分组管理

在某些场景下,您可能需要对好友进行分组,例如分为 "大学同学"、"公司同事" 等,您可以调用以下接口实现。

功能描述 接口指引
新建好友分组 createFriendGroup
删除好友分组 deleteFriendGroup
修改好友分组 renameFriendGroup
获取好友分组 getFriendGroupList
添加好友到一个分组 addFriendsToFriendGroup
从分组中删除某好友 deleteFriendsFromFriendGroup

常见使用问题

1. 非好友之间怎么禁止收发消息?

SDK 默认不限制非好友之间收发消息。如果您希望只允许好友之间收发消息,请在 即时通信 IM 控制台 >【功能配置】>【登录与消息】>【好友关系检查】中开启"发送单聊消息检查关系链"。开启之后,给陌生人发消息时,SDK 会报20009错误码。

2. 被拉黑的用户发消息怎么给错误提示?

当消息发送者被拉黑后,发送者默认不会感知到“被拉黑”的状态,即发送消息后仍展示发送成功(实际上此时接收方不会收到消息)。如果需要被拉黑的发送者收到消息发送失败的提示,请在 即时通信 IM 控制台 >【功能配置】>【登录与消息】>【黑名单检查】中关闭"发送消息后展示发送成功",关闭后,被拉黑的发送者在发送消息时,SDK 会报20007错误码。

目录