Classes
enum	EMGroupConfigsType

Public Member Functions
List< EMGroup >	getAllGroups ()

EMGroup	getGroup (String groupId)

EMGroup	createGroup (String groupName, String avatar, String desc, String[] allMembers, String reason, EMGroupConfigs configs) throws HyphenateException

void	asyncCreateGroup (final String groupName, final String avatar, final String desc, final String[] allMembers, final String reason, final EMGroupConfigs configs, final EMValueCallBack< EMGroup > callback)

void	destroyGroup (final String groupId) throws HyphenateException

void	asyncDestroyGroup (final String groupId, final EMCallBack callback)

void	addUsersToGroup (String groupId, String[] newmembers) throws HyphenateException

void	addUsersToGroup (String groupId, String[] newmembers, String welcomeMessage) throws HyphenateException

void	asyncAddUsersToGroup (final String groupId, final String[] newmembers, final EMCallBack callback)

void	removeUserFromGroup (final String groupId, final String username) throws HyphenateException

void	asyncRemoveUserFromGroup (final String groupId, final String username, final EMCallBack callback)

void	removeUsersFromGroup (final String groupId, final List< String > members) throws HyphenateException

void	asyncRemoveUsersFromGroup (final String groupId, final List< String > members, final EMCallBack callback)

void	leaveGroup (String groupId) throws HyphenateException

void	asyncLeaveGroup (final String groupId, final EMCallBack callback)

EMGroup	getGroupFromServer (String groupId) throws HyphenateException

void	asyncGetGroupFromServer (final String groupId, final EMValueCallBack< EMGroup > callback)

void	asyncGetJoinedGroupsCountFromServer (final EMValueCallBack< Integer > callback)

void	joinGroup (String groupId) throws HyphenateException

void	asyncJoinGroup (final String groupId, final EMCallBack callback)

void	changeGroupName (String groupId, String changedGroupName) throws HyphenateException

void	asyncChangeGroupName (final String groupId, final String changedGroupName, final EMCallBack callback)

void	changeGroupAvatar (String groupId, String changedAvatar) throws HyphenateException

void	asyncChangeGroupAvatar (final String groupId, final String changedGroupAvatar, final EMCallBack callback)

void	changeGroupDescription (String groupId, String changedDescription) throws HyphenateException

void	asyncChangeGroupDescription (final String groupId, final String changedDescription, final EMCallBack callBack)

EMGroup	acceptInvitation (String groupId, String inviter) throws HyphenateException

void	asyncAcceptInvitation (final String groupId, final String inviter, final EMValueCallBack< EMGroup > callback)

void	declineInvitation (String groupId, String inviter, String reason) throws HyphenateException

void	asyncDeclineInvitation (final String groupId, final String inviter, final String reason, final EMCallBack callback)

void	acceptApplication (String username, String groupId) throws HyphenateException

void	asyncAcceptApplication (final String username, final String groupId, final EMCallBack callback)

void	declineApplication (String username, String groupId, String reason) throws HyphenateException

void	asyncDeclineApplication (final String username, final String groupId, final String reason, final EMCallBack callback)

void	inviteUser (String groupId, String[] beInvitedUsernames, String reason) throws HyphenateException

void	asyncInviteUser (final String groupId, final String[] beInvitedUsernames, final String reason, final EMCallBack callback)

void	applyJoinToGroup (String groupId, String reason) throws HyphenateException

void	asyncApplyJoinToGroup (final String groupId, final String reason, final EMCallBack callback)

void	blockGroupMessage (String groupId) throws HyphenateException

void	asyncBlockGroupMessage (final String groupId, final EMCallBack callback)

void	unblockGroupMessage (String groupId) throws HyphenateException

void	asyncUnblockGroupMessage (final String groupId, final EMCallBack callback)

void	blockUser (String groupId, String username) throws HyphenateException

void	asyncBlockUser (final String groupId, final String username, final EMCallBack callback)

void	blockUsers (String groupId, List< String > members) throws HyphenateException

void	asyncBlockUsers (final String groupId, final List< String > members, final EMCallBack callback)

void	unblockUser (String groupId, String username) throws HyphenateException

void	asyncUnblockUser (final String groupId, final String username, final EMCallBack callback)

void	unblockUsers (String groupId, List< String > members) throws HyphenateException

void	asyncUnblockUsers (final String groupId, final List< String > members, final EMCallBack callback)

List< String >	getBlockedUsers (String groupId) throws HyphenateException

List< String >	getBlockedUsers (String groupId, int pageIndex, int pageSize) throws HyphenateException

void	asyncGetBlockedUsers (final String groupId, final EMValueCallBack< List< String > > callback)

void	asyncGetBlockedUsers (final String groupId, final int pageIndex, final int pageSize, final EMValueCallBack< List< String > > callback)

void	addGroupChangeListener (EMGroupChangeListener listener)

void	removeGroupChangeListener (EMGroupChangeListener listener)

EMCursorResult< String >	fetchGroupMembers (String groupId, String cursor, int pageSize) throws HyphenateException

void	asyncFetchGroupMembers (final String groupId, final String cursor, final int pageSize, final EMValueCallBack< EMCursorResult< String > > callback)

void	asyncFetchGroupMembersInfo (final String groupId, String cursor, final int pageSize, final EMValueCallBack< EMCursorResult< EMGroupMemberInfo > > callback)

EMGroup	changeOwner (String groupId, String newOwner) throws HyphenateException

void	asyncChangeOwner (final String groupId, final String newOwner, final EMValueCallBack< EMGroup > callback)

EMGroup	addGroupAdmin (final String groupId, final String admin) throws HyphenateException

void	asyncAddGroupAdmin (final String groupId, final String admin, final EMValueCallBack< EMGroup > callback)

EMGroup	removeGroupAdmin (String groupId, String admin) throws HyphenateException

void	asyncRemoveGroupAdmin (final String groupId, final String admin, final EMValueCallBack< EMGroup > callback)

EMGroup	muteGroupMembers (String groupId, List< String > muteMembers, long duration) throws HyphenateException

void	asyncMuteGroupMembers (final String groupId, final List< String > muteMembers, final long duration, final EMValueCallBack< EMGroup > callback)

EMGroup	unMuteGroupMembers (String groupId, List< String > members) throws HyphenateException

void	asyncUnMuteGroupMembers (final String groupId, final List< String > members, final EMValueCallBack< EMGroup > callback)

Map< String, Long >	fetchGroupMuteList (String groupId, int pageNum, int pageSize) throws HyphenateException

void	asyncFetchGroupMuteList (final String groupId, final int pageNum, final int pageSize, final EMValueCallBack< Map< String, Long > > callBack)

void	asyncCheckIfInMuteList (final String groupId, final EMValueCallBack< Boolean > callBack)

List< String >	fetchGroupBlackList (String groupId, int pageNum, int pageSize) throws HyphenateException

void	asyncFetchGroupBlackList (final String groupId, final int pageNum, final int pageSize, final EMValueCallBack< List< String > > callBack)

void	addToGroupWhiteList (final String groupId, final List< String > members, final EMCallBack callBack)

void	removeFromGroupWhiteList (final String groupId, final List< String > members, final EMCallBack callBack)

void	checkIfInGroupWhiteList (final String groupId, EMValueCallBack< Boolean > callBack)

void	fetchGroupWhiteList (final String groupId, final EMValueCallBack< List< String > > callBack)

void	muteAllMembers (final String groupId, final EMValueCallBack< EMGroup > callBack)

void	unmuteAllMembers (final String groupId, final EMValueCallBack< EMGroup > callBack)

