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

Public Member Functions

 V2TIMGroupListener ()
 
virtual ~V2TIMGroupListener ()
 
virtual void OnMemberEnter (const V2TIMString &groupID, const V2TIMGroupMemberInfoVector &memberList)
 
virtual void OnMemberLeave (const V2TIMString &groupID, const V2TIMGroupMemberInfo &member)
 
virtual void OnMemberInvited (const V2TIMString &groupID, const V2TIMGroupMemberInfo &opUser, const V2TIMGroupMemberInfoVector &memberList)
 
virtual void OnMemberKicked (const V2TIMString &groupID, const V2TIMGroupMemberInfo &opUser, const V2TIMGroupMemberInfoVector &memberList)
 
virtual void OnMemberInfoChanged (const V2TIMString &groupID, const V2TIMGroupMemberChangeInfoVector &v2TIMGroupMemberChangeInfoList)
 
virtual void OnAllGroupMembersMuted (const V2TIMString &groupID, bool isMute)
 
virtual void OnMemberMarkChanged (const V2TIMString &groupID, const V2TIMStringVector &memberIDList, int32_t markType, bool enableMark)
 
virtual void OnGroupCreated (const V2TIMString &groupID)
 
virtual void OnGroupDismissed (const V2TIMString &groupID, const V2TIMGroupMemberInfo &opUser)
 
virtual void OnGroupRecycled (const V2TIMString &groupID, const V2TIMGroupMemberInfo &opUser)
 
virtual void OnGroupInfoChanged (const V2TIMString &groupID, const V2TIMGroupChangeInfoVector &changeInfos)
 
virtual void OnGroupAttributeChanged (const V2TIMString &groupID, const V2TIMGroupAttributeMap &groupAttributeMap)
 
virtual void OnGroupCounterChanged (const V2TIMString &groupID, const V2TIMString &key, int64_t newValue)
 
virtual void OnReceiveJoinApplication (const V2TIMString &groupID, const V2TIMGroupMemberInfo &member, const V2TIMString &opReason)
 
virtual void OnApplicationProcessed (const V2TIMString &groupID, const V2TIMGroupMemberInfo &opUser, bool isAgreeJoin, const V2TIMString &opReason)
 
virtual void OnGrantAdministrator (const V2TIMString &groupID, const V2TIMGroupMemberInfo &opUser, const V2TIMGroupMemberInfoVector &memberList)
 
virtual void OnRevokeAdministrator (const V2TIMString &groupID, const V2TIMGroupMemberInfo &opUser, const V2TIMGroupMemberInfoVector &memberList)
 
virtual void OnQuitFromGroup (const V2TIMString &groupID)
 
virtual void OnReceiveRESTCustomData (const V2TIMString &groupID, const V2TIMBuffer &customData)
 
virtual void OnTopicCreated (const V2TIMString &groupID, const V2TIMString &topicID)
 
virtual void OnTopicDeleted (const V2TIMString &groupID, const V2TIMStringVector &topicIDList)
 
virtual void OnTopicChanged (const V2TIMString &groupID, const V2TIMTopicInfo &topicInfo)
 

Constructor & Destructor Documentation

◆ V2TIMGroupListener()

◆ ~V2TIMGroupListener()

virtual ~V2TIMGroupListener ( )
virtual

Member Function Documentation

◆ OnMemberEnter()

virtual void OnMemberEnter ( const V2TIMString groupID,
const V2TIMGroupMemberInfoVector memberList 
)
inlinevirtual

Users joined the group (received by all members).

Attention
By default, meeting groups do not trigger this callback. If you want to receive this callback for meeting groups too, please configure it in the console (Configuration -> Group configuration -> Group system notification configuration -> Notification of group member change).
Parameters
groupIDGroup ID
memberListMembers who join the group

◆ OnMemberLeave()

virtual void OnMemberLeave ( const V2TIMString groupID,
const V2TIMGroupMemberInfo member 
)
inlinevirtual

Users left the group (received by all members).

Attention
By default, meeting groups do not trigger this callback. If you want to receive this callback for meeting groups too, please configure it in the console (Configuration -> Group configuration -> Group system notification configuration -> Notification of group member change).
Parameters
groupIDGroup ID
memberMembers who leave the group

◆ OnMemberInvited()

virtual void OnMemberInvited ( const V2TIMString groupID,
const V2TIMGroupMemberInfo opUser,
const V2TIMGroupMemberInfoVector memberList 
)
inlinevirtual

Users are added to a group by others (received by all members of the group)

Parameters
groupIDGroup ID
opUserHandler
memberListMembers who are added to the group

◆ OnMemberKicked()

virtual void OnMemberKicked ( const V2TIMString groupID,
const V2TIMGroupMemberInfo opUser,
const V2TIMGroupMemberInfoVector memberList 
)
inlinevirtual

Users are removed from a group by others (received by all members of the group)

Parameters
groupIDGroup ID
opUserHandler
memberListMembers who are removed from the group

◆ OnMemberInfoChanged()

virtual void OnMemberInfoChanged ( const V2TIMString groupID,
const V2TIMGroupMemberChangeInfoVector v2TIMGroupMemberChangeInfoList 
)
inlinevirtual

Group member information modified (received by all members). This callback is triggered only when a group member is muted.

Attention
By default, meeting groups and AVChatRoom groups do not trigger this callback. If you want to receive this callback for those groups too, please configure it in the console (Configuration -> Group configuration -> Group system notification configuration -> Notification of group member profile change).
Parameters
groupIDGroup ID
v2TIMGroupMemberChangeInfoListGroup member information modified

