ChatGroupManager class
群组管理类，用于管理群组的创建，删除及成员管理等操作。
Constructors
Properties
- downloadCallback ↔ ChatDownloadCallback?
-
群文件下载回调。
getter/setter pair
- 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(
{required String groupId, required String inviter}) → Future< ChatGroup> - 接受入群邀请。
-
acceptJoinApplication(
{required String groupId, required String userId}) → 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? desc, List< String> ? inviteMembers, String? inviteReason, required ChatGroupOptions options}) → Future<ChatGroup> - 创建群组。
-
declineInvitation(
{required String groupId, required String inviter, String? reason}) → Future< void> - 拒绝入群邀请。
-
declineJoinApplication(
{required String groupId, required String userId, String? reason}) → Future< void> - 拒绝入群申请。
-
destroyGroup(
String groupId) → 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 = false}) → Future< ChatGroup> - 从服务器获取群组的详细信息。
-
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? - 获取群组事件监听
-
getGroupWithId(
String groupId) → Future< ChatGroup?> - 根据群组 ID，从本地缓存中获取指定群组。
-
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> - 当前登录用户加入公开群。
-
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 - 移出群组事件监听
- 删除指定的群组共享文件。
-
removeMemberAttributes(
{required String groupId, required List< String> keys, String? userId}) → Future<void> - 设置群成员自定义属性。
-
removeMembers(
String groupId, List< String> members) → Future<void> - 将群成员移出群组。
-
requestToJoinPublicGroup(
{required String groupId, String? reason}) → Future< void> - 申请加入群组。
-
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> - 更新群公告。
-
updateGroupExtension(
String groupId, String extension) → Future< void> - 更新群组扩展字段。
- 上传共享文件至群组。
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited