hyphenate_SDK4.0 5.0.0
hyphenate java IM SDK
 
Loading...
Searching...
No Matches
com.hyphenate.EMGroupChangeListener Interface Reference

Public Member Functions

void onInvitationReceived (String groupId, String groupName, String inviter, String reason)
 
void onRequestToJoinReceived (String groupId, String groupName, String applicant, String reason)
 
void onRequestToJoinAccepted (String groupId, String groupName, String accepter)
 
default void onRequestToJoinDeclined (String groupId, String groupName, String decliner, String reason, String applicant)
 
void onInvitationAccepted (String groupId, String invitee, String reason)
 
void onInvitationDeclined (String groupId, String invitee, String reason)
 
void onUserRemoved (String groupId, String groupName)
 
void onGroupDestroyed (String groupId, String groupName)
 
void onAutoAcceptInvitationFromGroup (String groupId, String inviter, String inviteMessage)
 
void onMuteListAdded (String groupId, final List< String > mutes, final long muteExpire)
 
void onMuteListRemoved (String groupId, final List< String > mutes)
 
void onWhiteListAdded (final String groupId, final List< String > whitelist)
 
void onWhiteListRemoved (final String groupId, final List< String > whitelist)
 
void onAllMemberMuteStateChanged (final String groupId, final boolean isMuted)
 
void onAdminAdded (String groupId, String administrator)
 
void onAdminRemoved (String groupId, String administrator)
 
void onOwnerChanged (String groupId, String newOwner, String oldOwner)
 
default void onMembersJoined (final String groupId, final List< String > members)
 
default void onMembersExited (final String groupId, final List< String > members)
 
void onAnnouncementChanged (String groupId, String announcement)
 
void onSharedFileAdded (String groupId, EMMucSharedFile sharedFile)
 
void onSharedFileDeleted (String groupId, String fileId)
 
default void onSpecificationChanged (EMGroup group)
 
default void onStateChanged (EMGroup group, boolean isDisabled)
 
default void onGroupMemberAttributeChanged (String groupId, String userId, Map< String, String > attribute, String from)
 
default void onUserGroupNamecardUpdated (String groupId, String userId, String groupNamecard)
 

Detailed Description

The group change listener. Listens for group events such as requesting to join a group, approving or declining a group request, and kicking a user out of a group.

 Registers a group change listener:
EMClient.getInstance().groupManager().addGroupChangeListener(mGroupChangeListener);
 Unregisters a group change listener:
EMClient.getInstance().groupManager().removeGroupChangeListener(mGroupChangeListener);

Member Function Documentation

◆ onAdminAdded()

void com.hyphenate.EMGroupChangeListener.onAdminAdded ( String groupId,
String administrator )

Occurs when a member is set as an admin.

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

◆ onAdminRemoved()

void com.hyphenate.EMGroupChangeListener.onAdminRemoved ( String groupId,
String administrator )

Occurs when a member's admin privileges are removed.

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

◆ onAllMemberMuteStateChanged()

void com.hyphenate.EMGroupChangeListener.onAllMemberMuteStateChanged ( final String groupId,
final boolean isMuted )

Occurs when all group members are muted or unmuted.

Parameters
groupIdThe group ID.
isMutedWhether all group members are muted or unmuted. true: all group members are muted; false: all group members are unmuted.

◆ onAnnouncementChanged()

void com.hyphenate.EMGroupChangeListener.onAnnouncementChanged ( String groupId,
String announcement )

Occurs when the announcement is updated.

Parameters
groupIdThe group ID.
announcementThe updated announcement content.

◆ onAutoAcceptInvitationFromGroup()

void com.hyphenate.EMGroupChangeListener.onAutoAcceptInvitationFromGroup ( String groupId,
String inviter,
String inviteMessage )

Occurs when the group invitation is accepted automatically. The SDK will join the group before notifying the app of the acceptance of the group invitation. For settings, see com.hyphenate.chat.EMOptions#setAutoAcceptGroupInvitation(boolean value).

Parameters
groupIdThe group ID.
inviterThe inviter ID.
inviteMessageThe invitation message.

◆ onGroupDestroyed()

void com.hyphenate.EMGroupChangeListener.onGroupDestroyed ( String groupId,
String groupName )

Occurs when a group is destroyed. The SDK will remove the group from the local database and local cache before notifying the app of the group removal.

Parameters
groupIdThe group ID.
groupNameThe group name.

◆ onGroupMemberAttributeChanged()