void	updateGroupAnnouncement (String groupId, String announcement) throws HyphenateException

void	asyncUpdateGroupAnnouncement (final String groupId, final String announcement, final EMCallBack callBack)

String	fetchGroupAnnouncement (String groupId) throws HyphenateException

void	asyncFetchGroupAnnouncement (final String groupId, final EMValueCallBack< String > callBack)

EMMucSharedFile	uploadGroupSharedFile (String groupId, String filePath, EMCallBack callBack) throws HyphenateException

void	asyncUploadGroupSharedFile (final String groupId, final String filePath, final EMValueCallBack< EMMucSharedFile > callBack)

List< EMMucSharedFile >	fetchGroupSharedFileList (String groupId, int pageNum, int pageSize) throws HyphenateException

void	asyncFetchGroupSharedFileList (final String groupId, final int pageNum, final int pageSize, final EMValueCallBack< List< EMMucSharedFile > > callBack)

void	deleteGroupSharedFile (String groupId, String fileId) throws HyphenateException

void	asyncDeleteGroupSharedFile (final String groupId, final String fileId, final EMCallBack callBack)

void	downloadGroupSharedFile (String groupId, String fileId, String savePath, EMCallBack callBack) throws HyphenateException

void	asyncDownloadGroupSharedFile (final String groupId, final String fileId, final String savePath, final EMCallBack callBack)

void	asyncSetGroupMemberAttributes (String groupId, String userId, Map< String, String > attributeMap, EMCallBack callBack)

void	asyncFetchGroupMemberAllAttributes (String groupId, String userId, EMValueCallBack< Map< String, Map< String, String > > > callBack)

void	asyncFetchGroupMembersAttributes (String groupId, List< String > userList, List< String > keyList, EMValueCallBack< Map< String, Map< String, String > > > callBack)

EMGroup	updateGroupExtension (String groupId, String extension) throws HyphenateException

EMGroup	updateGroupConfigs (String groupId, EnumSet< EMGroupConfigsType > types, EMGroupConfigs configs) throws HyphenateException

void	asyncUpdateGroupConfigs (final String groupId, final EnumSet< EMGroupConfigsType > types, final EMGroupConfigs configs, final EMValueCallBack< EMGroup > callback)

void	asyncUpdateGroupExtension (final String groupId, final String extension, final EMValueCallBack< EMGroup > callBack)

void	asyncUpdateGroupNamecard (final String groupId, final String namecard, final EMCallBack callBack)

String	getGroupNamecard (String groupId, String userId)

void	cleanAllGroupsFromLocal ()

Detailed Description

The group manager for management of group creation and deletion and member management.

Member Function Documentation

◆ acceptApplication()

void com.hyphenate.chat.EMGroupManager.acceptApplication	(	String	username,
		String	groupId ) throws HyphenateException

Approves a group request.

Only the group owner or admin can call this method.

