V2TimGroupInfo
Introduction
The group profile information.
Parameter introduction
groupID
Parameter type : String
Supported Platform: All
- Parameter description : The group ID.
A custom group ID must be a string of ASCII characters (0x20-0x7e) with a length less than 48 bytes. Do not use @TGS# as the prefix to avoid confusion with assigned group IDs.
groupType
Parameter type : String
Supported Platform: All
- Parameter description : The group type.
groupName
Parameter type : String
Supported Platform: All
- Parameter description : The name of the group.
notification
Parameter type : String
Supported Platform: All
- Parameter description : The notification of the group.
The maximum length is 300 bytes .
introduction
Parameter type : String
Supported Platform: All
- Parameter description : The introduction of the group.
The maximum length is 240 bytes.
faceUrl
Parameter type : String
Supported Platform: All
- Parameter description : URL of the group's profile photo.
The maximum length is 100 bytes.
isAllMuted
Parameter type : bool
Supported Platform: All
- Parameter description : Is all muted.
isSupportTopic
Parameter type : bool
Supported Platform: All
- Parameter description : Is allow to create sub-topic for Community.
Only works when group type is Community.
owner
Parameter type : String
Supported Platform: All
- Parameter description : The ID of the group owner.
createTime
Parameter type : int
Supported Platform: All
- Parameter description : The creation time of the group.
groupAddOpt
Parameter type : int
Supported Platform: All
- Parameter description : Is necessary to be approved by the administrators, when users tend to enter the group. Do not works for Work group, as it can only added by invited.
lastInfoTime
Parameter type : int
Supported Platform: All
- Parameter description : The latest time the group info has been updated.
lastMessageTime
Parameter type : int
Supported Platform: All
- Parameter description : The latest time the of message in group.
memberCount
Parameter type : int
Supported Platform: All
- Parameter description : The member count of the group.
onlineCount
Parameter type : int
Supported Platform: All
- Parameter description : The online member count of the group.
role
Parameter type : int
Supported Platform: All
- Parameter description : The role of the current user in this group, changing the role by setGroupMemberRole.
recvOpt
Parameter type : int
Supported Platform: All
- Parameter description : The message receiving options for the current user in this group, changing it by setGroupMemberRole.
joinTime
Parameter type : int
Supported Platform: All
- Parameter description : The time indicating when the current user joined the group, and cannot be modified.
customInfo
Parameter type : Map< String, String >
Supported Platform: All
- Parameter description : The custom data of the group.
The following two steps to use it:
Config the key for the custom field on IM console,
Custom Group Field
. The key needs to beString
, and can not larger than 16 bytes.Customized this field by
setGroupInfo
, while the length can not be larger than 512 bytes.
toJson
Parameter type : Map< String, dynamic > toJson()
Supported Platform: All
- Parameter description : Get the result in Map format.