Chat SDK for Unity and Windows v1.2.0
Public Member Functions | List of all members
AgoraChat.IGroupManagerDelegate Interface Reference

Public Member Functions

void OnInvitationReceivedFromGroup (string groupId, string groupName, string inviter, string reason)
 
void OnRequestToJoinReceivedFromGroup (string groupId, string groupName, string applicant, string reason)
 
void OnRequestToJoinAcceptedFromGroup (string groupId, string groupName, string accepter)
 
void OnRequestToJoinDeclinedFromGroup (string groupId, string reason)
 
void OnInvitationAcceptedFromGroup (string groupId, string invitee)
 
void OnInvitationDeclinedFromGroup (string groupId, string invitee, string reason)
 
void OnUserRemovedFromGroup (string groupId, string groupName)
 
void OnDestroyedFromGroup (string groupId, string groupName)
 
void OnAutoAcceptInvitationFromGroup (string groupId, string inviter, string inviteMessage)
 
void OnMuteListAddedFromGroup (string groupId, List< string > mutes, long muteExpire)
 
void OnMuteListRemovedFromGroup (string groupId, List< string > mutes)
 
void OnAdminAddedFromGroup (string groupId, string administrator)
 
void OnAdminRemovedFromGroup (string groupId, string administrator)
 
void OnOwnerChangedFromGroup (string groupId, string newOwner, string oldOwner)
 
void OnMemberJoinedFromGroup (string groupId, string member)
 
void OnMemberExitedFromGroup (string groupId, string member)
 
void OnAnnouncementChangedFromGroup (string groupId, string announcement)
 
void OnSharedFileAddedFromGroup (string groupId, GroupSharedFile sharedFile)
 
void OnSharedFileDeletedFromGroup (string groupId, string fileId)
 
void OnAddAllowListMembersFromGroup (string groupId, List< string > allowList)
 
void OnRemoveAllowListMembersFromGroup (string groupId, List< string > allowList)
 
void OnAllMemberMuteChangedFromGroup (string groupId, bool isAllMuted)
 
void OnStateChangedFromGroup (string groupId, bool isDisable)
 
void OnSpecificationChangedFromGroup (Group group)
 
void OnUpdateMemberAttributesFromGroup (string groupId, string userId, Dictionary< string, string > attributes, string from)
 

Detailed Description

The group manager callback interface.

Member Function Documentation

◆ OnInvitationReceivedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnInvitationReceivedFromGroup ( string  groupId,
string  groupName,
string  inviter,
string  reason 
)

Occurs when the user receives a group invitation.

Parameters
groupIdThe group ID.
groupNameThe group name.
inviterThe user ID of the inviter.
reasonThe reason for invitation.

◆ OnRequestToJoinReceivedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnRequestToJoinReceivedFromGroup ( string  groupId,
string  groupName,
string  applicant,
string  reason 
)

Occurs when the group owner or admin receives a join request from a user.

Parameters
groupIdThe group ID.
groupNameThe group name.
applicantThe ID of the user requesting to join the group.
reasonThe reason for requesting to join the group.

◆ OnRequestToJoinAcceptedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnRequestToJoinAcceptedFromGroup ( string  groupId,
string  groupName,
string  accepter 
)

Occurs when a join request is accepted.

Parameters
groupIdThe group ID.
groupNameThe group name.
accepterThe ID of the user that accepts the join request.

◆ OnRequestToJoinDeclinedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnRequestToJoinDeclinedFromGroup ( string  groupId,
string  reason 
)

Occurs when a join request is declined.

Parameters
groupIdThe group ID.
reasonThe reason for declining the join request.

◆ OnInvitationAcceptedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnInvitationAcceptedFromGroup ( string  groupId,
string  invitee 
)

Occurs when a group invitation is accepted.

Parameters
groupIdThe group ID.
inviteeThe user ID of the invitee.

◆ OnInvitationDeclinedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnInvitationDeclinedFromGroup ( string  groupId,
string  invitee,
string  reason 
)

Occurs when a group invitation is declined.

Parameters
groupIdThe group ID.
inviteeThe user ID of the invitee.
reasonThe reason for declining the invitation.

◆ OnUserRemovedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnUserRemovedFromGroup ( string  groupId,
string  groupName 
)

Occurs when the current user is removed from the group by the group owner or group admin.

Parameters
groupIdThe group ID.
groupNameThe group name.

◆ OnDestroyedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnDestroyedFromGroup ( string  groupId,
string  groupName 
)

Occurs when a group is destroyed.

The SDK will remove the group from the local database and local memory before notifying the app of the group removal via the callback method.

Parameters
groupIdThe group ID.
groupNameThe group name.

◆ OnAutoAcceptInvitationFromGroup()

void AgoraChat.IGroupManagerDelegate.OnAutoAcceptInvitationFromGroup ( string  groupId,
string  inviter,
string  inviteMessage 
)

Occurs when the group invitation is accepted automatically.

The SDK will add the user to the group before notifying the app of the acceptance of the group invitation via the callback method.

