Group

Group

群组对象,用于描述群组具有的属性,如类型、群组公告、创建时间等。
注意1:支持社群。
注意2:支持在社群中创建话题。创建话题请参见 createTopicInCommunity
注意3:支持邀请加群选项(直播群不支持),关于 joinOptioninviteOption 的区别如下:

  • joinOption 主要用于控制用户主动申请加群,比如群主/群管理员将群组 joinOption 设置为 TencentCloudChat.TYPES.JOIN_OPTIONS_NEED_PERMISSION ,用户发起 加群 请求时,需要等待群主/群管理员审批后才能加入群组。
  • inviteOption 主要用于控制群成员邀请其他用户进群,比如群主/群管理员将群组 inviteOption 设置为 TencentCloudChat.TYPES.INVITE_OPTIONS_NEED_PERMISSION,群成员发起 邀请加群 请求时,需要等待群主/群管理员审批后被邀请人才能进入群组。
  • inviteOption 设置为 TencentCloudChat.TYPES.INVITE_OPTIONS_NEED_PERMISSION 时,群主/群管理员仍可以直接邀请用户进群。
  • inviteOption 设置为 TencentCloudChat.TYPES.INVITE_OPTIONS_DISABLE_INVITE 时,群主/群管理员也不能邀请用户进群。
Properties:
Name Type Description
groupID String

群组的唯一标识,群组 ID,App 内保证唯一,普通群和直播群的格式前缀为 @TGS#,社群的格式前缀为 @TGS#。另外,App 亦可自定义群组 ID,社群自定义群组 ID 必须以 @TGS# 为前缀。

name String

群组名称,最长100字节,使用 UTF-8 编码,1个汉字占3个字节,不可调整

avatar String

群组头像 URL,最长500字节,不可调整

type String

群组类型,当前 SDK 支持的类型如下:

类型 含义
TencentCloudChat.TYPES.GRP_WORK 好友工作群
TencentCloudChat.TYPES.GRP_PUBLIC 陌生人社交群
TencentCloudChat.TYPES.GRP_MEETING 临时会议群
TencentCloudChat.TYPES.GRP_AVCHATROOM 直播群
TencentCloudChat.TYPES.GRP_COMMUNITY 社群
introduction String

群组简介,最长400字节,使用 UTF-8 编码,1个汉字占3个字节,不可调整

notification String

群组公告,最长400字节,使用 UTF-8 编码,1个汉字占3个字节,不可调整

ownerID String

群主 ID

createTime Number

群组的创建时间

infoSequence Number

群资料的每次变都会增加该值

lastInfoTime Number

群组最后一次信息变更时间

selfInfo Object

当前用户在群组中的信息

Properties
Name Type Description
role String

角色

messageRemindType String

消息提醒类型

  • TencentCloudChat.TYPES.MSG_REMIND_ACPT_AND_NOTE 在线正常接收消息,离线时会有厂商的离线推送通知(Web 和小程序端无离线推送)
  • TencentCloudChat.TYPES.MSG_REMIND_DISCARD 在线和离线都拒收消息
  • TencentCloudChat.TYPES.MSG_REMIND_ACPT_NOT_NOTE 在线正常接收消息,离线不会有推送通知(消息免打扰)
  • TencentCloudChat.TYPES.NOT_RECEIVE_OFFLINE_PUSH_EXCEPT_AT 在线接收消息,离线仅接收群 @消息 的推送
joinTime Number

入群时间

nameCard String

群名片

userID String

当前用户的 userID

memberCustomField Array

当前用户的群成员自定义字段

lastMessage Object

群组最后一条消息。注意:若会话列表中没有该群组,则该对象只有 lastTime 有值,其他值为空。

Properties
Name Type Description
lastTime Number

群组最后一条消息的时间戳,单位:秒

lastSequence Number

当前群组类型会话的最新消息的 Seq

fromAccount Number

群组最后一条消息的来源用户

messageForShow Number

用于展示的群组最后一条消息的简要内容,文本则展示原内容,图片则展示“[图片]”。

nextMessageSeq Number

群内下一条消息的 Seq,群组内每一条消息都有一条唯一的消息 Seq,且该 Seq 是按照发消息顺序而连续的。从 1 开始,群内每增加一条消息,nextMessageSeq 就会增加 1

memberNum Number

Deprecated: 当前成员数量

memberCount Number

当前成员数量

maxMemberNum Number

Deprecated: 最大成员数量

maxMemberCount Number

最大成员数量

muteAllMembers Boolean

设置全体禁言,true 表示全体禁言,false 表示取消全体禁言

joinOption String

申请加群选项。

  • TencentCloudChat.TYPES.JOIN_OPTIONS_FREE_ACCESS(自由加入,直播群固定为该值)
  • TencentCloudChat.TYPES.JOIN_OPTIONS_NEED_PERMISSION(需要验证)
  • TencentCloudChat.TYPES.JOIN_OPTIONS_DISABLE_APPLY(禁止加群,好友工作群固定为该值)
inviteOption String

邀请进群选项(直播群不支持 inviteOption)。

  • TencentCloudChat.TYPES.INVITE_OPTIONS_FREE_ACCESS(无需审批直接邀请进群)
  • TencentCloudChat.TYPES.INVITE_OPTIONS_NEED_PERMISSION(需要群主/群管理员验证)
  • TencentCloudChat.TYPES.INVITE_OPTIONS_DISABLE_INVITE(禁止邀请)
groupCustomField Array.<Object>

群组自定义字段。默认情况是没有的。开通群组维度的自定义字段详情请参见 自定义字段

Properties
Name Type Description
key String

群组自定义字段的 Key

value String

群组自定义字段的 Value

isSupportTopic Boolean

社群是否支持话题。创建支持话题的社群请参见 createGroup