管理聊天室成员

大约 7 分钟

管理聊天室成员

聊天室是支持多人沟通的即时通讯系统。本文介绍如何使用环信即时通讯 IM Web SDK 在实时互动 app 中管理聊天室成员，并实现聊天室的相关功能。

技术原理

环信即时通讯 IM SDK 支持对聊天室成员的管理，包括获取、添加和移出聊天室成员等：

  • 获取聊天室成员列表；
  • 退出聊天室；
  • 管理聊天室黑名单；
  • 管理聊天室白名单；
  • 管理聊天室禁言；
  • 管理聊天室所有者及管理员。

前提条件

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

实现方法

获取聊天室成员列表

聊天室所有成员均可调用 listChatRoomMembers 获取当前聊天室成员列表。

示例代码如下：

//pageNum：当前页码，从 1 开始。
//pageSize：每页期望返回的成员数,最大值为 1,000。
let option = {
    pageNum: 1,
    pageSize: 10,
    chatRoomId: 'chatRoomId'
}
conn.listChatRoomMembers(option).then(res => console.log(res))

退出聊天室

主动退出

聊天室所有成员均可以调用 leaveChatRoom 退出当前聊天室。成员退出聊天室时，其他成员收到 memberAbsence 事件。与群主无法退出群组不同，聊天室所有者可以离开聊天室，退出后重新进入仍是该聊天室的所有者。

示例代码如下：

let option = {
    roomId: 'roomId'
}
conn.leaveChatRoom(option).then(res => console.log(res))

被移出

仅聊天室所有者和聊天室管理员可以调用 removeChatRoomMember 方法将指定的单个成员移出聊天室。被踢出聊天室后，被踢成员会收到 removeMember 事件，其他成员会收到 memberAbsence 事件。被移出聊天室后，该用户还可以再次加入聊天室。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId",
    username: "userId"
};
conn.removeChatRoomMember(option).then(res => console.log(res))

离线后自动退出

由于网络等原因，聊天室中的成员离线超过 2 分钟会自动退出聊天室。若需调整该时间，需联系环信商务。

以下两类成员即使离线也不会退出聊天室：

管理聊天室黑名单

获取聊天室黑名单列表

仅聊天室所有者和管理员可调用 getChatRoomBlocklist 获取当前聊天室黑名单成员列表。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId",
};
conn.getChatRoomBlocklist(option);

将成员添加至聊天室黑名单

仅聊天室所有者和管理员可调用 blockChatRoomMembers 方法将成员加入聊天室黑名单。

被加入黑名单的成员会收到 removeMember 事件，其他成员收到 memberAbsence 事件。

被加入黑名单后，该成员无法再收发聊天室消息并被移出聊天室。黑名单中的成员如想再次加入聊天室，聊天室所有者或管理员必须先将其移出黑名单列表。

示例代码如下：

let option = {
    chatRoomId: 'chatRoomId',
    usernames: ['user1', 'user2'] // 用户 ID 数组。
};
conn.blockChatRoomMembers(option).then(res => console.log(res));

将成员移出聊天室黑名单

仅聊天室所有者和管理员可调用 unblockChatRoomMembers 方法将成员移出聊天室黑名单。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId",
    usernames: ["user1", "user2"] // 用户 ID 数组。
}
conn.unblockChatRoomMembers(option).then(res => console.log(res));

管理聊天室白名单

聊天室所有者和管理员默认会被加入聊天室白名单。

聊天室白名单中的成员在聊天室中发送的消息为高优先级，会优先送达，但不保证必达。当负载较高时，服务器会优先丢弃低优先级的消息。若即便如此负载仍很高，服务器也会丢弃高优先级消息。

获取聊天室白名单列表

仅聊天室所有者和管理员可调用 getChatRoomAllowlist 方法获取当前聊天室白名单成员列表。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId"
}
conn.getChatRoomAllowlist(option).then(res => console.log(res));

检查自己是否在聊天室白名单中

所有聊天室成员可以调用 isInChatRoomAllowlist 方法检查自己是否在聊天室白名单中。

提示