For settings, see com.hyphenate.chat.EMOptions#setAutoAcceptGroupInvitation(boolean value).

Parameters
groupIdThe group ID.
inviterThe user ID of the inviter.
inviteMessageThe invitation message.

◆ OnMuteListAddedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnMuteListAddedFromGroup ( string  groupId,
List< string >  mutes,
long  muteExpire 
)

Occurs when one or more group members are muted.

Note

A user, when muted, can still see group messages, but cannot send messages in the group. However, a user on the block list can neither see nor send group messages.

Parameters
groupIdThe group ID.
mutesThe member(s) added to the mute list.
muteExpireThe mute duration in milliseconds.

◆ OnMuteListRemovedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnMuteListRemovedFromGroup ( string  groupId,
List< string >  mutes 
)

Occurs when one or more group members are unmuted.

Note

A user, when muted, can still see group messages, but cannot send messages in the group. However, a user on the block list can neither see nor send group messages.

Parameters
groupIdThe group ID.
mutesThe member(s) removed from the mute list.

◆ OnAdminAddedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnAdminAddedFromGroup ( string  groupId,
string  administrator 
)

Occurs when a member is set as an admin.

Parameters
groupIdThe group ID.
administratorThe user ID of the member that is set as an admin.

◆ OnAdminRemovedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnAdminRemovedFromGroup ( string  groupId,
string  administrator 
)

Occurs when the admin privileges of a member are removed..

Parameters
groupIdThe group ID.
administratorThe user ID of the member whose admin privileges are removed.

◆ OnOwnerChangedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnOwnerChangedFromGroup ( string  groupId,
string  newOwner,
string  oldOwner 
)

Occurs when the group ownership is transferred.

Parameters
groupIdThe group ID.
newOwnerThe new group owner.
oldOwnerThe previous group owner.

◆ OnMemberJoinedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnMemberJoinedFromGroup ( string  groupId,
string  member 
)

Occurs when a user joins a group.

Parameters
groupIdThe group ID.
memberThe ID of the new member.

◆ OnMemberExitedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnMemberExitedFromGroup ( string  groupId,
string  member 
)

Occurs when a member voluntarily leaves the group.

Parameters
groupIdThe group ID.
memberThe user ID of the member who has left the group.

◆ OnAnnouncementChangedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnAnnouncementChangedFromGroup ( string  groupId,
string  announcement 
)

Occurs when the group announcement is updated.

Parameters
groupIdThe group ID.
announcementThe updated announcement content.

◆ OnSharedFileAddedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnSharedFileAddedFromGroup ( string  groupId,
GroupSharedFile  sharedFile 
)

Occurs when a shared file is added to a group.

Parameters
groupIdThe group ID.
sharedFileThe new shared file.

◆ OnSharedFileDeletedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnSharedFileDeletedFromGroup ( string  groupId,
string  fileId 
)

Occurs when a shared file is removed from a group.

Parameters
groupIdThe group ID.
fileIdThe ID of the removed shared file.

◆ OnAddAllowListMembersFromGroup()

void AgoraChat.IGroupManagerDelegate.OnAddAllowListMembersFromGroup ( string  groupId,
List< string >  allowList 
)

Occurs when one or more group members are added to the group allow list.

Parameters
groupIdThe group ID.
allowListThe member(s) added to the group allow list.

◆ OnRemoveAllowListMembersFromGroup()

void AgoraChat.IGroupManagerDelegate.OnRemoveAllowListMembersFromGroup ( string  groupId,
List< string >  allowList 
)

Occurs when one or more members are removed from the group allow list.

Parameters
groupIdThe group ID.
allowListMember(s) removed from the group allow list.

◆ OnAllMemberMuteChangedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnAllMemberMuteChangedFromGroup ( string  groupId,
bool  isAllMuted 
)

Occurs when all group members are muted or unmuted.

Parameters
groupIdThe group ID.
isAllMutedWhether all group members are muted or unmuted.
  • true: All group members are muted;
  • false: All group members are unmuted.

◆ OnStateChangedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnStateChangedFromGroup ( string  groupId,
bool  isDisable 
)

Occurs when the disabled state of group changes.

Parameters
groupIdThe group ID.
isDisableWhether the group is disabled.

◆ OnSpecificationChangedFromGroup()

void AgoraChat.IGroupManagerDelegate.OnSpecificationChangedFromGroup ( Group  group)

Occurs when the group specification(s) is/are changed.

Once the group specifications are changed, you need to call GetGroupSpecificationFromServer(string, ValueCallBack<Group>) to get the latest group information from the server.

Parameters
groupThe group instance.

◆ OnUpdateMemberAttributesFromGroup()

void AgoraChat.IGroupManagerDelegate.OnUpdateMemberAttributesFromGroup ( string  groupId,
string  userId,
Dictionary< string, string >  attributes,
string  from 
)

Occurs when a custom attribute(s) of a group member is/are changed.

Parameters
groupIdThe group ID.
userIdThe user ID of the group member whose custom attribute(s) is/are changed.
attributesThe modified custom attribute(s).
fromThe user ID of the operator.