V2TIMGroupManager

Detailed Description

Advanced group APIs, including APIs for advanced group features such as group member invitation and group joining request

Public Member Functions
virtual	~V2TIMGroupManager ()
virtual void	CreateGroup (const V2TIMGroupInfo &info, const V2TIMCreateGroupMemberInfoVector &memberList, V2TIMValueCallback< V2TIMString > *callback)=0
virtual void	GetJoinedGroupList (V2TIMValueCallback< V2TIMGroupInfoVector > *callback)=0
virtual void	GetGroupsInfo (const V2TIMStringVector &groupIDList, V2TIMValueCallback< V2TIMGroupInfoResultVector > *callback)=0
virtual void	SearchGroups (const V2TIMGroupSearchParam &searchParam, V2TIMValueCallback< V2TIMGroupInfoVector > *callback)=0
virtual void	SetGroupInfo (const V2TIMGroupInfo &info, V2TIMCallback *callback)=0
virtual void	InitGroupAttributes (const V2TIMString &groupID, const V2TIMGroupAttributeMap &attributes, V2TIMCallback *callback)=0
virtual void	SetGroupAttributes (const V2TIMString &groupID, const V2TIMGroupAttributeMap &attributes, V2TIMCallback *callback)=0
virtual void	DeleteGroupAttributes (const V2TIMString &groupID, const V2TIMStringVector &keys, V2TIMCallback *callback)=0
virtual void	GetGroupAttributes (const V2TIMString &groupID, const V2TIMStringVector &keys, V2TIMValueCallback< V2TIMGroupAttributeMap > *callback)=0
virtual void	GetGroupOnlineMemberCount (const V2TIMString &groupID, V2TIMValueCallback< uint32_t > *callback)=0
virtual void	SetGroupCounters (const V2TIMString &groupID, const V2TIMStringToInt64Map &counters, V2TIMValueCallback< V2TIMStringToInt64Map > *callback)=0
virtual void	GetGroupCounters (const V2TIMString &groupID, const V2TIMStringVector &keys, V2TIMValueCallback< V2TIMStringToInt64Map > *callback)=0
virtual void	IncreaseGroupCounter (const V2TIMString &groupID, const V2TIMString &key, int64_t value, V2TIMValueCallback< V2TIMStringToInt64Map > *callback)=0
virtual void	DecreaseGroupCounter (const V2TIMString &groupID, const V2TIMString &key, int64_t value, V2TIMValueCallback< V2TIMStringToInt64Map > *callback)=0
virtual void	GetGroupMemberList (const V2TIMString &groupID, uint32_t filter, uint64_t nextSeq, V2TIMValueCallback< V2TIMGroupMemberInfoResult > *callback)=0
virtual void	GetGroupMembersInfo (const V2TIMString &groupID, V2TIMStringVector memberList, V2TIMValueCallback< V2TIMGroupMemberFullInfoVector > *callback)=0
virtual void	SearchGroupMembers (const V2TIMGroupMemberSearchParam &param, V2TIMValueCallback< V2TIMGroupSearchGroupMembersMap > *callback)=0
virtual void	SetGroupMemberInfo (const V2TIMString &groupID, const V2TIMGroupMemberFullInfo &info, V2TIMCallback *callback)=0
virtual void	MuteGroupMember (const V2TIMString &groupID, const V2TIMString &userID, uint32_t seconds, V2TIMCallback *callback)=0
virtual void	MuteAllGroupMembers (const V2TIMString &groupID, bool isMute, V2TIMCallback *callback)=0
virtual void	InviteUserToGroup (const V2TIMString &groupID, const V2TIMStringVector &userList, V2TIMValueCallback< V2TIMGroupMemberOperationResultVector > *callback)=0
virtual void	KickGroupMember (const V2TIMString &groupID, const V2TIMStringVector &memberList, const V2TIMString &reason, uint32_t duration, V2TIMValueCallback< V2TIMGroupMemberOperationResultVector > *callback)=0
virtual void	SetGroupMemberRole (const V2TIMString &groupID, const V2TIMString &userID, uint32_t role, V2TIMCallback *callback)=0
virtual void	MarkGroupMemberList (const V2TIMString &groupID, const V2TIMStringVector &memberList, uint32_t markType, bool enableMark, V2TIMCallback *callback)=0
virtual void	TransferGroupOwner (const V2TIMString &groupID, const V2TIMString &userID, V2TIMCallback *callback)=0
virtual void	KickGroupMember (const V2TIMString &groupID, const V2TIMStringVector &memberList, const V2TIMString &reason, V2TIMValueCallback< V2TIMGroupMemberOperationResultVector > *callback)=0
virtual void	GetGroupApplicationList (V2TIMValueCallback< V2TIMGroupApplicationResult > *callback)=0
virtual void	AcceptGroupApplication (const V2TIMGroupApplication &application, const V2TIMString &reason, V2TIMCallback *callback)=0
virtual void	RefuseGroupApplication (const V2TIMGroupApplication &application, const V2TIMString &reason, V2TIMCallback *callback)=0
virtual void	SetGroupApplicationRead (V2TIMCallback *callback)=0
virtual void	GetJoinedCommunityList (V2TIMValueCallback< V2TIMGroupInfoVector > *callback)=0
virtual void	CreateTopicInCommunity (const V2TIMString &groupID, const V2TIMTopicInfo &topicInfo, V2TIMValueCallback< V2TIMString > *callback)=0
virtual void	DeleteTopicFromCommunity (const V2TIMString &groupID, const V2TIMStringVector &topicIDList, V2TIMValueCallback< V2TIMTopicOperationResultVector > *callback)=0
virtual void	SetTopicInfo (const V2TIMTopicInfo &topicInfo, V2TIMCallback *callback)=0
virtual void	GetTopicInfoList (const V2TIMString &groupID, const V2TIMStringVector &topicIDList, V2TIMValueCallback< V2TIMTopicInfoResultVector > *callback)=0