For the asynchronous method, see asyncAcceptApplication(String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

username	The ID of the user who sends a request to join the group.
groupId	The group ID.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ acceptInvitation()

EMGroup com.hyphenate.chat.EMGroupManager.acceptInvitation	(	String	groupId,
		String	inviter ) throws HyphenateException

Accepts a group invitation.

For the asynchronous method, see asyncAcceptInvitation(String, String, EMValueCallBack)。

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
inviter	The user who initiates the invitation.

Returns: The group instance which the user has accepted the invitation to join.

Exceptions

HyphenateException A description of the exception. see EMError.

◆ addGroupAdmin()

EMGroup com.hyphenate.chat.EMGroupManager.addGroupAdmin	(	final String	groupId,
		final String	admin ) throws HyphenateException

Adds a group admin. Only the group owner can call this method and admin can not. For the asynchronous method, see asyncAddGroupAdmin(String, String, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
admin	The admin ID to add.

Returns: The updated group instance.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ addGroupChangeListener()

void com.hyphenate.chat.EMGroupManager.addGroupChangeListener ( EMGroupChangeListener listener )

Registers a group change listener. The registered listener needs to be used together with removeGroupChangeListener(EMGroupChangeListener).

Parameters

listener The group event listener to be registered.

◆ addToGroupWhiteList()

void com.hyphenate.chat.EMGroupManager.addToGroupWhiteList	(	final String	groupId,
		final List< String >	members,
		final EMCallBack	callBack )

Adds members to the allowlist. Only the group owner or admin can call this method.

This is an asynchronous method.

Parameters

groupId	The group ID.
members	The members to be added to the allowlist.
callBack	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ addUsersToGroup() [1/2]

void com.hyphenate.chat.EMGroupManager.addUsersToGroup	(	String	groupId,
		String[]	newmembers ) throws HyphenateException

Adds users to the group. Only the group creator or admin can call this method. For the asynchronous method, see asyncAddUsersToGroup(String, String[], EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
newmembers	The array of new members to add.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ addUsersToGroup() [2/2]

void com.hyphenate.chat.EMGroupManager.addUsersToGroup	(	String	groupId,
		String[]	newmembers,
		String	welcomeMessage ) throws HyphenateException

Adds users to the group. Only the group owner or admin can call this method. For the asynchronous method, see asyncAddUsersToGroup(String, String[], EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
newmembers	The array of new members to add.
welcomeMessage	The welcome message.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ applyJoinToGroup()

void com.hyphenate.chat.EMGroupManager.applyJoinToGroup	(	String	groupId,
		String	reason ) throws HyphenateException

Requests to join a group. Note: The group config isPublic=true and joinApprovalRequired=true, so the public group requires join approval. For an asynchronous method, see asyncApplyJoinToGroup(String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
reason	The reason for requesting to join the group.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ asyncAcceptApplication()

void com.hyphenate.chat.EMGroupManager.asyncAcceptApplication	(	final String	username,
		final String	groupId,
		final EMCallBack	callback )

Approves a group request.

Only the group owner or admin can call this method.

For the synchronous method, see acceptApplication(String, String).

This is an asynchronous method.

Parameters

username	The ID of the user who sends the request to join the group.
groupId	The group ID.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)` if it does not.

◆ asyncAcceptInvitation()

void com.hyphenate.chat.EMGroupManager.asyncAcceptInvitation	(	final String	groupId,
		final String	inviter,
		final EMValueCallBack< EMGroup >	callback )

Accepts a group invitation.

For the synchronous method, see acceptInvitation(String, String).

This is an asynchronous method.

Parameters

groupId	The group ID.
inviter	The inviter ID.
callback	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the updated group instance; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncAddGroupAdmin()

void com.hyphenate.chat.EMGroupManager.asyncAddGroupAdmin	(	final String	groupId,
		final String	admin,
		final EMValueCallBack< EMGroup >	callback )

Adds a group admin. Only the group owner can call this method and admin can not. For the synchronous method, see addGroupAdmin(String, String)

This is an asynchronous method.

Parameters

groupId	The group ID.
admin	The new owner ID.
callback	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the updated group instance; If this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncAddUsersToGroup()

void com.hyphenate.chat.EMGroupManager.asyncAddUsersToGroup	(	final String	groupId,
		final String[]	newmembers,
		final EMCallBack	callback )

Adds users to the group. Only the group owner or admin can call this method. For the synchronous method, see addUsersToGroup(String, String[]).

This is an asynchronous method.

Parameters

groupId	The group ID.
newmembers	The array of new members to add.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; If this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncApplyJoinToGroup()

void com.hyphenate.chat.EMGroupManager.asyncApplyJoinToGroup	(	final String	groupId,
		final String	reason,
		final EMCallBack	callback )

Requests to join a group. Note: The group config isPublic=true and joinApprovalRequired=true, so the public group requires join approval. For the synchronous method, see applyJoinToGroup(String, String).

This is an asynchronous method.

Parameters

groupId	The group ID.
reason	The reason for requesting to joining the group.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncBlockGroupMessage()

void com.hyphenate.chat.EMGroupManager.asyncBlockGroupMessage	(	final String	groupId,
		final EMCallBack	callback )

Blocks group messages. The user that blocks group messages is still a group member, but can't receive group messages. For the synchronous method, see blockGroupMessage(String).

This is an asynchronous method.

Parameters

groupId	The group ID.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncBlockUser()

void com.hyphenate.chat.EMGroupManager.asyncBlockUser	(	final String	groupId,
		final String	username,
		final EMCallBack	callback )

Adds the user to the group blocklist. Users will be first removed from the group they have joined before being added to the group blocklist. The users on the group blocklist can not join the group again. Only the group owner or admin can call this method. For the synchronous method, see blockUser(String, String).

This is an asynchronous method.

Parameters

groupId	The group ID.
username	The user to be added to the blocklist.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; If this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncBlockUsers()

void com.hyphenate.chat.EMGroupManager.asyncBlockUsers	(	final String	groupId,
		final List< String >	members,
		final EMCallBack	callback )

Adds the user to the group blocklist. Users will be first removed from the group they have joined before being added to the group blocklist. The users on the group blocklist can not join the group again. Only the group owner or admin can call this method. For the synchronous method, see blockUsers(String, List).

This is an asynchronous method.

Parameters

groupId	The group ID.
members	The list of users to be blocked.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncChangeGroupAvatar()

void com.hyphenate.chat.EMGroupManager.asyncChangeGroupAvatar	(	final String	groupId,
		final String	changedGroupAvatar,
		final EMCallBack	callback )

Changes the group avatar.

Only the group owner or admin can call this method.

For the synchronous method, see changeGroupAvatar(String, String).

This is an asynchronous method.

Parameters

groupId	The ID of group whose name is to be changed.
changedGroupAvatar	The new group avatar.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncChangeGroupDescription()

void com.hyphenate.chat.EMGroupManager.asyncChangeGroupDescription	(	final String	groupId,
		final String	changedDescription,
		final EMCallBack	callBack )

Changes the group description.

Only the group owner or admin can call this method.

For the synchronous method, see changeGroupDescription(String, String).

This is an asynchronous method.

Parameters

groupId	The group ID.
changedDescription	The new group description.
callBack	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncChangeGroupName()

void com.hyphenate.chat.EMGroupManager.asyncChangeGroupName	(	final String	groupId,
		final String	changedGroupName,
		final EMCallBack	callback )

Changes the group name.

Only the group owner or admin can call this method.

For the synchronous method, see changeGroupName(String, String).

This is an asynchronous method.

Parameters

groupId	The ID of group whose name is to be changed.
changedGroupName	The new group name.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncChangeOwner()

void com.hyphenate.chat.EMGroupManager.asyncChangeOwner	(	final String	groupId,
		final String	newOwner,
		final EMValueCallBack< EMGroup >	callback )

Transfers the group ownership. Only the group owner can call this method. For the synchronous method, see changeOwner(String, String)。

This is an asynchronous method.

Parameters

groupId	The group ID.
newOwner	The new owner ID.
callback	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the updated group instance; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncCheckIfInMuteList()

void com.hyphenate.chat.EMGroupManager.asyncCheckIfInMuteList	(	final String	groupId,
		final EMValueCallBack< Boolean >	callBack )

Checks whether the current member is muted or not.

This is an asynchronous method.

Parameters

groupId	The group ID.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` to show whether the member is be muted or not; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncCreateGroup()

void com.hyphenate.chat.EMGroupManager.asyncCreateGroup	(	final String	groupName,
		final String	avatar,
		final String	desc,
		final String[]	allMembers,
		final String	reason,
		final EMGroupConfigs	configs,
		final EMValueCallBack< EMGroup >	callback )

Creates a group instance. After the group is created, the data in the cache and database will be updated and multiple devices will receive the notification event and update the group to the cache and database. You can set com.hyphenate.EMMultiDeviceListener to listen on the event. The event callback function is com.hyphenate.EMMultiDeviceListener#onGroupEvent(int, String, List), where the first parameter is the event, for example, com.hyphenate.EMMultiDeviceListener#GROUP_CREATE for the group creation event.

This is an asynchronous method.

Parameters

groupName	The group name. It is optional. Pass null if you do not want to set this parameter.
avatar	群组的头像，需要传入头像的 URL 地址，非必要，不设置传null。
desc	The group description. It is optional. Pass null if you do not want to set this parameter.
allMembers	The group member array. The group owner ID is optional. This parameter can not be null.
reason	The group joining invitation. It is optional. Pass null if you do not want to set this parameter.
configs	The configs for creating a group. They are optional and can not be null. See `EMGroupConfigs`. The configs are: The maximum number of group members. The default value is 200. Whether the group is public. Whether joining a public group requires approval. Whether members are allowed to invite users to a private group. Whether invitees need to confirm before joining. Group detail extension.
callback	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the created group object; If this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncDeclineApplication()

void com.hyphenate.chat.EMGroupManager.asyncDeclineApplication	(	final String	username,
		final String	groupId,
		final String	reason,
		final EMCallBack	callback )

Declines a group request. Only the group owner or admin can call this method. For the synchronous method, see declineApplication(String, String, String).

This is an asynchronous method.

Parameters

username	The ID of the user who sends the request to join the group.
groupId	The group ID.
reason	The reason of declining.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncDeclineInvitation()

void com.hyphenate.chat.EMGroupManager.asyncDeclineInvitation	(	final String	groupId,
		final String	inviter,
		final String	reason,
		final EMCallBack	callback )

Declines a group invitation. For the synchronous method, see declineInvitation(String, String, String).

This is an asynchronous method.

Parameters

groupId	The group ID.
inviter	The inviter ID.
reason	The reason for declining.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncDeleteGroupSharedFile()

void com.hyphenate.chat.EMGroupManager.asyncDeleteGroupSharedFile	(	final String	groupId,
		final String	fileId,
		final EMCallBack	callBack )

Removes the shared file of the group. Group members can delete their own uploaded files. The group owner or admin can delete all shared files. For the synchronous method, see deleteGroupSharedFile(String, String).

This is an asynchronous method.

Parameters

groupId	The group ID.
fileId	The shared file ID.
callBack	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncDestroyGroup()

void com.hyphenate.chat.EMGroupManager.asyncDestroyGroup	(	final String	groupId,
		final EMCallBack	callback )

Destroys the group instance. Only the group owner can call this method. For the synchronous method, see destroyGroup(String).

This is an asynchronous method.

Parameters

groupId	The group ID.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncDownloadGroupSharedFile()

void com.hyphenate.chat.EMGroupManager.asyncDownloadGroupSharedFile	(	final String	groupId,
		final String	fileId,
		final String	savePath,
		final EMCallBack	callBack )

Downloads the shared file of the group. For synchronous method, see downloadGroupSharedFile(String, String, String, EMCallBack).

This is an asynchronous method.

Parameters

groupId	The group ID.
fileId	The shared file ID.
savePath	The file path.
callBack	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`. Calls `EMCallBack#onProgress(int, String)` to view the file download progress.

◆ asyncFetchGroupAnnouncement()

void com.hyphenate.chat.EMGroupManager.asyncFetchGroupAnnouncement	(	final String	groupId,
		final EMValueCallBack< String >	callBack )

Gets the group announcement from the server. Group members can call this method. For the synchronous method, see fetchGroupAnnouncement(String).

This is an asynchronous method.

Parameters

groupId	The group ID.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)`; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncFetchGroupBlackList()

void com.hyphenate.chat.EMGroupManager.asyncFetchGroupBlackList	(	final String	groupId,
		final int	pageNum,
		final int	pageSize,
		final EMValueCallBack< List< String > >	callBack )

Gets the blocklist of group from the server with pagination. Only the group owner or admin can call this method. For the synchronous method, see fetchGroupBlackList(String, int, int).

This is an asynchronous method.

Parameters

groupId	The group ID.
pageNum	The page number, starting from 1.
pageSize	The number of users on the blocklist per page.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the group blocklist on the next page; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncFetchGroupMemberAllAttributes()

void com.hyphenate.chat.EMGroupManager.asyncFetchGroupMemberAllAttributes	(	String	groupId,
		String	userId,
		EMValueCallBack< Map< String, Map< String, String > > >	callBack )

Gets all custom attributes of a group member.

Parameters

groupId	The group ID.
userId	The user ID of the group member whose all custom attributes are retrieved.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)`; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncFetchGroupMembers()

void com.hyphenate.chat.EMGroupManager.asyncFetchGroupMembers	(	final String	groupId,
		final String	cursor,
		final int	pageSize,
		final EMValueCallBack< EMCursorResult< String > >	callback )

Gets a group's member list with pagination. For the synchronous method, see fetchGroupMembers(String, String, int).

This is an asynchronous method.

Parameters

groupId	The group ID.
cursor	The cursor position from which to start to get data next time. Sets the parameter as null for the first time.
pageSize	The number of group members per page.
callback	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the result of `EMCursorResult`, including the cursor for getting data next time and the group member list. For the last page, the return value of cursor is an empty string. If this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncFetchGroupMembersAttributes()

void com.hyphenate.chat.EMGroupManager.asyncFetchGroupMembersAttributes	(	String	groupId,
		List< String >	userList,
		List< String >	keyList,
		EMValueCallBack< Map< String, Map< String, String > > >	callBack )

Gets custom attributes of multiple group members by attribute key.

Parameters

groupId	The group ID.
userList	The array of user IDs of group members whose custom attributes are retrieved.
keyList	The array of keys of custom attributes to be retrieved. If you pass in an empty array or do not set this parameter, the SDK gets all custom attributes of these group members.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)`; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncFetchGroupMembersInfo()

void com.hyphenate.chat.EMGroupManager.asyncFetchGroupMembersInfo	(	final String	groupId,
		String	cursor,
		final int	pageSize,
		final EMValueCallBack< EMCursorResult< EMGroupMemberInfo > >	callback )

Gets a group's member info list .

This is an asynchronous method.

Parameters

groupId	The group ID.
cursor	The cursor position from which to start to get data next time. Sets the parameter as null for the first time.
pageSize	The number of group members per page. The value range is [1, 50].
callback	The completion callback. If this call succeeds, it will callback `EMValueCallBack#onSuccess(Object)`, the Object `EMCursorResult<EMGroupMemberInfo>` includes the cursor for getting data next time and the group member info list. For the last page, the return value of cursor is an empty string. If this call fails, calls `EMValueCallBack#onError(int, String)`.It contains the error code and error message.

◆ asyncFetchGroupMuteList()

void com.hyphenate.chat.EMGroupManager.asyncFetchGroupMuteList	(	final String	groupId,
		final int	pageNum,
		final int	pageSize,
		final EMValueCallBack< Map< String, Long > >	callBack )

Gets the mutelist of the group from the server. Only the group owner or admin can call this method. For the asynchronous method, see fetchGroupMuteList(String, int, int).

This is an asynchronous method.

Parameters

groupId	The group ID.
pageNum	The page number, starting from 1.
pageSize	The number of muted members per page.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and The map which contains the muted member ID and mute duration, where the key of each entry is the ID of a muted member and the value is the mute duration in milliseconds. If this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncFetchGroupSharedFileList()

void com.hyphenate.chat.EMGroupManager.asyncFetchGroupSharedFileList	(	final String	groupId,
		final int	pageNum,
		final int	pageSize,
		final EMValueCallBack< List< EMMucSharedFile > >	callBack )

Gets the shared file list from the server. For the synchronous method, see fetchGroupSharedFileList(String, int, int).

This is an asynchronous method.

Parameters

groupId	The group ID.
pageNum	The page number, starting from 1.
pageSize	The number of shared files per page.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the shared files; if this call fails, calls `EMValueCallBack#onError(int, String)`.

Note the following:

pageSize specifies the number of shared files expected to return for this call. For the last page, the actual number of returned shared files is less than the value of pageSize.
pageNum specifies the number of the current page on which the returned data is presented. For a large but unknown quantity of data, the server will return data as specified by pageSize and pageNum.

◆ asyncGetBlockedUsers() [1/2]

void com.hyphenate.chat.EMGroupManager.asyncGetBlockedUsers	(	final String	groupId,
		final EMValueCallBack< List< String > >	callback )

Gets the group blocklist that can contain a maximum of 200 users by default. Only the group owner or admin can call this method. For the synchronous method, see getBlockedUsers(String).

This is an asynchronous method.

Parameters

groupId	The group ID.
callback	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)`; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncGetBlockedUsers() [2/2]

void com.hyphenate.chat.EMGroupManager.asyncGetBlockedUsers	(	final String	groupId,
		final int	pageIndex,
		final int	pageSize,
		final EMValueCallBack< List< String > >	callback )

Gets the group blocklist with pagination. Only the group owner or admin can call this method. For the synchronous method, see getBlockedUsers(String, int, int).

This is an asynchronous method.

Parameters

groupId	The group ID.
pageIndex	The page number, starting from 1.
pageSize	The number of groups per page.
callback	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the group blocklist; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncGetGroupFromServer()

void com.hyphenate.chat.EMGroupManager.asyncGetGroupFromServer	(	final String	groupId,
		final EMValueCallBack< EMGroup >	callback )

Gets group information from the server.

For the synchronous method, see getGroupFromServer(String).

This is an asynchronous method.

Parameters

groupId	The group ID.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncGetJoinedGroupsCountFromServer()

void com.hyphenate.chat.EMGroupManager.asyncGetJoinedGroupsCountFromServer ( final EMValueCallBack< Integer > callback )

Gets groups count of the current user joined from the server.

This is an asynchronous method.

Parameters

callback The completion callback. If this call succeeds, calls EMValueCallBack#onSuccess(Object) and returns the group count if this call fails, calls EMValueCallBack#onError(int, String);

◆ asyncInviteUser()

void com.hyphenate.chat.EMGroupManager.asyncInviteUser	(	final String	groupId,
		final String[]	beInvitedUsernames,
		final String	reason,
		final EMCallBack	callback )

Invites users to join a group. Note: The group config allowInvites=true allows group members to invite users. For the synchronous method, see inviteUser(String, String[], String)。

The is an asynchronous method.

Parameters

groupId	The group ID.
beInvitedUsernames	The array of users to be invited.
reason	The reason for invitation.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncJoinGroup()

void com.hyphenate.chat.EMGroupManager.asyncJoinGroup	(	final String	groupId,
		final EMCallBack	callback )

Joins a public group.

For a public group with joinApprovalRequired=false, users can join directly. For a public group with joinApprovalRequired=true, users must wait for approval.

For the synchronous method, see joinGroup(String).

This is an asynchronous method.

Parameters

groupId	The group ID.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncLeaveGroup()

void com.hyphenate.chat.EMGroupManager.asyncLeaveGroup	(	final String	groupId,
		final EMCallBack	callback )

Leaves a group.

This is an asynchronous method.

Parameters

groupId	The group ID.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; If this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncMuteGroupMembers()

void com.hyphenate.chat.EMGroupManager.asyncMuteGroupMembers	(	final String	groupId,
		final List< String >	muteMembers,
		final long	duration,
		final EMValueCallBack< EMGroup >	callback )

Mutes group members. Only the group owner or admin can call this method. For the synchronous method, see muteGroupMembers(String, List, long).

This is an asynchronous method.

Parameters

groupId	The group ID.
muteMembers	The list of members to be muted.
duration	The mute duration in milliseconds. The value `-1` indicates that the members are muted permanently.
callback	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the updated group instance; If this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncRemoveGroupAdmin()

void com.hyphenate.chat.EMGroupManager.asyncRemoveGroupAdmin	(	final String	groupId,
		final String	admin,
		final EMValueCallBack< EMGroup >	callback )

Removes a group admin. Only the group owner can call this method. For the synchronous method, see removeGroupAdmin(String, String).

This is an asynchronous method.

Parameters

groupId	The group ID.
admin	The admin ID to remove.
callback	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the updated group instance; if this call succeeds, calls `EMValueCallBack#onError(int, String)`.

◆ asyncRemoveUserFromGroup()

void com.hyphenate.chat.EMGroupManager.asyncRemoveUserFromGroup	(	final String	groupId,
		final String	username,
		final EMCallBack	callback )

Removes a member from the group. Only the group owner or admin can call this method. For the synchronous method, see removeUserFromGroup(String, String).

This is an asynchronous method.

Parameters

groupId	The group ID.
username	The user ID of the member to be removed.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncRemoveUsersFromGroup()

void com.hyphenate.chat.EMGroupManager.asyncRemoveUsersFromGroup	(	final String	groupId,
		final List< String >	members,
		final EMCallBack	callback )

Removes members from the group. Only the group owner or admin can call this method. For the synchronous method, see removeUsersFromGroup(String, List).

This is an asynchronous method.

Parameters

groupId	The group ID.
members	The user IDs of members to be removed.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncSetGroupMemberAttributes()

void com.hyphenate.chat.EMGroupManager.asyncSetGroupMemberAttributes	(	String	groupId,
		String	userId,
		Map< String, String >	attributeMap,
		EMCallBack	callBack )

Sets custom attributes of a group member.

Parameters

groupId	The group ID.
userId	The user ID of the group member for whom the custom attributes are set.
attributeMap	The map of custom attributes in key-value format. In a key-value pair, if the value is set to an empty string, the custom attribute will be deleted.
callBack	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncUnblockGroupMessage()

void com.hyphenate.chat.EMGroupManager.asyncUnblockGroupMessage	(	final String	groupId,
		final EMCallBack	callback )

Unblocks group messages. For the synchronous method, see unblockGroupMessage(String).

This is an asynchronous method.

Parameters

groupId	The group ID
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncUnblockUser()

void com.hyphenate.chat.EMGroupManager.asyncUnblockUser	(	final String	groupId,
		final String	username,
		final EMCallBack	callback )

Removes a user from the group blocklist. Only the group owner or admin can call this method. For the synchronous method, see unblockUser(String, String).

This is an asynchronous method.

Parameters

groupId	The group ID.
username	The user to be removed from the group blocklist.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncUnblockUsers()

void com.hyphenate.chat.EMGroupManager.asyncUnblockUsers	(	final String	groupId,
		final List< String >	members,
		final EMCallBack	callback )

Removes users from the group blocklist. Only the group owner or admin can call this method. For the synchronous method, see unblockUsers(String, List).

This is an asynchronous method.

Parameters

groupId	The group ID.
members	The users to be removed from the bloclist.
callback	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncUnMuteGroupMembers()

void com.hyphenate.chat.EMGroupManager.asyncUnMuteGroupMembers	(	final String	groupId,
		final List< String >	members,
		final EMValueCallBack< EMGroup >	callback )

Unmutes group members. Only the group owner or admin can call this method. For the synchronious method, see unMuteGroupMembers(String, List).

This is an asynchronous method.

Parameters

groupId	The group ID.
members	The list of members to be unmuted.
callback	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the updated group instance; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncUpdateGroupAnnouncement()

void com.hyphenate.chat.EMGroupManager.asyncUpdateGroupAnnouncement	(	final String	groupId,
		final String	announcement,
		final EMCallBack	callBack )

Updates the group announcement. Only the group owner or admin can call this method. For the synchronous method, see updateGroupAnnouncement(String, String)

This is an asynchronous method.

Parameters

groupId	The group ID.
announcement	The group announcement.
callBack	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncUpdateGroupConfigs()

void com.hyphenate.chat.EMGroupManager.asyncUpdateGroupConfigs	(	final String	groupId,
		final EnumSet< EMGroupConfigsType >	types,
		final EMGroupConfigs	configs,
		final EMValueCallBack< EMGroup >	callback )

Batch updates group configs.

This is an asynchronous method.

Parameters

groupId	The group ID.
types	The group config types to update. Available values include `EMGroupConfigsType#IS_PUBLIC`, `EMGroupConfigsType#JOIN_APPROVAL_REQUIRED`, `EMGroupConfigsType#ALLOW_INVITES`, `EMGroupConfigsType#MAX_USERS`, `EMGroupConfigsType#INVITE_NEED_CONFIRM`, and `EMGroupConfigsType#EXT`.
configs	The group configs. The SDK only reads fields selected by types.
callback	The completion callback.

◆ asyncUpdateGroupExtension()

void com.hyphenate.chat.EMGroupManager.asyncUpdateGroupExtension	(	final String	groupId,
		final String	extension,
		final EMValueCallBack< EMGroup >	callBack )

Updates the group extension field.

Only the group owner or admin can call this method.

This is an asynchronous method.

For the synchronous method, see updateGroupExtension(String, String).

Parameters

groupId	The group ID.
extension	The group extension field.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)`; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ asyncUpdateGroupNamecard()

void com.hyphenate.chat.EMGroupManager.asyncUpdateGroupNamecard	(	final String	groupId,
		final String	namecard,
		final EMCallBack	callBack )

Sets the name card of the current user in the specified group. This is an asynchronous method.

Parameters

groupId	The group ID.
namecard	The name card of the current user in the group. Pass null to clear the name card for the user in the group.
callBack	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ asyncUploadGroupSharedFile()

void com.hyphenate.chat.EMGroupManager.asyncUploadGroupSharedFile	(	final String	groupId,
		final String	filePath,
		final EMValueCallBack< EMMucSharedFile >	callBack )

Uploads the shared file to the group.

For the synchronous method, see uploadGroupSharedFile(String, String, EMCallBack).

This is an asynchronous method.

Parameters

groupId	The group ID.
filePath	The local file path.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)`; if this call fails, calls `EMValueCallBack#onError(int, String)`. Calls `EMValueCallBack#onSuccess(Object)` to view the upload progress.

