IMSDK
即时通信 IM 提供全球接入、单聊、群聊、消息推送、资料关系链托管、账号鉴权等全方位解决方案,并提供完备的 App 接入、后台管理接口。
V2TIMGroupInfo

Public 成员函数

 V2TIMGroupInfo ()
 
String getGroupID ()
 
void setGroupID (String groupID)
 
String getGroupType ()
 
void setGroupType (String groupType)
 
void setSupportTopic (boolean supportTopic)
 
boolean isSupportTopic ()
 
String getGroupName ()
 
void setGroupName (String groupName)
 
String getNotification ()
 
void setNotification (String notification)
 
String getIntroduction ()
 
void setIntroduction (String introduction)
 
String getFaceUrl ()
 
void setFaceUrl (String faceUrl)
 
boolean isAllMuted ()
 
void setAllMuted (boolean isAllMuted)
 
String getOwner ()
 
long getCreateTime ()
 
int getGroupAddOpt ()
 
void setGroupAddOpt (int addOpt)
 
int getGroupApproveOpt ()
 
void setGroupApproveOpt (int approveOpt)
 
void setCustomInfo (Map< String, byte[]> customInfoMap)
 
Map< String, byte[]> getCustomInfo ()
 
long getLastInfoTime ()
 
long getLastMessageTime ()
 
int getMemberCount ()
 
int getOnlineCount ()
 
long getMemberMaxCount ()
 
int getRole ()
 
int getRecvOpt ()
 
long getJoinTime ()
 
boolean isEnablePermissionGroup ()
 
void setEnablePermissionGroup (boolean enablePermissionGroup)
 
long getDefaultPermissions ()
 
void setDefaultPermissions (long defaultPermissions)
 

静态 Public 属性

static final int V2TIM_GROUP_ADD_FORBID = 0
 
static final int V2TIM_GROUP_ADD_AUTH = 1
 
static final int V2TIM_GROUP_ADD_ANY = 2
 

构造及析构函数说明

◆ V2TIMGroupInfo()

V2TIMGroupInfo ( )
inline

成员函数说明

◆ getGroupID()

String getGroupID ( )
inline

获取群组 ID

返回
群组 ID

◆ setGroupID()

void setGroupID ( String  groupID)
inline

设置群组 ID,只能在创建群或者修改群信息的时候设置。

注意
自定义群组 ID 必须为可打印 ASCII 字符(0x20-0x7e),最长48个字节,且前缀不能为 @TGS(避免与默认分配的群组 ID 混淆)
参数
groupID群组 ID

◆ getGroupType()

String getGroupType ( )
inline

获取群组类型

返回
群组类型

◆ setGroupType()

void setGroupType ( String  groupType)
inline

设置群组 类型,只能在创建群的时候设置。

参数
groupType群组类型

◆ setSupportTopic()

void setSupportTopic ( boolean  supportTopic)
inline

设置社群是否支持创建话题。仅在群类型为 Community 时有效

◆ isSupportTopic()

boolean isSupportTopic ( )
inline

获取社群是否支持创建话题。仅在群类型为 Community 时有效

◆ getGroupName()

String getGroupName ( )
inline

获取群组名称

返回
群组名称

◆ setGroupName()

void setGroupName ( String  groupName)
inline

设置群组名称,创建群和修改群信息都可以设置

注意
群名称最长 100 字节,使用 UTF-8 编码
参数
groupName群组名称

◆ getNotification()

String getNotification ( )
inline

获取群公告

◆ setNotification()

void setNotification ( String  notification)
inline

设置群公告,创建群和修改群信息都可以设置

注意
群公告最长 400 字节,使用 UTF-8 编码
参数
notification群公告

◆ getIntroduction()

String getIntroduction ( )
inline

获取群简介

◆ setIntroduction()

void setIntroduction ( String  introduction)
inline

设置群简介,创建群和修改群信息都可以设置

注意
群简介最长 400 字节,使用 UTF-8 编码
参数
introduction群简介

◆ getFaceUrl()

String getFaceUrl ( )
inline

获取群头像URL

返回
群头像URL

◆ setFaceUrl()

void setFaceUrl ( String  faceUrl)
inline

设置群头像,创建群和修改群信息都可以设置

注意
群头像 URL 最长 500 字节,使用 UTF-8 编码
参数
faceUrl群头像

◆ isAllMuted()

boolean isAllMuted ( )
inline

获取当前群组是否设置了全员禁言

返回
true - 设置了全员禁言

◆ setAllMuted()

void setAllMuted ( boolean  isAllMuted)
inline

设置群组全员禁言,只能在修改群信息的时候设置

参数
isAllMuted是否全员禁言

◆ getOwner()

String getOwner ( )
inline

获取群主

返回
群主 ID

◆ getCreateTime()

long getCreateTime ( )
inline

获取群创建时间

返回
创建群组的 UTC 时间戳

◆ getGroupAddOpt()

int getGroupAddOpt ( )
inline

申请进群是否需要管理员审批

返回

◆ setGroupAddOpt()

void setGroupAddOpt ( int  addOpt)
inline

设置申请进群时管理员的审批选项,创建群和修改群信息都可以设置。 工作群(Work)默认值为 V2TIM_GROUP_ADD_FORBID,即默认不允许申请入群,您可以修改该字段打开申请入群方式。

  • V2TIM_GROUP_ADD_FORBID:不允许加群
  • V2TIM_GROUP_ADD_ANY:任何人都可以加群
  • V2TIM_GROUP_ADD_AUTH:加群需要群主或管理员审批