Constructor & Destructor Documentation

~V2TIMGroupManager()

virtual ~V2TIMGroupManager ( )

inlinevirtual

Member Function Documentation

CreateGroup()

virtual void CreateGroup ( const V2TIMGroupInfo &  info, const V2TIMCreateGroupMemberInfoVector &  memberList, V2TIMValueCallback< V2TIMString > *  callback  )

pure virtual

1.1 Create a custom group (the advanced version API allows you to specify initial group members)

Parameters

info	Custom group information, including the groupID, groupType, groupName, notification, introduction, and faceURL fields
memberList	Specify initial group members (Audio-video groups do not support specifying initial group members. Pass in null for memberList.)

Attention

• Limited by backgroud service, the number of memberList must be less than or equal to 20.
• For other limits, please see V2TIMManager.h -> CreateGroup remarks

GetJoinedGroupList()

virtual void GetJoinedGroupList ( V2TIMValueCallback< V2TIMGroupInfoVector > *  callback )

pure virtual

1.2 Get the list of groups that the current user has joined

Attention

• Audio-video groups (AVChatRoom) do not support this API.
• This API implements frequency limit checks. It can be called by the SDK for up to 10 times per second. When the limit is exceeded, the error ERR_SDK_COMM_API_CALL_FREQUENCY_LIMIT (7008) is reported.

GetGroupsInfo()

virtual void GetGroupsInfo ( const V2TIMStringVector &  groupIDList, V2TIMValueCallback< V2TIMGroupInfoResultVector > *  callback  )

pure virtual

2.1 Pull group profiles

Parameters

groupIDList

List of group IDs

SearchGroups()

virtual void SearchGroups ( const V2TIMGroupSearchParam &  searchParam, V2TIMValueCallback< V2TIMGroupInfoVector > *  callback  )

pure virtual

2.2 Search for group profiles (supported only in Chat Premium 5.4.666 and later versions)

This API will search all the groups whose group name is included in the keyword list specifed in searchParam and return the group profiles list. The keyword list supports up to 5 keywords.

Parameters

searchParam

Search parameters

SetGroupInfo()

virtual void SetGroupInfo ( const V2TIMGroupInfo &  info, V2TIMCallback *  callback  )

pure virtual

2.3 Modify group profiles

InitGroupAttributes()

virtual void InitGroupAttributes ( const V2TIMString &  groupID, const V2TIMGroupAttributeMap &  attributes, V2TIMCallback *  callback  )

