管理用户关系

小于 1 分钟

管理用户关系

SDK 提供用户关系管理功能，包括好友列表管理和黑名单管理：

  • 好友列表管理：查询好友列表、申请添加好友、同意好友申请、拒绝好友申请、删除好友和设置好友备注等操作。
  • 黑名单管理：查询黑名单列表、添加用户至黑名单以及将用户移出黑名单等操作。

技术原理

环信即时通讯 IM Web SDK 提供以下好友管理功能：

  • 添加、删除好友；
  • 设置好友备注；
  • 查询好友列表；
  • 添加用户至黑名单；
  • 将用户移出黑名单；
  • 获取好友黑名单列表。

前提条件

开始前，请确保满足以下条件：

  • 完成 SDK 初始化，并连接到服务器，详见 快速开始；
  • 了解环信即时通讯 IM 的使用限制，详见 使用限制。

实现方法

添加好友

本节主要介绍发送好友请求、接收好友请求、处理好友请求和好友请求处理结果回调等。

  1. 调用 conn.addEventHandler() 注册监听好友状态，示例代码如下：
/**
 * `msg` 为触发回调后的结果。
 * `contactEvent` 可自定义。
 * 下面的举例中，用户 A 为当前用户。
 */
conn.addEventHandler("contactEvent", {
    // 当前用户收到好友请求。用户 B 向用户 A 发送好友请求，用户 A 收到该事件。
    onContactInvited: function (msg) {},
    // 当前用户被其他用户从联系人列表上移除。用户 B 将用户 A 从联系人列表上删除，用户 A 收到该事件。
    onContactDeleted: function (msg) {},
    // 当前用户新增了联系人。用户 B 向用户 A 发送好友请求，用户 A 同意该请求，用户 A 收到该事件，而用户 B 收到 `onContactAgreed` 事件。
    onContactAdded: function (msg) {},
    // 当前用户发送的好友请求被拒绝。用户 A 向用户 B 发送好友请求，用户 B 收到好友请求后，拒绝加好友，则用户 A 收到该事件。
    onContactRefuse: function (msg) {},
    // 当前用户发送的好友请求经过了对方同意。用户 A 向用户 B 发送好友请求，用户 B 收到好友请求后，同意加好友，则用户 A 收到该事件。
    onContactAgreed: function (msg) {},
});
  1. 调用 addContact 请求添加好友，示例代码如下：
conn.addContact("userId", "加个好友呗!");

  1. 对端用户通过 onContactInvited 监听事件收到好友请求，确认是否成为好友。

    • 若接受好友请求，需调用 acceptContactInvite 方法。请求方收到 onContactAgreed 事件。

    示例代码如下：

    conn.acceptContactInvite("userId");
    • 若拒绝好友请求，需调用 declineContactInvite 方法。请求方收到 onContactRefuse 事件。

    示例代码如下：

    conn.declineContactInvite("userId");

删除好友

删除联系人时会同时删除对方联系人列表中的该用户，建议执行双重确认，以免发生误删操作。删除操作不需要对方同意或者拒绝。

你可以调用 deleteContact 方法删除好友，示例代码如下：

conn.deleteContact("userId");

删除好友后，对方会收到 onContactDeleted 事件。

设置好友备注

自 4.3.0 版本开始，你可以调用 setContactRemark 方法设置单个好友的备注。

好友备注的长度不能超过 100 个字符。

conn
  .setContactRemark({
    userId: "userId", // 添加备注的目标好友的用户 ID
    remark: "remark" // 好友备注
  })
  .then(() => {
    console.log("setContactRemark success");
  })
  .catch((e) => {
    console.log(e, "setContactRemark failed");
  });

获取好友列表

自 4.3.0 版本，你可以调用 getAllContacts 或 getContactsWithCursor 方法一次性或分页获取好友列表，其中每个好友对象包含好友的用户 ID 和好友备注。

  • 一次性获取好友列表：
conn
  .getAllContacts()
  .then((res) => {
    console.log(res, 'getAllContacts success');
  })
  .catch((e) => {
    console.log(e, 'getAllContacts failed');
  });
  • 分页获取好友列表：
conn
  .getContactsWithCursor({
    pageSize: 20, // 每页期望获取的联系人数量。取值范围为 [1,50]，默认为 `20`。
    cursor: '' // 开始获取数据的游标位置。
  })
  .then((res) => {
    console.log(res, "getContactsWithCursor success");
  })
  .catch((e) => {
    console.log(e, "getContactsWithCursor failed");
  });

此外，你可以调用 getContacts 方法从服务端一次性获取好友列表，该列表只包含好友的用户 ID。

conn.getContacts().then((res) => {
    console.log(res) // res.data > ['user1', 'user2']
})

添加用户至黑名单

你可以调用 addUsersToBlocklist 添加用户到黑名单。用户被加入黑名单后，无法向你发送消息，也无法发送好友申请。

用户可以将任何其他用户添加到黑名单列表，无论该用户是否是好友。好友被加入黑名单后仍在好友列表上显示。

conn.addUsersToBlocklist({
    //可以添加单个用户 ID 或批量添加多个用户 ID 组成的数组。
    name: ["user1", "user2"],
});

将用户移出黑名单

你可以调用 removeUserFromBlocklist 方法将用户移出黑名单，示例代码如下：

conn.removeUserFromBlocklist({
    //可以添加单个用户 ID 或批量添加多个用户 ID 组成的数组。
    name: ["user1", "user2"],
});

获取黑名单列表

你可以调用 getBlocklist 方法获取用户黑名单列表，示例代码如下：

conn.getBlocklist().then((res) => {
    console.log(res);
});