◆ blockGroupMessage()

void com.hyphenate.chat.EMGroupManager.blockGroupMessage ( String groupId ) throws HyphenateException

Blocks group messages. The user that blocks group messages is still a group member, but can't receive group messages. For the asynchronous method, see asyncBlockGroupMessage(String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId The group ID.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ blockUser()

void com.hyphenate.chat.EMGroupManager.blockUser	(	String	groupId,
		String	username ) throws HyphenateException

Adds the user to the group blocklist. Users will be first removed from the group they have joined before being added to the group blocklist. The users on the group blocklist can not join the group again. Only the group owner or admin can call this method. For the asynchronous method, see asyncBlockUser(String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
username	The user to be added to the blocklist.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ blockUsers()

void com.hyphenate.chat.EMGroupManager.blockUsers	(	String	groupId,
		List< String >	members ) throws HyphenateException

Adds the user to the group blocklist. Users will be first removed from the group they have joined before being added to the group blocklist. The users on the group blocklist can not join the group again. Only the group owner or admin can call this method. For the asynchronous method, see asyncBlockUsers(String, List, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
members	The list of users to be added to the blocklist.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ changeGroupAvatar()

void com.hyphenate.chat.EMGroupManager.changeGroupAvatar	(	String	groupId,
		String	changedAvatar ) throws HyphenateException

Changes the group avatar.

Only the group owner or admin can call this method.

For the asynchronous method, see asyncChangeGroupAvatar(String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The ID of group whose name is to be changed.
changedAvatar	The new group avatar.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ changeGroupDescription()

void com.hyphenate.chat.EMGroupManager.changeGroupDescription	(	String	groupId,
		String	changedDescription ) throws HyphenateException

Changes the group description.

Only the group owner or admin can call this method.

For the asynchronous method, see asyncChangeGroupDescription(String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
changedDescription	The new group description.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ changeGroupName()

void com.hyphenate.chat.EMGroupManager.changeGroupName	(	String	groupId,
		String	changedGroupName ) throws HyphenateException

Changes the group name.

Only the group owner or admin can call this method.

For the asynchronous method, see asyncChangeGroupName(String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The ID of group whose name is to be changed.
changedGroupName	The new group name.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ changeOwner()

EMGroup com.hyphenate.chat.EMGroupManager.changeOwner	(	String	groupId,
		String	newOwner ) throws HyphenateException

Transfers the group ownership. Only the group owner can call this method. For the asynchronous method, see asyncChangeOwner(String, String, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
newOwner	The new owner ID.

Returns: The updated group instance.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ checkIfInGroupWhiteList()

void com.hyphenate.chat.EMGroupManager.checkIfInGroupWhiteList	(	final String	groupId,
		EMValueCallBack< Boolean >	callBack )

Gets whether the member is on the allowlist.

This is an asynchronous method.

Parameters

groupId	The group ID.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns a Boolean value to indicate whether the current user is on the group blocklist; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ cleanAllGroupsFromLocal()

void com.hyphenate.chat.EMGroupManager.cleanAllGroupsFromLocal ( )

Clears all local group details from the database and memory.

◆ createGroup()

EMGroup com.hyphenate.chat.EMGroupManager.createGroup	(	String	groupName,
		String	avatar,
		String	desc,
		String[]	allMembers,
		String	reason,
		EMGroupConfigs	configs ) throws HyphenateException

Creates a group instance. After the group is created, the data in the cache and database will be updated and multiple devices will receive the notification event and update the group to the cache and database. You can set com.hyphenate.EMMultiDeviceListener to listen on the event. The event callback function is com.hyphenate.EMMultiDeviceListener#onGroupEvent(int, String, List), where the first parameter is the event, for example, com.hyphenate.EMMultiDeviceListener#GROUP_CREATE for the group creation event. For the asynchronous method, see asyncCreateGroup(String, String, String, String[], String, EMGroupConfigs, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupName	The group name. It is optional. Pass null if you do not want to set this parameter.
avatar	The group avatar. It is optional. Pass null if you do not want to set this parameter.
desc	The group description. It is optional. Pass null if you do not want to set this parameter.
allMembers	The group member array. The group owner ID is optional. This parameter can not be null.
reason	The group joining invitation. It is optional. Pass null if you do not want to set this parameter.
configs	The configs for creating a group. They are optional and can not be null. See `EMGroupConfigs`. The configs are: The maximum number of group members. The default value is 200. Whether the group is public. Whether joining a public group requires approval. Whether members are allowed to invite users to a private group. Whether invitees need to confirm before joining. Group detail extension.

Returns: The created group instance.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ declineApplication()

void com.hyphenate.chat.EMGroupManager.declineApplication	(	String	username,
		String	groupId,
		String	reason ) throws HyphenateException

Declines a group request. Only the group owner or admin can call this method. For the asynchronous method, see asyncDeclineApplication(String, String, String, EMCallBack).

Only the group owner or admin can call this method.

Parameters

username	The ID of the user who sends the request for join the group.
groupId	The group ID.
reason	The reason of declining.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ declineInvitation()

void com.hyphenate.chat.EMGroupManager.declineInvitation	(	String	groupId,
		String	inviter,
		String	reason ) throws HyphenateException

Declines a group invitation. For the asynchronous method, see asyncDeclineInvitation(String, String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
inviter	The inviter.
reason	The reason for declining.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ deleteGroupSharedFile()

void com.hyphenate.chat.EMGroupManager.deleteGroupSharedFile	(	String	groupId,
		String	fileId ) throws HyphenateException

Removes a shared file of the group. Group members can delete their own uploaded files. The group owner or admin can delete all shared files. For the asynchronous method, see asyncDeleteGroupSharedFile(String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
fileId	The shared file ID.

Exceptions

HyphenateException Only the group owner or admin can call this method. See EMError.

◆ destroyGroup()

void com.hyphenate.chat.EMGroupManager.destroyGroup ( final String groupId ) throws HyphenateException

Destroys the group instance. Only the group owner can call this method. For the asynchronous method, see asyncDestroyGroup(String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId The group ID.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ downloadGroupSharedFile()

void com.hyphenate.chat.EMGroupManager.downloadGroupSharedFile	(	String	groupId,
		String	fileId,
		String	savePath,
		EMCallBack	callBack ) throws HyphenateException

Downloads the shared file of the group. Note: The callback is only used for progress callback. For the asynchronous method, see asyncDownloadGroupSharedFile(String, String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
fileId	The ID of the shared file.
savePath	The local file path.
callBack	The file download progress callback.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ fetchGroupAnnouncement()

String com.hyphenate.chat.EMGroupManager.fetchGroupAnnouncement ( String groupId ) throws HyphenateException

Gets the group announcement from the server. Group members can call this method. For the asynchronous method, see asyncFetchGroupAnnouncement(String, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId The group ID.

Returns: The group announcement.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ fetchGroupBlackList()

List< String > com.hyphenate.chat.EMGroupManager.fetchGroupBlackList	(	String	groupId,
		int	pageNum,
		int	pageSize ) throws HyphenateException

Gets the blocklist of group from the server with pagination. Only the group owner or admin can call this method. For the asynchronous method, see asyncFetchGroupBlackList(String, int, int, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
pageNum	The page number, starting from 1.
pageSize	The number of users on the blocklist per page.

Returns: The group blocklist on the next page.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ fetchGroupMembers()

EMCursorResult< String > com.hyphenate.chat.EMGroupManager.fetchGroupMembers	(	String	groupId,
		String	cursor,
		int	pageSize ) throws HyphenateException

Gets a group's member list with pagination. When EMCursorResult.getCursor() is an empty string ("") in the result, there is no more data. For the asynchronous method, see asyncFetchGroupMembers(String, String, int, EMValueCallBack).

Synchronization method will block the current thread.

For example:

EMCursorResult result = fetchGroupMembers(groupId, cursor, pageSize); // search 1

result = fetchGroupMembers(groupId, result.getCursor(), pageSize); // search 2

com.hyphenate.chat.EMCursorResult

Definition EMCursorResult.java:55

com.hyphenate.chat.EMCursorResult.getCursor

String getCursor()

Definition EMCursorResult.java:71

com.hyphenate.chat.EMGroupManager.fetchGroupMembers

EMCursorResult< String > fetchGroupMembers(String groupId, String cursor, int pageSize)

Definition EMGroupManager.java:2703

Parameters

groupId	The group ID.
cursor	The cursor position from which to start to get data next time. Sets the parameter as null for the first time.
pageSize	The number of group members per page.

Returns: The result of EMCursorResult, including the cursor for getting data next time and the group member list. For the last page, the return value of cursor is an empty string.

Exceptions

HyphenateException A description of the exception. See EMError

◆ fetchGroupMuteList()

Map< String, Long > com.hyphenate.chat.EMGroupManager.fetchGroupMuteList	(	String	groupId,
		int	pageNum,
		int	pageSize ) throws HyphenateException

Gets the mutelist of the group from the server. Only the group owner or admin can call this method. For the asynchronous method, see asyncFetchGroupMuteList(String, int, int, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
pageNum	The page number, starting from 1.
pageSize	The cursor position from which to start to get data next time.

Returns: A map which contains the muted member ID and mute duration, where the key of each entry is the ID of a muted member and the value is the mute duration in milliseconds.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ fetchGroupSharedFileList()

List< EMMucSharedFile > com.hyphenate.chat.EMGroupManager.fetchGroupSharedFileList	(	String	groupId,
		int	pageNum,
		int	pageSize ) throws HyphenateException

Gets the shared files of group from the server. For the asynchronous method, see asyncFetchGroupSharedFileList(String, int, int, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
pageNum	The page number, starting from 1.
pageSize	The number of shared files per page.

Returns: The shared files.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ fetchGroupWhiteList()

void com.hyphenate.chat.EMGroupManager.fetchGroupWhiteList	(	final String	groupId,
		final EMValueCallBack< List< String > >	callBack )

Gets the allowlist of group from the server. Only the group owner or admin can call this method.

This is an asynchronous method.

Parameters

groupId	The group ID.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and return the group blocklist; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ getAllGroups()

List< EMGroup > com.hyphenate.chat.EMGroupManager.getAllGroups ( )

Gets all groups of the current user (from the cache). Before a call to this method, call loadAllGroups() to load data from the group to the cache. If loadAllGroups() is not called, this method will load data from the database before loading from the cache.

Returns: The group list.

◆ getBlockedUsers() [1/2]

List< String > com.hyphenate.chat.EMGroupManager.getBlockedUsers ( String groupId ) throws HyphenateException

Gets the group blocklist that can contain a maximum of 200 users by default. Only the group owner or admin can call this method. For the asynchronous method, see asyncGetBlockedUsers(String, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId The group ID.

Returns: List The group blocklist.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ getBlockedUsers() [2/2]

List< String > com.hyphenate.chat.EMGroupManager.getBlockedUsers	(	String	groupId,
		int	pageIndex,
		int	pageSize ) throws HyphenateException

Gets the group blocklist from server with pagination. Only the group owner or admin can call this method. For the asynchronous method, see asyncGetBlockedUsers(String, int, int, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
pageIndex	The page number, starting from 1.
pageSize	The number of groups per page.

Returns: List The group blocklist.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ getGroup()

EMGroup com.hyphenate.chat.EMGroupManager.getGroup ( String groupId )

Gets the group instance from the cache by group ID.

Parameters

groupId The group ID.

Returns: The group instance. Returns null if the group does not exist.

◆ getGroupFromServer()

EMGroup com.hyphenate.chat.EMGroupManager.getGroupFromServer ( String groupId ) throws HyphenateException

Gets group information from the server. This method does not get member information. If member information is required, call fetchGroupMembers(String, String, int). For the asynchronous method, see asyncGetGroupFromServer(String, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId The group ID.

Returns: EMGroup The group instance.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ getGroupNamecard()

String com.hyphenate.chat.EMGroupManager.getGroupNamecard	(	String	groupId,
		String	userId )

Gets the name card of a user in a group from the local memory.

This is a synchronous method.

Parameters

groupId	The group ID.
userId	The user ID.

Returns: The name card content. The SDK returns null if no name card is found in the local memory.

◆ inviteUser()

void com.hyphenate.chat.EMGroupManager.inviteUser	(	String	groupId,
		String[]	beInvitedUsernames,
		String	reason ) throws HyphenateException

Invites users to join a group. Note: The group config allowInvites=true allows group members to invite users. For the asynchronous method, see asyncInviteUser(String, String[], String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
beInvitedUsernames	The array of users to be invited.
reason	The reason for invitation.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ joinGroup()

void com.hyphenate.chat.EMGroupManager.joinGroup ( String groupId ) throws HyphenateException

Joins a public group.

For a public group with joinApprovalRequired=false, users can join directly. For a public group with joinApprovalRequired=true, users must wait for approval.

For the asynchronous method, see asyncJoinGroup(String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId The group ID.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ leaveGroup()

void com.hyphenate.chat.EMGroupManager.leaveGroup ( String groupId ) throws HyphenateException

Leaves a group.

This is a synchronous method and blocks the current thread.

Parameters

groupId The group ID.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ muteAllMembers()

void com.hyphenate.chat.EMGroupManager.muteAllMembers	(	final String	groupId,
		final EMValueCallBack< EMGroup >	callBack )

Mutes all members. Only the group owner or admin can call this method.

This is an asynchronous method.

Parameters

groupId	The group ID.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the updated group instance; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ muteGroupMembers()

EMGroup com.hyphenate.chat.EMGroupManager.muteGroupMembers	(	String	groupId,
		List< String >	muteMembers,
		long	duration ) throws HyphenateException

Mutes group members. Only the group owner or admin can call this method. For the asynchronous method, see asyncMuteGroupMembers(String, List, long, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
muteMembers	The list of members to be muted.
duration	The mute duration in milliseconds. The value `-1` indicates that the members are muted permanently.

Returns: The updated group instance.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ removeFromGroupWhiteList()

void com.hyphenate.chat.EMGroupManager.removeFromGroupWhiteList	(	final String	groupId,
		final List< String >	members,
		final EMCallBack	callBack )

Removes members from the allowlist. Only the group owner or admin can call this method.

This is an asynchronous method.

Parameters

groupId	The group ID.
members	The members to be removed from the allowlist.
callBack	The completion callback. If this call succeeds, calls `EMCallBack#onSuccess()`; if this call fails, calls `EMCallBack#onError(int, String)`.

◆ removeGroupAdmin()

EMGroup com.hyphenate.chat.EMGroupManager.removeGroupAdmin	(	String	groupId,
		String	admin ) throws HyphenateException

Removes a group admin. Only the group owner can call this method. For the asynchronous method, see asyncRemoveGroupAdmin(String, String, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
admin	The admin ID to remove.

Returns: The updated group instance.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ removeGroupChangeListener()

void com.hyphenate.chat.EMGroupManager.removeGroupChangeListener ( EMGroupChangeListener listener )

Removes a group change listener. This method removes a group change listener registered with addGroupChangeListener(EMGroupChangeListener).

Parameters

listener The group event listener to be removed.

◆ removeUserFromGroup()

void com.hyphenate.chat.EMGroupManager.removeUserFromGroup	(	final String	groupId,
		final String	username ) throws HyphenateException

Removes a member from the group. Only the group owner or admin can call this method. For the asynchronous method, see asyncRemoveUserFromGroup(String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
username	The user ID of the member to be removed.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ removeUsersFromGroup()

void com.hyphenate.chat.EMGroupManager.removeUsersFromGroup	(	final String	groupId,
		final List< String >	members ) throws HyphenateException

Removes members from the group. Only the group owner or admin can call this method. For the asynchronous method, see removeUsersFromGroup(String, List)}.

Only the group owner or admin can call this method.

Parameters

groupId	The group ID.
members	The user IDs of members to be removed.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ unblockGroupMessage()

void com.hyphenate.chat.EMGroupManager.unblockGroupMessage ( String groupId ) throws HyphenateException

Unblocks group messages. For the asynchronous method, see asyncUnblockGroupMessage(String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId The group ID.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ unblockUser()

void com.hyphenate.chat.EMGroupManager.unblockUser	(	String	groupId,
		String	username ) throws HyphenateException

Removes a user from the group blocklist. Only the group owner or admin can call this method. For the asynchronous method, see asyncUnblockUser(String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
username	The user to be removed from the group blocklist.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ unblockUsers()

void com.hyphenate.chat.EMGroupManager.unblockUsers	(	String	groupId,
		List< String >	members ) throws HyphenateException

Removes users from the group blocklist. Only the group owner or admin can call this method. For the asynchronous method, see asyncBlockUsers(String, List, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
members	The users to be removed from the group blocklist.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ unmuteAllMembers()

void com.hyphenate.chat.EMGroupManager.unmuteAllMembers	(	final String	groupId,
		final EMValueCallBack< EMGroup >	callBack )

Unmutes all members. Only the group owner or admin can call this method.

This is an asynchronous method.

Parameters

groupId	The group ID.
callBack	The completion callback. If this call succeeds, calls `EMValueCallBack#onSuccess(Object)` and returns the updated group instance; if this call fails, calls `EMValueCallBack#onError(int, String)`.

◆ unMuteGroupMembers()

EMGroup com.hyphenate.chat.EMGroupManager.unMuteGroupMembers	(	String	groupId,
		List< String >	members ) throws HyphenateException

Unmutes group members. Only the group owner or admin can call this method. For the asynchronous method, see asyncUnMuteGroupMembers(String, List, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
members	The list of members to be muted.

Returns: The updated group instance.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ updateGroupAnnouncement()

void com.hyphenate.chat.EMGroupManager.updateGroupAnnouncement	(	String	groupId,
		String	announcement ) throws HyphenateException

Updates the group announcement. Only the group owner or admin can call this method. For the asynchronous method, see asyncUpdateGroupAnnouncement(String, String, EMCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
announcement	The group announcement.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ updateGroupConfigs()

EMGroup com.hyphenate.chat.EMGroupManager.updateGroupConfigs	(	String	groupId,
		EnumSet< EMGroupConfigsType >	types,
		EMGroupConfigs	configs ) throws HyphenateException

Batch updates group configs.

Only the group owner or admin can call this method.

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
types	The group config types to update. Available values include `EMGroupConfigsType#IS_PUBLIC`, `EMGroupConfigsType#JOIN_APPROVAL_REQUIRED`, `EMGroupConfigsType#ALLOW_INVITES`, `EMGroupConfigsType#MAX_USERS`, `EMGroupConfigsType#INVITE_NEED_CONFIRM`, and `EMGroupConfigsType#EXT`.
configs	The group configs. The SDK only reads fields selected by types.

Returns: The updated group.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ updateGroupExtension()

EMGroup com.hyphenate.chat.EMGroupManager.updateGroupExtension	(	String	groupId,
		String	extension ) throws HyphenateException

Updates the group extension field.

Only the group owner or admin can call this method. For the asynchronous method, see asyncUpdateGroupExtension(String, String, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
extension	The group extension field.

Exceptions

HyphenateException A description of the exception. See EMError.

◆ uploadGroupSharedFile()

EMMucSharedFile com.hyphenate.chat.EMGroupManager.uploadGroupSharedFile	(	String	groupId,
		String	filePath,
		EMCallBack	callBack ) throws HyphenateException

Uploads the shared file to the group. Note: The callback is only used for progress callback. For the asynchronous method, see asyncUploadGroupSharedFile(String, String, EMValueCallBack).

This is a synchronous method and blocks the current thread.

Parameters

groupId	The group ID.
filePath	The local file path.
callBack	The file upload progress callback.

Returns: The attribute object of the shared file.

Exceptions

HyphenateException A description of the exception. See EMError.

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

com/hyphenate/chat/EMGroupManager.java

Classes

Public Member Functions

Detailed Description

Member Function Documentation

◆ acceptApplication()

◆ acceptInvitation()

◆ addGroupAdmin()

◆ addGroupChangeListener()

◆ addToGroupWhiteList()

◆ addUsersToGroup() [1/2]

◆ addUsersToGroup() [2/2]

◆ applyJoinToGroup()

◆ asyncAcceptApplication()

◆ asyncAcceptInvitation()

◆ asyncAddGroupAdmin()

◆ asyncAddUsersToGroup()

◆ asyncApplyJoinToGroup()

◆ asyncBlockGroupMessage()

◆ asyncBlockUser()

◆ asyncBlockUsers()

◆ asyncChangeGroupAvatar()

◆ asyncChangeGroupDescription()

◆ asyncChangeGroupName()

◆ asyncChangeOwner()

◆ asyncCheckIfInMuteList()

◆ asyncCreateGroup()

◆ asyncDeclineApplication()

◆ asyncDeclineInvitation()

◆ asyncDeleteGroupSharedFile()

◆ asyncDestroyGroup()

◆ asyncDownloadGroupSharedFile()

◆ asyncFetchGroupAnnouncement()

◆ asyncFetchGroupBlackList()

◆ asyncFetchGroupMemberAllAttributes()

◆ asyncFetchGroupMembers()

◆ asyncFetchGroupMembersAttributes()

◆ asyncFetchGroupMembersInfo()

◆ asyncFetchGroupMuteList()

◆ asyncFetchGroupSharedFileList()

◆ asyncGetBlockedUsers() [1/2]

◆ asyncGetBlockedUsers() [2/2]

◆ asyncGetGroupFromServer()

◆ asyncGetJoinedGroupsCountFromServer()

◆ asyncInviteUser()

◆ asyncJoinGroup()

◆ asyncLeaveGroup()

◆ asyncMuteGroupMembers()

◆ asyncRemoveGroupAdmin()

◆ asyncRemoveUserFromGroup()

◆ asyncRemoveUsersFromGroup()

◆ asyncSetGroupMemberAttributes()

◆ asyncUnblockGroupMessage()

◆ asyncUnblockUser()

◆ asyncUnblockUsers()

◆ asyncUnMuteGroupMembers()

◆ asyncUpdateGroupAnnouncement()

◆ asyncUpdateGroupConfigs()

◆ asyncUpdateGroupExtension()

◆ asyncUpdateGroupNamecard()

◆ asyncUploadGroupSharedFile()

◆ blockGroupMessage()

◆ blockUser()

◆ blockUsers()

◆ changeGroupAvatar()

◆ changeGroupDescription()

◆ changeGroupName()

◆ changeOwner()

◆ checkIfInGroupWhiteList()

◆ cleanAllGroupsFromLocal()

◆ createGroup()

◆ declineApplication()

◆ declineInvitation()

◆ deleteGroupSharedFile()

◆ destroyGroup()

◆ downloadGroupSharedFile()

◆ fetchGroupAnnouncement()

◆ fetchGroupBlackList()

◆ fetchGroupMembers()

◆ fetchGroupMuteList()

◆ fetchGroupSharedFileList()