pure virtual

2.4 Initialize group attributes (this operation will clear the existing group attribute list)

Attention

Use limits of attributes:：

• Group attribute is supported only for audio-video groups (AVChatRoom) by 6.7 and earlier versions.
• Group attribute is supported for 4 group types (AVChatRoom, Public, Meeting, Work groups) in 6.8 and later versions.
• Group attribute is supported for all group types except topics in 7.0 and later versions.
• Up to 16 keys are supported, with a length limit of 32 bytes.
• The length limit for value is 4 KB.
• The total length limit for attributes (including keys and values) is 16 KB.
• The combined SDK rate limit for the initGroupAttributes, setGroupAttributes, and deleteGroupAttributes APIs is 10 calls every 5 seconds. If the limit is exceeded, the 8511 error code will be returned. The combined backend rate limit for the APIs is 5 calls per second. If the limit is exceeded, the 10049 error code will be returned.
• The getGroupAttributes API can be called by the SDK for up to 20 times per 5 seconds.
• Starting from version 5.6, when you modify group attributes for the first time after the app is started, please call getGroupAttributes to pull the latest group attributes before you initiate the modification operation.
• Starting from version 5.6, when multiple users modify the same group attributes at the same time, only the first user can execute successfully, and other users will receive the 10056 error code. After receiving this error code, please call getGroupAttributes to update the locally stored group attributes to the latest before you initiate the modification operation.

SetGroupAttributes()

virtual void SetGroupAttributes ( const V2TIMString &  groupID, const V2TIMGroupAttributeMap &  attributes, V2TIMCallback *  callback  )

pure virtual

2.5 Set group attributes. (If the group attributes already exist, their values are updated. Otherwise, the group attributes are added.)

Attention

• Group attribute is supported only for audio-video groups (AVChatRoom) by 6.7 and earlier versions.
• Group attribute is supported for 4 group types (AVChatRoom, Public, Meeting, Work groups) in 6.8 and later versions.
• Group attribute is supported for all group types except topics in 7.0 and later versions.

DeleteGroupAttributes()

virtual void DeleteGroupAttributes ( const V2TIMString &  groupID, const V2TIMStringVector &  keys, V2TIMCallback *  callback  )

pure virtual

2.6 Delete specified group attributes (If size 0 is passed in for keys, all group attributes are cleared.)

Attention

• Group attribute is supported only for audio-video groups (AVChatRoom) by 6.7 and earlier versions.
• Group attribute is supported for 4 group types (AVChatRoom, Public, Meeting, Work groups) in 6.8 and later versions.
• Group attribute is supported for all group types except topics in 7.0 and later versions.

GetGroupAttributes()

virtual void GetGroupAttributes ( const V2TIMString &  groupID, const V2TIMStringVector &  keys, V2TIMValueCallback< V2TIMGroupAttributeMap > *  callback  )

pure virtual

2.7 Get specified group attributes (If size 0 is passed in for keys, all group attributes are obtained.)

Attention

• Group attribute is supported only for audio-video groups (AVChatRoom) by 6.7 and earlier versions.
• Group attribute is supported for 4 group types (AVChatRoom, Public, Meeting, Work groups) in 6.8 and later versions.
• Group attribute is supported for all group types except topics in 7.0 and later versions.

GetGroupOnlineMemberCount()

virtual void GetGroupOnlineMemberCount ( const V2TIMString &  groupID, V2TIMValueCallback< uint32_t > *  callback  )

pure virtual

2.8 Get the number of online members of a group

Attention

• This API is only supported by audio-video groups(AVChatRoom) before IMSDK 7.3 version.
• You can call this API for all kinds of groups in IMSDK 7.3 and later versions.

SetGroupCounters()

virtual void SetGroupCounters ( const V2TIMString &  groupID, const V2TIMStringToInt64Map &  counters, V2TIMValueCallback< V2TIMStringToInt64Map > *  callback  )

pure virtual

2.9 Set group counters (supported only in 7.0 and later versions)

Attention

• If the group counters already exist, their values will be updated. Otherwise, the group counters will be added.
• If the group counters are set successfully, their information will be returned via the OnSuccess callback.
• Group counter is supported for all group types except community and topics.

