群组功能

更新时间:

本文介绍RTM基础功能中的群组功能，您可以了解群组功能的使用方法等内容。

功能简介

RTM提供了群组功能来实现多人群聊、讨论组等场景。以下为群组功能的完整功能和描述。

功能 描述
群组消息发送和接收 包括RTM客户端SDK和RTM服务端SDK的群组消息发送和接收
获取群组历史消息记录 包括RTM客户端SDK和RTM服务端SDK的群组历史消息的获取
获取群组未读消息数量 获取用户离线状态下未收到的群组消息的数量
添加群组成员 包括RTM客户端SDK和RTM服务端SDK的群组成员添加
删除群组成员 包括RTM客户端SDK和RTM服务端SDK的群组成员删除
获取群组成员列表 获取群组全部成员列表、在线成员列表
获取群组成员数量 获取群组全部成员数量、在线成员数量
判断用户的群组关系 判断用户是否是群组成员
获取用户所在群组 获取用户加入的全部群组
设置群组信息 设置群组的公有信息和私有信息
获取群组信息 获取群组的公有信息或全部信息
删除群组 通过RTM服务端SDK销毁群组
设置群组禁言 包括RTM客户端SDK和RTM服务端SDK的群组成员禁言
解除群组禁言 包括RTM客户端SDK和RTM服务端SDK的群组成员解禁
判断用户禁言情况 判断用户是否被群组禁言

与房间相比，群组：

  • 成员关系比较固定
  • 成员需要显式的加入和移除
  • 成员退出RTM服务后，成员的群组关系依然存在，下次登录RTM服务后不需要重新加入群组
  • 成员离线期间的未读群组消息可以查询
  • 成员可以接受到群组的离线推送通知

群组和房间的区别，请参考：基本概念-房间

功能详情

群组消息发送和接收

使用RTM客户端SDK和RTM服务端SDK发送和接收群组消息，请参考：

获取群组历史消息记录

使用RTM客户端SDK和RTM服务端SDK获取群组历史消息记录，请参考:

获取群组未读消息数量

使用RTM客户端SDK和RTM服务端SD 获取群组未读消息数量，请参考:

添加群组成员

使用RTM客户端SDK和RTM服务端SDK添加群组成员

删除群组成员

使用RTM客户端SDK和RTM服务端SDK删除群组成员

获取群组成员列表

使用RTM客户端SDK和RTM服务端SDK获取群组成员列表和当前在线成员列表

使用RTM客户端SDK获取群组成员列表和当前在线成员列表时，当前登录RTM客户端SDK用户必须为群组成员。

获取群组成员数量

使用RTM客户端SDK和RTM服务端SDK获取群组成员数量情况

判断用户的群组关系

使用RTM服务端SDK获取某用户和某群组的从属关系情况

获取用户所在群组

使用RTM客户端SDK和RTM服务端SDK获取某用户加入的全部群组情况

设置群组信息

群组信息包括群组公有信息和群组私有信息：

  • 公有信息是群组的公开信息，任何项目中的成员都可以获取。群组公有信息 包括：群组名称、群组图标等内容。
  • 私有信息是群组的非公开信息，仅允许群组成员才可以获取。群组私有信息 包括：群组公告、群组文件等内容。

使用RTM客户端SDK和RTM服务端SDK设置群组信息

使用RTM客户端SDK设置群组信息时，当前登录RTM客户端SDK用户必须为群组成员。

获取群组信息

使用RTM客户端SDK和RTM服务端SDK获取群组信息

使用RTM客户端SDK获取群组私有信息时，当前登录RTM客户端SDK用户必须为群组成员。

删除群组

使用RTM客户端SDK和RTM服务端SDK删除群组

使用RTM客户端SDK删除群组时，当前登录RTM客户端SDK用户必须为群组成员。

设置群组禁言

被群组禁言的用户无法在群组中发言。 使用RTM客户端SDK和RTM服务端SDK设置群组禁言

使用群组禁言功能时，需要提前为项目将 “允许群组禁言” 开关开启，请参考：控制台操作-RTM项目创建和配置-设置项目信息。

解除群组禁言

被群组禁言的用户解禁后，可以在群组中发言。 使用RTM客户端SDK和RTM服务端SDK解除群组禁言

使用解除群组禁言功能时，需要提前为项目将 “允许群组禁言” 开关开启，请参考：控制台操作-RTM项目创建和配置-设置项目信息。

判断用户禁言情况

使用RTM客户端SDK和RTM服务端SDK判断用户在群组是否被禁言

  • 使用 RTM客户端SDK 判断用户禁言情况时，当前登录 RTM客户端SDK 用户和判断的用户必须为群组成员。
  • 使用 判断用户禁言 功能时，需要提前为项目将 “允许群组禁言” 开关开启，请参考：控制台操作-RTM项目创建和配置-设置项目信息。