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

Public 成员函数

 V2TIMGroupInfo ()
 
String getGroupID ()
 
void setGroupID (String groupID)
 
String getGroupType ()
 
void setGroupType (String groupType)
 
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)
 
void setCustomInfo (Map< String, byte[]> customInfoMap)
 
Map< String, byte[]> getCustomInfo ()
 
long getLastInfoTime ()
 
long getLastMessageTime ()
 
int getMemberCount ()
 
int getOnlineCount ()
 
int getRole ()
 
int getRecvOpt ()
 
long getJoinTime ()
 

静态 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
 
static final int V2TIM_GROUP_RECEIVE_MESSAGE = 0
 
static final int V2TIM_GROUP_NOT_RECEIVE_MESSAGE = 1
 
static final int V2TIM_GROUP_RECEIVE_NOT_NOTIFY_MESSAGE = 2
 

构造及析构函数说明

◆ V2TIMGroupInfo()

V2TIMGroupInfo ( )
inline

成员函数说明

◆ getGroupID()

String getGroupID ( )
inline

获取群组 ID

返回
群组 ID

◆ setGroupID()

void setGroupID ( String  groupID)
inline

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

参数
groupID群组 ID

◆ getGroupType()

String getGroupType ( )
inline

获取群组类型

返回
群组类型

◆ setGroupType()

void setGroupType ( String  groupType)
inline

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

参数
groupType群组类型

◆ getGroupName()

String getGroupName ( )
inline

获取群组名称

返回
群组名称

◆ setGroupName()

void setGroupName ( String  groupName)
inline

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

参数
groupName群组名称

◆ getNotification()

String getNotification ( )
inline

获取群公告

◆ setNotification()

void setNotification ( String  notification)
inline

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

参数
notification群公告

◆ getIntroduction()

String getIntroduction ( )
inline

获取群简介

◆ setIntroduction()

void setIntroduction ( String  introduction)
inline

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

参数
introduction群简介

◆ getFaceUrl()

String getFaceUrl ( )
inline

获取群头像URL

返回
群头像URL

◆ setFaceUrl()

void setFaceUrl ( String  faceUrl)
inline

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

参数
faceUrl群头像

◆ isAllMuted()

boolean isAllMuted ( )
inline

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

返回
true - 设置了全员禁言

◆ setAllMuted()

void setAllMuted ( boolean  isAllMuted)
inline

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

参数
isAllMuted是否全员禁言

◆ getOwner()

String getOwner ( )
inline

获取群主

返回
群主 ID

◆ getCreateTime()

long getCreateTime ( )
inline

获取群创建时间

返回
群创建时间

◆ getGroupAddOpt()

int getGroupAddOpt ( )
inline

获取加群审批类型。

返回

◆ setGroupAddOpt()

void setGroupAddOpt ( int  addOpt)
inline

设置加群选项,创建群和修改群信息都可以设置。只用于公开群(Public)

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

◆ setCustomInfo()

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

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

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

2.调用 setGroupInfo 接口设置该字段,value 为 NSData 数据,长度不超过 512 字节。

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

◆ getCustomInfo()

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

获取群组自定义字段

◆ getLastInfoTime()

long getLastInfoTime ( )
inline

获取群最近一次群资料修改时间

返回

◆ getLastMessageTime()

long getLastMessageTime ( )
inline

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

返回

◆ getMemberCount()

int getMemberCount ( )
inline

获取群成员总数量

注意
请注意:
  • 频繁调用该接口会影响程序性能,如果仅需获取群在线人数,推荐使用V2TIMManager.getGroupManager().getGroupOnlineMemberCount(groupID, callback)接口;
返回

◆ getOnlineCount()

int getOnlineCount ( )
inline

获取在线成员数量

返回

◆ 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 接口

返回
消息接收选项: V2TIM_GROUP_RECEIVE_MESSAGE, V2TIM_GROUP_NOT_RECEIVE_MESSAGE, V2TIM_GROUP_RECEIVE_NOT_NOTIFY_MESSAGE

◆ getJoinTime()

long getJoinTime ( )
inline

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

返回
加群时间,单位s。

结构体成员变量说明

◆ 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

任何人可以加入

◆ V2TIM_GROUP_RECEIVE_MESSAGE

final int V2TIM_GROUP_RECEIVE_MESSAGE = 0
static

在线正常接收消息,离线时会进行厂商离线推送

◆ V2TIM_GROUP_NOT_RECEIVE_MESSAGE

final int V2TIM_GROUP_NOT_RECEIVE_MESSAGE = 1
static

不会接收到群消息

◆ V2TIM_GROUP_RECEIVE_NOT_NOTIFY_MESSAGE

final int V2TIM_GROUP_RECEIVE_NOT_NOTIFY_MESSAGE = 2
static

在线正常接收消息,离线不会有推送通知