GetGroupCounters()

virtual void GetGroupCounters ( const V2TIMString &  groupID, const V2TIMStringVector &  keys, V2TIMValueCallback< V2TIMStringToInt64Map > *  callback  )

pure virtual

2.10 Get group counters (supported only in 7.0 and later versions)

Attention

• If keys is empty or nil, it means to obtain all counters in the group.
• Group counter is supported for all group types except community and topics.

IncreaseGroupCounter()

virtual void IncreaseGroupCounter ( const V2TIMString &  groupID, const V2TIMString &  key, int64_t  value, V2TIMValueCallback< V2TIMStringToInt64Map > *  callback  )

pure virtual

2.11 Increase group counters (supported only in 7.0 and later versions)

Parameters

groupID	Group ID
key	The key of counter
value	Increment of the group counter. The new value of the counter will be the old value plus this parameter (new_value = old_value + value).

Attention

• The callback will return the new value of the counter.
• If the key specified already exists, its value will be increased. Otherwise, a key whose value is 0 will be added first, and then the value will be increased as specified.
• Group counter is supported for all group types except community and topics.

DecreaseGroupCounter()

virtual void DecreaseGroupCounter ( const V2TIMString &  groupID, const V2TIMString &  key, int64_t  value, V2TIMValueCallback< V2TIMStringToInt64Map > *  callback  )

pure virtual

2.12 Decrease group counters (supported only in 7.0 and later versions)

Parameters

groupID	Group ID
key	The key of counter
value	Decrement of the group counter. The new value of the counter will be the old value minus this parameter (new_value = old_value - value).

Attention

• The callback will return the new value of the counter.
• If the key specified already exists, its value will be decreased. Otherwise, a key whose value is 0 will be added first, and then the value will be decreased as specified.
• Group counter is supported for all group types except community and topics.

GetGroupMemberList()

virtual void GetGroupMemberList ( const V2TIMString &  groupID, uint32_t  filter, uint64_t  nextSeq, V2TIMValueCallback< V2TIMGroupMemberInfoResult > *  callback  )

pure virtual

3.1 Get the group member list

Parameters

filter	Specify the group member type
nextSeq	Pulling-by-page flag. Pass in 0 when the information is pulled for the first time. If the nextSeq returned by the onSuccess callback is not 0, the results are paginated, and you need to pass in the nextSeq returned and pull again. Repeat until the nextSeq returned becomes 0.

Attention

• Restrictions for normal groups(Work, Meeting, Public):

1. The filter field can only be set to the value defined in V2TIMGroupMemberFilter, then you can get the members of the corresponding role.

• Restrictions for audio-video groups(AVChatRoom):

1. If you set the filter to the value defined in V2TIMGroupMemberFullInfo, you will get all the members. The maximum number of members that can be obtained is 1,000. Newer members will appear at the top of the list. To use this feature, you need to upgrade to the Premium edition(supported only in 6.3 and later versions) and turn on "List of online audio-video group members" in the Chat console.
2. If you set the filter to custom markType defined by yourself, you can get the members of the corresponding markType in the Premium edition. Please refer to the API markGroupMemberList to mark group members.
3. After the app is restarted, please join the group again. Otherwise, the 10007 error code will be reported when you pull the group member list.
4. Only the following fields are supported in group member profiles: userID, nickName, faceURL, and role.

• Restrictions for Community groups:

1. If you set the filter to the value defined in V2TIMGroupMemberFilter, you will get the the members of corresponding role.
2. If you set the filter to custom markType defined by yourself, you can get the members of the corresponding markType in the Premium Edition. Please refer to the API markGroupMemberList to mark group member list(supported only in 7.5 and later versions).

GetGroupMembersInfo()

virtual void GetGroupMembersInfo ( const V2TIMString &  groupID, V2TIMStringVector  memberList, V2TIMValueCallback< V2TIMGroupMemberFullInfoVector > *  callback  )

pure virtual

3.2 Get the profiles of specified group members

SearchGroupMembers()

virtual void SearchGroupMembers ( const V2TIMGroupMemberSearchParam &  param, V2TIMValueCallback< V2TIMGroupSearchGroupMembersMap > *  callback  )