参数
addOpt申请加群时管理员审批选项

◆ getGroupApproveOpt()

int getGroupApproveOpt ( )
inline

邀请进群是否需要管理员审批 (从 7.1 版本开始支持)

返回

◆ setGroupApproveOpt()

void setGroupApproveOpt ( int  approveOpt)
inline

设置邀请进群时管理员的审批选项,创建群和修改群信息都可以设置。 除工作群(Work)之外的其他群类型默认值都为 V2TIM_GROUP_ADD_FORBID,即默认不允许邀请入群,您可以修改该字段打开邀请入群方式。 直播群、社群和话题默认不允许邀请入群,也不支持修改。

  • V2TIM_GROUP_ADD_FORBID:不允许加群
  • V2TIM_GROUP_ADD_ANY:任何人都可以加群
  • V2TIM_GROUP_ADD_AUTH:加群需要群主或管理员审批
参数
approveOpt邀请进群时管理员审批选项

◆ setCustomInfo()

void setCustomInfo ( Map< String, byte[]>  customInfoMap)
inline

设置群自定义字段需要两个步骤:

1.在 控制台 (功能配置 -> 群自定义字段) 配置群自定义字段的 key 值,Key 为 String 类型,长度不超过 16 字节。

2.调用 setGroupInfo 接口设置该字段,HashMap 对象的 value 长度不超过 512 字节。

注意
  • 该字段主要用于 V1 和 V2 版本的兼容,如果您直接使用的是 V2 版本的 API , 建议使用 initGroupAttributes 接口设置群属性,其设置更灵活(无需控制台配置),支持的存储也更大(最大支持 16K)。
  • 参数 customInfoMap 必须是 HashMap 对象。

◆ getCustomInfo()

Map<String, byte[]> getCustomInfo ( )
inline

获取群组自定义字段

◆ getLastInfoTime()

long getLastInfoTime ( )
inline

获取上次修改群信息的 UTC 时间戳

返回

◆ getLastMessageTime()

long getLastMessageTime ( )
inline

获取群最近一次发消息时间

返回

◆ getMemberCount()

int getMemberCount ( )
inline

获取已加入的群成员数量

返回

◆ getOnlineCount()

int getOnlineCount ( )
inline

获取在线的群成员数量(待废弃字段,请使用 getGroupOnlineMemberCount 接口获取群在线人数)

返回

◆ getMemberMaxCount()

long getMemberMaxCount ( )
inline

获取最多允许加入的群成员数量

注意
各类群成员人数限制详见: https://cloud.tencent.com/document/product/269/1502#.E7.BE.A4.E7.BB.84.E9.99.90.E5.88.B6.E5.B7.AE.E5.BC.82

◆ getRole()

int getRole ( )
inline

获取群成员角色,切换角色请调用 setGroupMemberRole 接口

返回
成员角色: V2TIMGroupMemberFullInfo.V2TIM_GROUP_MEMBER_UNDEFINED:非群成员 V2TIMGroupMemberFullInfo.V2TIM_GROUP_MEMBER_ROLE_MEMBER:普通成员 V2TIMGroupMemberFullInfo.V2TIM_GROUP_MEMBER_ROLE_ADMIN:群管理员 V2TIMGroupMemberFullInfo.V2TIM_GROUP_MEMBER_ROLE_OWNER:群主

◆ getRecvOpt()

int getRecvOpt ( )
inline

当前用户在此群组中的消息接收选项,修改群消息接收选项请调用 setReceiveMessageOpt 接口

返回
消息接收选项: V2TIMMessage.V2TIM_RECEIVE_MESSAGE, V2TIMMessage.V2TIM_NOT_RECEIVE_MESSAGE, V2TIMMessage.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE V2TIMMessage.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE_EXCEPT_AT

◆ getJoinTime()

long getJoinTime ( )
inline

获取当前用户在此群中的加入时间,不支持设置,系统自动生成

返回
加群的 UTC 时间戳,单位s。

◆ isEnablePermissionGroup()

boolean isEnablePermissionGroup ( )
inline

开启权限组功能,仅支持社群,7.8 版本开始支持

◆ setEnablePermissionGroup()

void setEnablePermissionGroup ( boolean  enablePermissionGroup)
inline

开启权限组功能,仅支持社群,7.8 版本开始支持

注意
开启后,管理员角色的权限失效,用群权限、话题权限和权限组能力来对社群、话题进行管理。

◆ getDefaultPermissions()

long getDefaultPermissions ( )
inline

获取默认群权限,仅支持社群,7.8 版本开始支持

◆ setDefaultPermissions()

void setDefaultPermissions ( long  defaultPermissions)
inline

设置默认群权限,仅支持社群,7.8 版本开始支持

注意
群成员在没有加入任何权限组时的默认权限,仅在 enablePermissionGroup = true 打开权限组之后生效

结构体成员变量说明

◆ V2TIM_GROUP_ADD_FORBID

final int V2TIM_GROUP_ADD_FORBID = 0
static

禁止加群

◆ V2TIM_GROUP_ADD_AUTH

final int V2TIM_GROUP_ADD_AUTH = 1
static

需要管理员审批

◆ V2TIM_GROUP_ADD_ANY

final int V2TIM_GROUP_ADD_ANY = 2
static

任何人可以加入