◆ OnAllGroupMembersMuted()

virtual void OnAllGroupMembersMuted ( const V2TIMString groupID,
bool  isMute 
)
inlinevirtual

All group members are muted or unmuted (received by all members).

Attention
  • To receive this callback, you need to turn on the corresponding feature in the console (Configuration -> Group configuration -> Group system notification configuration -> Notification of group profile change -> Notification of muting all change).
  • Supported only in 7.5 and later versions.
Parameters
groupIDGroup ID
isMutetrue means mute, false means unmute

◆ OnMemberMarkChanged()

virtual void OnMemberMarkChanged ( const V2TIMString groupID,
const V2TIMStringVector memberIDList,
int32_t  markType,
bool  enableMark 
)
inlinevirtual

Some group members are marked (received by all members).

Attention
  • This callback is only triggered by community groups.
  • This is only supported in 7.5 and later versions of the Premium Edition.

◆ OnGroupCreated()

virtual void OnGroupCreated ( const V2TIMString groupID)
inlinevirtual

Group created (used for multi-device synchronization)

Parameters
groupIDGroup ID

◆ OnGroupDismissed()

virtual void OnGroupDismissed ( const V2TIMString groupID,
const V2TIMGroupMemberInfo opUser 
)
inlinevirtual

Group deleted (received by all members)

Parameters
groupIDGroup ID
opUserHandler

◆ OnGroupRecycled()

virtual void OnGroupRecycled ( const V2TIMString groupID,
const V2TIMGroupMemberInfo opUser 
)
inlinevirtual

Group repossessed (received by all members)

Parameters
groupIDGroup ID
opUserHandler

◆ OnGroupInfoChanged()

virtual void OnGroupInfoChanged ( const V2TIMString groupID,
const V2TIMGroupChangeInfoVector changeInfos 
)
inlinevirtual

Group information modified (received by all members).

Attention
  • This callback may be triggered if the following fields are changed: groupName, introduction, notification, faceUrl, owner, allMute, custom.
  • You can limit notifications or roaming to specific fields in the console (Configuration -> Group configuration -> Group system notification configuration -> Notification of group profile change).
Parameters
changeInfosGroup information modified

◆ OnGroupAttributeChanged()

virtual void OnGroupAttributeChanged ( const V2TIMString groupID,
const V2TIMGroupAttributeMap groupAttributeMap 
)
inlinevirtual

Group attributes changed(received by all members)

Parameters
groupIDGroup ID
groupAttributeMapAll attributes of the group

◆ OnGroupCounterChanged()

virtual void OnGroupCounterChanged ( const V2TIMString groupID,
const V2TIMString key,
int64_t  newValue 
)
inlinevirtual

Group counter update notification (received by all members).

Parameters
groupIDGroup ID
keyThe key of counter
newValueThe new value of the modified counter

◆ OnReceiveJoinApplication()

virtual void OnReceiveJoinApplication ( const V2TIMString groupID,
const V2TIMGroupMemberInfo member,
const V2TIMString opReason 
)
inlinevirtual

New group joining request (received only by the group owner and admin)

Parameters
groupIDGroup ID
memberApplicant
opReasonRequest reason

◆ OnApplicationProcessed()

virtual void OnApplicationProcessed ( const V2TIMString groupID,
const V2TIMGroupMemberInfo opUser,
bool  isAgreeJoin,
const V2TIMString opReason 
)
inlinevirtual

The request to join the group or invite has been processed by the group owner or administrator. (received only by the applicant)

Parameters
groupIDGroup ID
opUserHandler
isAgreeJoinWhether to agree to join the group
opReasonHandling reason

◆ OnGrantAdministrator()

virtual void OnGrantAdministrator ( const V2TIMString groupID,
const V2TIMGroupMemberInfo opUser,
const V2TIMGroupMemberInfoVector memberList 
)
inlinevirtual

Some users are made admins.

Parameters
groupIDGroup ID
opUserHandler
memberListGroup members handled

◆ OnRevokeAdministrator()

virtual void OnRevokeAdministrator ( const V2TIMString groupID,
const V2TIMGroupMemberInfo opUser,
const V2TIMGroupMemberInfoVector memberList 
)
inlinevirtual

Some users are removed as admin.

Parameters
groupIDGroup ID
opUserHandler
memberListGroup members handled

◆ OnQuitFromGroup()

virtual void OnQuitFromGroup ( const V2TIMString groupID)
inlinevirtual

You quit a group. (mainly used for multi-device synchronization)

Parameters
groupIDGroup ID

◆ OnReceiveRESTCustomData()

virtual void OnReceiveRESTCustomData ( const V2TIMString groupID,
const V2TIMBuffer customData 
)
inlinevirtual

Received a custom system message delivered via the RESTful API

Parameters
groupIDGroup ID
customDataCustom data

◆ OnTopicCreated()

virtual void OnTopicCreated ( const V2TIMString groupID,
const V2TIMString topicID 
)
inlinevirtual

Topic created

Parameters
GroupIDgroup id of Community
TopicIDtopic id in Community

◆ OnTopicDeleted()

virtual void OnTopicDeleted ( const V2TIMString groupID,
const V2TIMStringVector topicIDList 
)
inlinevirtual

Topic deleted

Parameters
GroupIDgroup id of Community
TopicIDListtopic id list in Community

◆ OnTopicChanged()

virtual void OnTopicChanged ( const V2TIMString groupID,
const V2TIMTopicInfo topicInfo 
)
inlinevirtual

Topic information modified (received by all members)

Parameters
groupIDGroup id of Community
topicInfoTopic Topic information