聊天室的管理员可查询所有用户，普通成员只能查询自己。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId",
    userName: "user"
}
conn.isInChatRoomAllowlist(option);

将成员加入聊天室白名单

仅聊天室所有者和管理员可调用 addUsersToChatRoomAllowlist 方法将成员添加至聊天室白名单。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId",
    users: ["user1", "user2"] // 成员 ID 列表。
};
conn.addUsersToChatRoomAllowlist(option);

将成员移出聊天室白名单

仅聊天室所有者和管理员可调用 removeChatRoomAllowlistMember 方法将成员移出聊天室白名单。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId",
    userName: "userId"
}
conn.removeChatRoomAllowlistMember(option);

管理禁言

聊天室所有者和管理员可以将指定聊天室成员添加或移出禁言列表，也可开启关闭全员禁言。全员禁言和单独的成员禁言不冲突，开启和关闭全员禁言，并不影响禁言列表。

获取聊天室禁言列表

仅聊天室所有者和管理员可调用 getChatRoomMuteList 方法获取聊天室禁言列表。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId"
};
conn.getChatRoomMuteList(option).then(res => console.log(res))

将成员添加至聊天室禁言列表

仅聊天室所有者和管理员可调用 muteChatRoomMember 方法将指定成员添加至聊天室禁言列表。被禁言的成员和其他未操作的聊天室管理员或聊天室所有者收到 muteMember 事件。

提示

聊天室所有者可禁言聊天室所有成员，聊天室管理员可禁言聊天室普通成员。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId", // 聊天室 ID。
    username: 'userId',     // 被禁言的聊天室成员的 ID。
    muteDuration: -1000       // 禁言时长，单位为毫秒。若传 “-1,000” 表示永久禁言。
};
conn.muteChatRoomMember(option).then(res => console.log(res))

将成员移出聊天室禁言列表

仅聊天室所有者和管理员可调用 unmuteChatRoomMember 方法将一组成员解除禁言。

提示

聊天室所有者可对聊天室所有成员解除禁言，聊天室管理员可对聊天室普通成员解除禁言。被解除禁言的成员和其他未操作的聊天室管理员或聊天室所有者收到 unmuteMember 事件。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId",
    username: 'username'
};
conn.unmuteChatRoomMember(option).then(res => console.log(res))

开启全员禁言

仅聊天室所有者和管理员可调用 disableSendChatRoomMsg 方法设置全员禁言。全员禁言开启后不会在一段时间内自动取消禁言，需要调用 enableSendChatRoomMsg 方法取消全员禁言。

全员禁言开启后，除了在白名单中的群成员，其他成员不能发言。调用成功后，聊天室成员会收到 muteAllMembers 事件。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId"
};
conn.disableSendChatRoomMsg(option).then(res => console.log(res))

关闭全员禁言

仅聊天室所有者和管理员可调用 enableSendChatRoomMsg 方法设置解除全员禁言。调用成功后，聊天室成员会收到 unmuteAllMembers 事件。

示例代码如下：

let option = {
    chatRoomId: "chatRoomId"
};
conn.enableSendChatRoomMsg(option).then((res) => {
    console.log(res)
})

管理聊天室管理员

添加聊天室管理员

仅聊天室所有者可调用 setChatRoomAdmin 添加聊天室管理员。成功添加后，新管理员及其他管理员会收到 setAdmin 事件。

示例代码如下：

let option = {
    chatRoomId: 'chatRoomId',
    username: 'userId'
}
conn.setChatRoomAdmin(option).then(res => console.log(res))

移除聊天室管理员

仅聊天室的所有者可调用 removeChatRoomAdmin 方法移除聊天室管理员。成功移除后，被移除的聊天室管理员和其他管理员会收到 removeAdmin 事件。

示例代码如下：

let option = {
    chatRoomId: 'chatRoomId',
    username: 'userId'
}
conn.removeChatRoomAdmin(option).then(res => console.log(res))

监听聊天室事件

有关详细信息，请参阅 聊天室事件。

环信 IM 文档 Version: 1.0.0 ©️环信