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

群资料

功能描述

群资料指的是与群组相关的一些信息,相关方法在核心类 TencentImSDKPlugin.v2TIMManager.getGroupManager()中。


获取群资料

您可以调用 getGroupsInfo (Details) 获取群资料。该接口支持一次传入多个 groupID,批量获取多个群的群资料。
代码示例如下:
// 获取群资料
const groupinfos = await groupManager.getGroupsInfo(["groupid1"]);


修改群资料

您可以调用 setGroupInfo (Details) 修改群资料。
如果您事先调用 addGroupListener 添加了群组事件监听器,群资料被修改后,全员会收到 onGroupInfoChanged (Details) 回调。
不同类型的群组,可以修改群资料的成员角色不同:
群组类型
可以修改群基础资料的成员角色
好友工作群(Work)
所有群成员
陌生人社交群(Public)
群主和管理员
临时会议群(Meeting)
群主和管理员
社群(Community)
群主和管理员
直播群(AVChatRoom)
群主
示例代码如下:
groupManager.setGroupInfo({
groupAddOpt: GroupAddOptTypeEnum.V2TIM_GROUP_ADD_AUTH,
// ...其他资料
});
// 回调
TencentImSDKPlugin.v2TIMManager.addGroupListener({
onGroupInfoChanged: (groupID, changeInfos) => {
// 群信息更改回调
},
});

设置群消息的接收选项

任何群成员都可以调用 setGroupReceiveMessageOpt (Details) 接口修改群消息接收选项。
V2TIMReceiveMessageOpt 的可选项有:
消息接收选项
含义
ReceiveMsgOptEnum.V2TIM_RECEIVE_MESSAGE
在线正常接收消息,离线时会有厂商的离线推送通知。
ReceiveMsgOptEnum.V2TIM_NOT_RECEIVE_MESSAGE
不会接收到群消息。
ReceiveMsgOptEnum.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE
在线正常接收消息,离线不会有推送通知。
使用不同的 V2TIMReceiveMessageOpt 可以实现群消息免打扰:
完全不接收群内消息 群消息接收选项设置为 V2TIM_NOT_RECEIVE_MESSAGE 后,群内的任何消息都收不到,会话列表也不会更新。
接收群内消息但不提醒,在会话列表界面显示小圆点(不显示未读数)
1. 群消息接收选项设置为 V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE
2. 当群内收到新消息,会话列表需要更新时,可以通过会话 V2TIMConversation 中的 unreadCount (Details) 获取到消息未读数。
3. 根据 V2TIMConversationrecvOpt (Details) 判断获取到的群消息接收选项为 V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE 时显示小红点而非消息未读数。
说明:
此方式需使用未读计数功能,因此仅适用于好友工作群(Work)和陌生人社交群(Public)。
示例代码如下:
// 社会群接收消息选项
groupManager.setGroupInfo({
groupAddOpt: GroupAddOptTypeEnum.V2TIM_GROUP_ADD_AUTH,
});