EMGroupManager class Null safety

The group manager class, which manages group creation and deletion, user joining and exiting the group, etc.

Properties

downloadCallback EMDownloadCallback?
group shared file download callback.
read / write
hashCode int
The hash code for this object.
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

acceptInvitation(String groupId, String inviter) Future<EMGroup>
Accepts a group invitation.
acceptJoinApplication(String groupId, String username) Future<void>
Approves a group request.
addAdmin(String groupId, String memberId) Future<void>
Adds a group admin.
addAllowList(String groupId, List<String> members) Future<void>
Adds members to the allow list of the group.
addGroupChangeListener(EMGroupEventListener listener) → void
Registers a group event listener.
@Deprecated("Switch to using addGroupManagerListener instead.")
addGroupManagerListener(EMGroupManagerListener listener) → void
Registers a group manager listener.
addMembers(String groupId, List<String> members, {String? welcome}) Future<void>
Adds users to the group.
addWhiteList(String groupId, List<String> members) Future<void>
Adds members to the allow list of the group.
@Deprecated("Switch to using addAllowList instead.")
blockGroup(String groupId) Future<void>
Blocks group messages.
blockMembers(String groupId, List<String> members) Future<void>
Adds the user to the block list of the group.
changeGroupDescription(String groupId, String desc) Future<void>
Changes the group description.
changeGroupName(String groupId, String name) Future<void>
Changes the group name.
changeOwner(String groupId, String newOwner) Future<void>
Transfers the group ownership.
clearAllGroupManagerListeners() → void
Removes all group manager listener.
createGroup({String? groupName, String? desc, List<String>? inviteMembers, String? inviteReason, required EMGroupOptions options}) Future<EMGroup>
Creates a group instance.
declineInvitation({required String groupId, required String inviter, String? reason}) Future<void>
Declines a group invitation.
declineJoinApplication(String groupId, String username, {String? reason}) Future<void>
Declines a group request.
destroyGroup(String groupId) Future<void>
Destroys the group instance.
downloadGroupSharedFile({required String groupId, required String fileId, required String savePath}) Future<void>
Downloads the shared file of the group.
fetchAllowListFromServer(String groupId) Future<List<String>>
Gets the allow list of the group from the server.
fetchAnnouncementFromServer(String groupId) Future<String?>
Gets the group announcement from the server.
fetchBlockListFromServer(String groupId, {int pageSize = 200, int pageNum = 1}) Future<List<String>>
Gets the group block list from server with pagination.
fetchGroupFileListFromServer(String groupId, {int pageSize = 200, int pageNum = 1}) Future<List<EMGroupSharedFile>>
Gets the shared files of the group from the server.
fetchGroupInfoFromServer(String groupId, {bool fetchMembers = false}) Future<EMGroup>
Gets the group information from the server.
fetchJoinedGroupsFromServer({int pageSize = 200, int pageNum = 1}) Future<List<EMGroup>>
Gets all groups of the current user from the server.
fetchMemberListFromServer(String groupId, {int pageSize = 200, String? cursor}) Future<EMCursorResult<String>>
Gets the member list of the group with pagination.
fetchMuteListFromServer(String groupId, {int pageSize = 200, int pageNum = 1}) Future<Map<String, int>>
Gets the mute list of the group from the server.
fetchPublicGroupsFromServer({int pageSize = 200, String? cursor}) Future<EMCursorResult<EMGroupInfo>>
Gets public groups from the server with pagination.
fetchWhiteListFromServer(String groupId) Future<List<String>>
Gets the allow list of the group from the server.
@Deprecated("Switch to using fetchAllowListFromServer instead.")
getBlockListFromServer(String groupId, {int pageSize = 200, int pageNum = 1}) Future<List<String>>
Gets the group block list from server with pagination.
@Deprecated("Switch to using fetchBlockListFromServer instead.")
getGroupAnnouncementFromServer(String groupId) Future<String?>
Gets the group announcement from the server.
@Deprecated("Switch to using fetchAnnouncementFromServer instead.")
getGroupFileListFromServer(String groupId, {int pageSize = 200, int pageNum = 1}) Future<List<EMGroupSharedFile>>
Gets the shared files of the group from the server.
@Deprecated("Switch to using fetchGroupFileListFromServer instead.")
getGroupMemberListFromServer(String groupId, {int pageSize = 200, String? cursor}) Future<EMCursorResult<String>>
Gets the member list of the group with pagination.
@Deprecated("Switch to using fetchMemberListFromServer instead.")
getGroupSpecificationFromServer(String groupId) Future<EMGroup>
Gets the group information from the server.
@Deprecated("Switch to using fetchGroupInfoFromServer instead.")
getGroupsWithoutNotice() Future<List<String>>
@Deprecated("Switch to using EMPushConfig#noDisturbGroupsFromServer instead.")
getGroupWithId(String groupId) Future<EMGroup?>
Gets the group instance from the cache by group ID.
getJoinedGroups() Future<List<EMGroup>>
Gets all groups of the current user from the cache.
getJoinedGroupsFromServer({int pageSize = 200, int pageNum = 1}) Future<List<EMGroup>>
Gets all groups of the current user from the server.
@Deprecated("Switch to using fetchJoinedGroupsFromServer instead.")
getMuteListFromServer(String groupId, {int pageSize = 200, int pageNum = 1}) Future<List<String>>
Gets the mute list of the group from the server.
@Deprecated("Switch to using fetchMuteListFromServer instead.")
getPublicGroupsFromServer({int pageSize = 200, String? cursor}) Future<EMCursorResult<EMGroup>>
Gets public groups from the server with pagination.
@Deprecated("Switch to using fetchPublicGroupsFromServer instead.")
getWhiteListFromServer(String groupId) Future<List<String>>
Gets the allow list of the group from the server.
@Deprecated("Switch to using fetchWhiteListFromServer instead.")
inviterUser(String groupId, List<String> members, {String? reason}) Future<void>
Invites users to join the group.
isMemberInAllowListFromServer(String groupId) Future<bool>
Gets whether the member is on the allow list of the group.
isMemberInWhiteListFromServer(String groupId) Future<bool>
Gets whether the member is on the allow list of the group.
@Deprecated("Switch to using isMemberInAllowListFromServer instead.")
joinPublicGroup(String groupId) Future<void>
Joins a public group.
leaveGroup(String groupId) Future<void>
Leaves a group.
muteAllMembers(String groupId) Future<void>
Mutes all members.
muteMembers(String groupId, List<String> members, {int duration = -1}) Future<void>
Mutes group members.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
removeAdmin(String groupId, String adminId) Future<void>
Removes a group admin.
removeAllowList(String groupId, List<String> members) Future<void>
Removes members from the allow list of the group.
removeGroupChangeListener(EMGroupEventListener listener) → void
Removes a group event listener.
@Deprecated("Switch to using removeGroupManagerListener instead.")
removeGroupManagerListener(EMGroupManagerListener listener) → void
Removes a group manager listener.
removeGroupSharedFile(String groupId, String fileId) Future<void>
Removes a shared file of the group.
removeMembers(String groupId, List<String> members) Future<void>
Removes a member from the group.
removeWhiteList(String groupId, List<String> members) Future<void>
Removes members from the allow list of the group.
@Deprecated("Switch to using removeAllowList instead.")
requestToJoinPublicGroup(String groupId, {String? reason}) Future<void>
Requests to join a group.
toString() String
A string representation of this object.
inherited
unblockGroup(String groupId) Future<void>
Unblocks group messages.
unblockMembers(String groupId, List<String> members) Future<void>
Removes users from the group block list.
unMuteAllMembers(String groupId) Future<void>
Unmutes all members.
unMuteMembers(String groupId, List<String> members) Future<void>
Unmutes group members.
updateGroupAnnouncement(String groupId, String announcement) Future<void>
Updates the group announcement.
updateGroupExtension(String groupId, String extension) Future<void>
Updates the group extension field.
uploadGroupSharedFile(String groupId, String filePath) Future<void>
Uploads the shared file to the group.

Operators

operator ==(Object other) bool
The equality operator.
inherited