pure virtual

3.3 Search for group members (supported only in Chat Premium 5.4.666 and later versions)

Parameters

param

Search parameters

SetGroupMemberInfo()

virtual void SetGroupMemberInfo ( const V2TIMString &  groupID, const V2TIMGroupMemberFullInfo &  info, V2TIMCallback *  callback  )

pure virtual

3.4 Modify the profiles of specified group members

MuteGroupMember()

virtual void MuteGroupMember ( const V2TIMString &  groupID, const V2TIMString &  userID, uint32_t  seconds, V2TIMCallback *  callback  )

pure virtual

3.5 Mute a specific group member (this API can be called by the admin or group owner)

Parameters

seconds

Time period (seconds) during which the specified user will be muted.

MuteAllGroupMembers()

virtual void MuteAllGroupMembers ( const V2TIMString &  groupID, bool  isMute, V2TIMCallback *  callback  )

pure virtual

3.6 Mute all group members (supported only in 7.5 and later versions)

Parameters

groupID	Group ID
isMute	true means mute, false means unmute

Attention

• Mute all group members indefinitely. You can set isMute to false to unmute all group members.
• All group members will receive onAllGroupMembersMuted notification after this API is called successfully.
• Only the group owner and admin can call this API.

InviteUserToGroup()

virtual void InviteUserToGroup ( const V2TIMString &  groupID, const V2TIMStringVector &  userList, V2TIMValueCallback< V2TIMGroupMemberOperationResultVector > *  callback  )

pure virtual

3.7 Invite users to a group

Attention

The limits for different types of groups are as follows:

• Work group (Work): Anyone in the group can invite others to the group.
• Meeting group (Meeting) and public group (Public): By default, users are not allowed to join the group through invitation. You can modify the groupApproveOpt field of V2TIMGroupInfo to open it. After that, all the group members can invite others to join the group.
• Audio-video group (AVChatRoom): Inviting users to a group is not supported.
• Limited by backgroud service, the number of userList must be less than or equal to 20.

KickGroupMember() [1/2]

virtual void KickGroupMember ( const V2TIMString &  groupID, const V2TIMStringVector &  memberList, const V2TIMString &  reason, uint32_t  duration, V2TIMValueCallback< V2TIMGroupMemberOperationResultVector > *  callback  )

pure virtual

3.8 Remove a member from a group

Parameters

groupID	Group ID
memberList	The list of members to remove
reason	The reason the member is removed
duration	Time interval during which the target users will not be allowed to join the group again after being kicked out of the group in seconds
callback	Callback

Attention

• You can specificy a time interval in seconds during which the target users will not be allowed to join the group again after being kicked out of the group from 7.2 version.
• Work group (Work): only the group owner or app admin can remove a member from a group.
• Meeting group (Meeting) and public group (Public): the group owner, group admin, and app admin can remove a member from a group.
• Audio-video group (AVChatRoom): only muting(muteGroupMember) is supported in versions prior to 6.6. Both muting(muteGroupMember) and kicking(kickGroupMember) are supported in 6.6 and later versions. You need to buy the Premium edition to use this feature.
• Please refer to the following link for other usage restrictions of this interface.

SetGroupMemberRole()

virtual void SetGroupMemberRole ( const V2TIMString &  groupID, const V2TIMString &  userID, uint32_t  role, V2TIMCallback *  callback  )

pure virtual

3.9 Set the role of a group member

Attention

The limits for different types of groups are as follows:

• Work group (Work) does not support setting group member roles.
• Only the group owner can switch the role of a group member between common member and admin.
• To transfer a group, please call the transferGroupOwner API.
• For a meeting group (Meeting), after a group member role is set, there will be no onGrantAdministrator or onRevokeAdministrator callback.
• Roles that can be set are common member (V2TIM_GROUP_MEMBER_ROLE_MEMBER) and admin (V2TIM_GROUP_MEMBER_ROLE_ADMIN).

MarkGroupMemberList()

virtual void MarkGroupMemberList ( const V2TIMString &  groupID, const V2TIMStringVector &  memberList, uint32_t  markType, bool  enableMark, V2TIMCallback *  callback  )

pure virtual

3.10 Mark group members (supported only by the Premium edition)

