群组管理类，用于管理群组的创建，删除及成员管理等操作。

Constructors

ChatGroupManager()

Properties

hashCode → int

The hash code for this object.

no setterinherited

runtimeType → Type

A representation of the runtime type of the object.

no setterinherited

Methods

acceptInvitation(String groupId, String inviter) → Future<ChatGroup>

接受入群邀请。

acceptJoinApplication(String groupId, String username) → Future<void>

批准入群申请。 仅群主有权限调用。

addAdmin(String groupId, String memberId) → Future<void>

添加群组管理员。 仅群主有权限调用。

addAllowList(String groupId, List<String> members) → Future<void>

添加群成员到白名单。 仅群主和管理员有权限调用。

addEventHandler(String identifier, ChatGroupEventHandler handler) → void

添加群组事件监听。

addMembers(String groupId, List<String> members, {String? welcome}) → Future<void>

邀请用户加入群组。

blockGroup(String groupId) → Future<void>

屏蔽群消息，服务器不再发送此群的消息给用户，群主不能屏蔽群消息。

blockMembers(String groupId, List<String> members) → Future<void>

将用户加入群组黑名单。 仅群主有权限调用。

changeGroupDescription(String groupId, String desc) → Future<void>

changeGroupName(String groupId, String name) → Future<void>

changeOwner(String groupId, String newOwner) → Future<void>

转让群主。 仅群主有权限调用。

clearAllGroupsFromLocal() → Future<void>

清理数据库中当前用户的所有群组。

clearEventHandlers() → void

清除所有事件监听。

createGroup({String? groupName, String? avatarUrl, String? desc, List<String>? inviteMembers, String? inviteReason, required ChatGroupOptions options}) → Future<ChatGroup>

创建群组。

declineInvitation({required String groupId, required String inviter, String? reason}) → Future<void>

拒绝入群邀请。

declineJoinApplication(String groupId, String username, {String? reason}) → Future<void>

拒绝入群申请。 仅群主有权限调用。

destroyGroup(String groupId) → Future<void>

解散群组。 仅群主有权限调用。

downloadGroupSharedFile({required String groupId, required String fileId, required String savePath}) → Future<void>

下载群共享文件。

fetchAllowListFromServer(String groupId) → Future<List<String>>

从服务器获取群组白名单列表。

fetchAnnouncementFromServer(String groupId) → Future<String?>

从服务器获取群公告。

fetchBlockListFromServer(String groupId, {int pageSize = 200, int pageNum = 1}) → Future<List<String>>

获取群组黑名单列表。 仅群主和管理员有权限调用。

fetchGroupFileListFromServer(String groupId, {int pageSize = 200, int pageNum = 1}) → Future<List<ChatGroupSharedFile>>

获取群共享文件列表。

fetchGroupInfoFromServer(String groupId, {bool? fetchMembers}) → Future<ChatGroup>

获取群组详情，包含群组 ID、名称、描述、基本属性、群主和管理员。

fetchGroupMembersInfo({required String groupId, String? cursor, int limit = 20}) → Future<ChatCursorResult<GroupMemberInfo>>

获取群组成员列表。

fetchJoinedGroupCount() → Future<int>

从服务器获取当前用户已加入的群组数量。

fetchJoinedGroupsFromServer({int pageSize = 20, int pageNum = 0, bool needMemberCount = false, bool needRole = false}) → Future<List<ChatGroup>>

从服务器分页获取当前用户加入的群组。

fetchMemberAttributes({required String groupId, String? userId}) → Future<Map<String, String>>

获取单个群成员所有自定义属性。

fetchMemberListFromServer(String groupId, {int pageSize = 200, String? cursor}) → Future<ChatCursorResult<String>>

从服务器获取群组成员列表（分页获取）。

fetchMembersAttributes({required String groupId, required List<String> userIds, List<String>? keys}) → Future<Map<String, Map<String, String>>>

根据指定的属性 key 获取多个群成员的自定义属性。

