IMSDK
IM features a comprehensive suite of solutions including global access, one-to-one chat, group chat, message push, profile and relationship chain hosting, and account authentication. It also provides complete app access and backend management APIs.
V2TIMGroupInfo

Properties

NSString * groupID
 
NSString * groupType
 
NSString * groupName
 
NSString * notification
 
NSString * introduction
 
NSString * faceURL
 
BOOL allMuted
 
NSDictionary< NSString *, NSData * > * customInfo
 
NSString * owner
 
uint32_t createTime
 
V2TIMGroupAddOpt groupAddOpt
 
uint32_t lastInfoTime
 
uint32_t lastMessageTime
 
uint32_t memberCount
 
uint32_t onlineCount
 
uint32_t memberMaxCount
 
uint32_t role
 
V2TIMReceiveMessageOpt recvOpt
 
uint32_t joinTime
 

Property Documentation

◆ groupID

- (NSString*) groupID
readwritenonatomicstrong

Group ID

Attention
The custom group ID must be printable ASCII characters (0x20-0x7e) with a maximum length of 48 bytes. It cannot begin with @TGS# so as to avoid confusion with the default group IDs assigned by IM.

◆ groupType

- (NSString*) groupType
readwritenonatomicstrong

Group type.

◆ groupName

- (NSString*) groupName
readwritenonatomicstrong

Group name

Attention
The maximum length of the group name is 30 bytes.

◆ notification

- (NSString*) notification
readwritenonatomicstrong

Group notice

Attention
The maximum length of the group notice is 300 bytes.

◆ introduction

- (NSString*) introduction
readwritenonatomicstrong

Group introduction

Attention
The maximum length of the group introduction is 240 bytes.

◆ faceURL

- (NSString*) faceURL
readwritenonatomicstrong

Group profile photo URL

Attention
The maximum length of the group profile photo URL is 100 bytes.

◆ allMuted

- (BOOL) allMuted
readwritenonatomicassign

Whether to mute all group members.

◆ customInfo

- (NSDictionary<NSString *,NSData *>*) customInfo
readwritenonatomicstrong

Get custom group fields To set a custom group field, perform the following steps:

1. Go to the console (Feature Configuration -> Custom Group Field) to set the key value of the custom group field. The key field is of the String type, with a maximum length of 16 bytes.

2. Call the setGroupInfo API to set the field. The field value is of the NSData type, with a maximum length of 512 bytes.

Attention
This field is mainly used for compatibility with V1 and V2. If you are using V2 APIs, you are advised to use the initGroupAttributes API to set group attributes because the API is more flexible (requiring no configuration in the console) and supports a larger storage capacity (up to 16 KB). You are advised to use the initGroupAttributes API to set group attributes because the API is more flexible (requiring no configuration in the console) and supports a larger storage capacity (up to 16 KB).

◆ owner

- (NSString*) owner
readnonatomicstrong

Group owner ID.

◆ createTime

- (uint32_t) createTime
readnonatomicassign

Group creation time.

◆ groupAddOpt

- (V2TIMGroupAddOpt) groupAddOpt
readwritenonatomicassign

Group joining approval type

Attention
This operation can be performed only during group creation or group information modification and applies only to public groups.

◆ lastInfoTime

- (uint32_t) lastInfoTime
readnonatomicassign

Latest group data modification time of the group.

◆ lastMessageTime

- (uint32_t) lastMessageTime
readnonatomicassign

Last time the group sends a message.

◆ memberCount

- (uint32_t) memberCount
readnonatomicassign

Number of members that have joined the group.

◆ onlineCount

- (uint32_t) onlineCount
readnonatomicassign

Number of online group members.

◆ memberMaxCount

- (uint32_t) memberMaxCount
readnonatomicassign

Maximum number of group members allowed to join

Attention
For details on the number of members allowed for each group type, please see: https://intl.cloud.tencent.com/document/product/1047/33529 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

◆ role

- (uint32_t) role
readnonatomicassign

Group member role of current user(V2TIMGroupMemberRole). To switch the role, please call the setGroupMemberRole API.

◆ recvOpt

- (V2TIMReceiveMessageOpt) recvOpt
readnonatomicassign

Current user's message receiving option in the group. To modify the group message receiving option, please call the setGroupReceiveMessageOpt API.

◆ joinTime

- (uint32_t) joinTime
readnonatomicassign

Time when the current user joins the group. The time is automatically generated by the system and cannot be set.