Parameters

groupID	Group's identifier.
memberList	Group member's identifier list.
markType	The mark type is uint32_t, and the value must be equal or greater than 1000. You can customize it. A maximum of 10 marks are allowed to be defined in a group.
enableMark	Set or remove. true means setting the mark, and false means removing the mark.

Attention

Attention please:

• Supported in Audio-video group (AVChatRoom) in 6.6 and later versions.
• Supported in Community group in 7.5 and later versions.
• Only the group owner has permission to mark other members in the group.

TransferGroupOwner()

virtual void TransferGroupOwner ( const V2TIMString &  groupID, const V2TIMString &  userID, V2TIMCallback *  callback  )

pure virtual

3.11 Change the group owner

Attention

The limits for different types of groups are as follows:

• Common groups (Work, Public, and Meeting): only the group owner has the permission to change the group owner.
• Audio-video group (AVChatRoom): changing the group owner is not supported.

KickGroupMember() [2/2]

virtual void KickGroupMember ( const V2TIMString &  groupID, const V2TIMStringVector &  memberList, const V2TIMString &  reason, V2TIMValueCallback< V2TIMGroupMemberOperationResultVector > *  callback  )

pure virtual

3.12 Remove a member from a group (supported for AVChatRoom only in Chat Premium 6.6 and later versions)

Attention

The limits are as follows:

• This API will be deprecated. Please call kickGroupMember(const V2TIMString&, const V2TIMStringVector &, const V2TIMString&, uint32_t, V2TIMValueCallback) instead.
• Work group (Work): only the group owner or app admin can remove a member from a group.
• Meeting group (Meeting) and public group (Public): the group owner, group admin, and app admin can remove a member from a group.
• Audio-video group (AVChatRoom): only muting(MuteGroupMember) is supported in versions prior to 6.6. Both muting(MuteGroupMember) and kicking(KickGroupMember) are supported in 6.6 and later versions.
• Please refer to the following link for other usage restrictions of this interface.

GetGroupApplicationList()

virtual void GetGroupApplicationList ( V2TIMValueCallback< V2TIMGroupApplicationResult > *  callback )

pure virtual

4.1 Get the group joining request list

Attention

Up to 50 requests are supported

AcceptGroupApplication()

virtual void AcceptGroupApplication ( const V2TIMGroupApplication &  application, const V2TIMString &  reason, V2TIMCallback *  callback  )

pure virtual

4.2 Approve a group joining request

RefuseGroupApplication()

virtual void RefuseGroupApplication ( const V2TIMGroupApplication &  application, const V2TIMString &  reason, V2TIMCallback *  callback  )

pure virtual

4.3 Reject a group joining request

SetGroupApplicationRead()

virtual void SetGroupApplicationRead ( V2TIMCallback *  callback )

pure virtual

4.4 Mark the group joining request list as read

GetJoinedCommunityList()

virtual void GetJoinedCommunityList ( V2TIMValueCallback< V2TIMGroupInfoVector > *  callback )

pure virtual

5.1 Get the list of Community-groups that the current user has joined

CreateTopicInCommunity()

virtual void CreateTopicInCommunity ( const V2TIMString &  groupID, const V2TIMTopicInfo &  topicInfo, V2TIMValueCallback< V2TIMString > *  callback  )

pure virtual

5.2 Create topic

Parameters

groupID

The community ID must start with @TGS_.

DeleteTopicFromCommunity()

virtual void DeleteTopicFromCommunity ( const V2TIMString &  groupID, const V2TIMStringVector &  topicIDList, V2TIMValueCallback< V2TIMTopicOperationResultVector > *  callback  )

pure virtual

5.3 Delete topic

SetTopicInfo()

virtual void SetTopicInfo ( const V2TIMTopicInfo &  topicInfo, V2TIMCallback *  callback  )

pure virtual

5.4 Modify topic information

GetTopicInfoList()

virtual void GetTopicInfoList ( const V2TIMString &  groupID, const V2TIMStringVector &  topicIDList, V2TIMValueCallback< V2TIMTopicInfoResultVector > *  callback  )

pure virtual

5.5 Get topic list

Attention

: When the topicIDList is empty，it means to get the list of all topics in this Community.