fetchMuteListFromServer(String groupId, {int pageSize = 200, int pageNum = 1}) → Future<Map<String, int>>

获取群组禁言列表。 仅群主和管理员有权限调用。

fetchPublicGroupsFromServer({int pageSize = 200, String? cursor}) → Future<ChatCursorResult<ChatGroupInfo>>

从服务器获取指定范围内的公开群。

getEventHandler(String identifier) → ChatGroupEventHandler?

获取群组事件监听

getGroupNamecard({required String groupId, required String userId}) → Future<String?>

获取群成员的群名片。

getGroupWithId(String groupId) → Future<ChatGroup?>

获取群组实例，如果不存在则创建。

getJoinedGroups() → Future<List<ChatGroup>>

获取本地缓存中当前用户的所有群组信息。

inviterUser(String groupId, List<String> members, {String? reason}) → Future<void>

邀请用户加入群组。

isMemberInAllowListFromServer(String groupId) → Future<bool>

查看当前用户是否在群组白名单中。

isMemberInGroupMuteList(String groupId) → Future<bool>

查看自己是否在群组禁言名单中。

joinPublicGroup(String groupId) → Future<void>

加入一个公开群组，群类型应该是 ChatGroupStylePublicOpenJoin。

leaveGroup(String groupId) → Future<void>

退出群组，群主不能退出群，只能销毁群。

muteAllMembers(String groupId) → Future<void>

设置全员禁言。 仅群主和管理员有权限调用。

muteMembers(String groupId, List<String> members, {int duration = -1}) → Future<void>

将群成员禁言。 仅群主和管理员有权限调用。

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeAdmin(String groupId, String adminId) → Future<void>

移除群组管理员。 仅群主有权限调用。

removeAllowList(String groupId, List<String> members) → Future<void>

从白名单中移除群成员。 仅群主和管理员有权限调用。

removeEventHandler(String identifier) → void

移出群组事件监听

removeGroupSharedFile(String groupId, String fileId) → Future<void>

删除群共享文件。

removeMemberAttributes({required String groupId, required List<String> keys, String? userId}) → Future<void>

删除群成员自定义属性。

removeMembers(String groupId, List<String> members) → Future<void>

将群成员移出群组。 仅群主有权限调用。

requestToJoinPublicGroup(String groupId, {String? reason}) → Future<void>

申请加入一个需批准的公开群组，群类型应该是 PublicJoinNeedApproval。

setMemberAttributes({required String groupId, required Map<String, String> attributes, String? userId}) → Future<void>

设置群成员自定义属性。

toString() → String

A string representation of this object.

inherited

unblockGroup(String groupId) → Future<void>

取消屏蔽群消息。

unblockMembers(String groupId, List<String> members) → Future<void>

从群组黑名单中移除用户。 仅群主有权限调用。

unMuteAllMembers(String groupId) → Future<void>

解除全员禁言。 仅群主和管理员有权限调用。

unMuteMembers(String groupId, List<String> members) → Future<void>

解除群成员禁言。 仅群主和管理员有权限调用。

updateGroupAnnouncement(String groupId, String announcement) → Future<void>

修改群公告。 仅群主和管理员有权限调用。

updateGroupAvatar({required String groupId, required String avatarUrl}) → Future<ChatGroup>

更改群组头像。 仅群主有权限调用。

updateGroupDesc(String groupId, String desc) → Future<void>

修改群组说明信息。 仅群主有权限调用。

updateGroupExtension(String groupId, String extension) → Future<void>

修改群扩展信息。 仅群主有权限调用。

updateGroupName(String groupId, String name) → Future<void>

修改群组名称。 仅群主有权限调用。

updateGroupNamecard({required String groupId, String? namecard}) → Future<void>

更新当前用户在群组中的群名片。

uploadGroupSharedFile(String groupId, String filePath) → Future<void>

上传群共享文件。

Operators

operator ==(Object other) → bool

The equality operator.

inherited