Extensions on V2TIMManager

• Limited by backgroud service, the number of memberList must be less than or equal to 20.

• For other limits, please see @ref V2TIMManager.createGroup remarks.

• 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.

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.

• 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.

• 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.

• 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.

• 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.

• 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.

• 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 succ callback.

• Group counter is supported for all group types except community and topics.

• 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.

• 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.

• 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.

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

• 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):

• 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.

• 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.

• 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.

• Only the following fields are supported in group member profiles: userID, nickName, faceURL, and role.

• Restrictions for Community groups:

• If you set the filter to the value defined in V2TIMGroupMemberFilter, you will get the the members of corresponding role.

• 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).

• 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.

• 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.

• 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.

• 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 @ref 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).

• 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.

• 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.

• This API will be deprecated. Please call kickGroupMember:memberList:reason:duration:succ:fail: 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.