default void com.hyphenate.EMGroupChangeListener.onGroupMemberAttributeChanged ( String groupId,
String userId,
Map< String, String > attribute,
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 attributes are changed.
attributeThe modified custom attributes, in key-value format.
fromThe user ID of the operator.

◆ onInvitationAccepted()

void com.hyphenate.EMGroupChangeListener.onInvitationAccepted ( String groupId,
String invitee,
String reason )

Occurs when a group invitation is accepted.

Parameters
groupIdThe group ID.
inviteeThe invitee ID.
reasonThe reason for acceptance.

◆ onInvitationDeclined()

void com.hyphenate.EMGroupChangeListener.onInvitationDeclined ( String groupId,
String invitee,
String reason )

Occurs when a group invitation is declined.

Parameters
groupIdThe group ID.
inviteeThe invitee ID.
reasonThe reason for declining.

◆ onInvitationReceived()

void com.hyphenate.EMGroupChangeListener.onInvitationReceived ( String groupId,
String groupName,
String inviter,
String reason )

Occurs when the user receives a group invitation.

Parameters
groupIdThe group ID.
groupNameThe group name.
inviterThe invitee ID.
reasonThe reason for invitation.

◆ onMembersExited()

default void com.hyphenate.EMGroupChangeListener.onMembersExited ( final String groupId,
final List< String > members )

Occurs when members leave the group (either proactively or passively).

Parameters
groupIdThe group ID.
membersThe list of users IDs of members that leave the group.

◆ onMembersJoined()

default void com.hyphenate.EMGroupChangeListener.onMembersJoined ( final String groupId,
final List< String > members )

Occurs when members join a group.

Parameters
groupIdThe group ID.
membersThe list of user IDs of the new members.

◆ onMuteListAdded()

void com.hyphenate.EMGroupChangeListener.onMuteListAdded ( String groupId,
final List< String > mutes,
final long muteExpire )

Occurs when one or more group members are muted.

Note
The mute function is different from a blocklist. A user, when muted, can still see group messages, but cannot send messages in the group. However, a user on the blocklist can neither see nor send group messages.
Parameters
groupIdThe group ID.
mutesThe member(s) added to the mute list. Map.entry.key is the muted username; Map.entry.value is the mute duration in milliseconds.

◆ onMuteListRemoved()

void com.hyphenate.EMGroupChangeListener.onMuteListRemoved ( String groupId,
final List< String > mutes )

Occurs when one or more group members are unmuted. Note: The mute function is different from a blocklist. A user, when muted, still can see group messages, but cannot send messages in the group. However, a user on the blocklist can neither see nor send group messages.

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

◆ onOwnerChanged()

void com.hyphenate.EMGroupChangeListener.onOwnerChanged ( String groupId,
String newOwner,
String oldOwner )

Occurs when the group ownership is transferred.

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

◆ onRequestToJoinAccepted()

void com.hyphenate.EMGroupChangeListener.onRequestToJoinAccepted ( String groupId,
String groupName,
String accepter )

Occurs when a group request is accepted.

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

◆ onRequestToJoinDeclined()

default void com.hyphenate.EMGroupChangeListener.onRequestToJoinDeclined ( String groupId,
String groupName,
String decliner,
String reason,
String applicant )

Occurs when a group request is declined.

Parameters
groupIdThe group ID.
groupNameThe group name.
declinerThe ID of the user that declines the group request.
reasonThe reason for declining.
applicantThe userId of applicant

◆ onRequestToJoinReceived()

void com.hyphenate.EMGroupChangeListener.onRequestToJoinReceived ( String groupId,
String groupName,
String applicant,
String reason )

Occurs when the group owner or administrator receives a group 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.

◆ onSharedFileAdded()

void com.hyphenate.EMGroupChangeListener.onSharedFileAdded ( String groupId,
EMMucSharedFile sharedFile )

Occurs when a shared file is added to a group.

Parameters
groupIdThe group ID.
sharedFileThe new shared file.

◆ onSharedFileDeleted()

void com.hyphenate.EMGroupChangeListener.onSharedFileDeleted ( 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.

◆ onSpecificationChanged()

default void com.hyphenate.EMGroupChangeListener.onSpecificationChanged ( EMGroup group)

Occurs when the group detail information is updated, need to callcom.hyphenate.chat.EMGroupManager#asyncGetGroupFromServer(String, EMValueCallBack) to get the latest group information.

Parameters
groupThe group.

◆ onStateChanged()

default void com.hyphenate.EMGroupChangeListener.onStateChanged ( EMGroup group,
boolean isDisabled )

Occurs when the group is enabled or disabled.

Parameters
groupThe group.
isDisabledWhether the group is disabled.

◆ onUserGroupNamecardUpdated()

default void com.hyphenate.EMGroupChangeListener.onUserGroupNamecardUpdated ( String groupId,
String userId,
String groupNamecard )

Occurs when a member's name card in the group is updated.

Parameters
groupIdThe group ID.
userIdThe user ID of the group member whose name card is set or updated.
groupNamecardThe new name card of the member in the group.

◆ onUserRemoved()

void com.hyphenate.EMGroupChangeListener.onUserRemoved ( String groupId,
String groupName )

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

Parameters
groupIdThe group ID.
groupNameThe group name.

◆ onWhiteListAdded()

void com.hyphenate.EMGroupChangeListener.onWhiteListAdded ( final String groupId,
final List< String > whitelist )

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

Parameters
groupIdThe group ID.
whitelistThe member(s) added to the allowlist.

◆ onWhiteListRemoved()

void com.hyphenate.EMGroupChangeListener.onWhiteListRemoved ( final String groupId,
final List< String > whitelist )

Occurs when one or more members are removed from the allowlist.

Parameters
groupIdThe group ID.
whitelistMember(s) removed from the allowlist.

The documentation for this interface was generated from the following file: