GroupManager class
Methods
-
acceptGroupApplication({required String gid, required String uid, String? handleMsg, String? operationID})
→ Future
-
管理员或者群主同意某人进入某群
注:主动申请入群需要通过管理员/群组处理,被别人拉入群不需要管理员/群组处理
gid
组id
uid
申请者用户ID
-
changeGroupMemberMute({required String groupID, required String userID, int seconds = 0, String? operationID})
→ Future
-
禁言群成员
groupID
群ID
userID
将被禁言的成员ID
seconds
被禁言的时间s,设置为0则为解除禁言
-
changeGroupMute({required String groupID, required bool mute, String? operationID})
→ Future
-
开启群禁言,所有群成员禁止发言
groupID
将开启群禁言的组ID
mute
true:开启,false:关闭
-
createGroup({String? groupName, String? notification, String? introduction, String? faceUrl, int? groupType, String? ex, required List<GroupMemberRole> list, String? operationID})
→ Future<GroupInfo>
-
创建一个组
groupName
群名
notification
公告
introduction
群介绍
faceUrl
群头像
groupType
组类型 GroupType
ex
额外信息
list
初创群成员以及其角色列表GroupMemberRole
-
dismissGroup({required String groupID, String? operationID})
→ Future
-
解散群
groupID
群ID
-
getGroupMemberList({required String groupId, int filter = 0, int offset = 0, int count = 0, String? operationID})
→ Future<List<GroupMembersInfo>>
-
分页获取组成员列表
groupId
群ID
filter
过滤成员 0所有,1普通成员, 2群主,3管理员,4管理员+普通成员
offset
开始下标
count
总数
-
getGroupMemberListByJoinTime({required String groupID, int offset = 0, int count = 0, int joinTimeBegin = 0, int joinTimeEnd = 0, List<String> excludeUserIDList = const [], String? operationID})
→ Future<List<GroupMembersInfo>>
-
根据加入时间分页获取组成员列表
groupID
群ID
joinTimeBegin
加入开始时间
joinTimeEnd
加入结束时间
offset
开始下标
count
总数
excludeUserIDList
排除的用户
-
getGroupMemberListMap({required String groupId, int filter = 0, int offset = 0, int count = 0, String? operationID})
→ Future<List>
-
分页获取组成员列表
groupId
群ID
filter
过滤成员 0所有,1普通成员, 2群主,3管理员,4管理员+普通成员
offset
开始下标
count
总数
-
getGroupMembersInfo({required String groupId, required List<String> uidList, String? operationID})
→ Future<List<GroupMembersInfo>>
-
查询组成员资料
groupId
组ID
uidList
用户ID列表
-
getGroupOwnerAndAdmin({required String groupID, String? operationID})
→ Future<List<GroupMembersInfo>>
-
获取群拥有者,管理员
groupId
群ID
-
getGroupsInfo({required List<String> gidList, String? operationID})
→ Future<List<GroupInfo>>
-
查询组信息
gidList
组ID列表
-
getJoinedGroupList({String? operationID})
→ Future<List<GroupInfo>>
-
查询已加入的组列表
-
getJoinedGroupListMap({String? operationID})
→ Future<List>
-
查询已加入的组列表
-
getRecvGroupApplicationList({String? operationID})
→ Future<List<GroupApplicationInfo>>
-
作为群主或者管理员,收到的群成员入群申请
-
getSendGroupApplicationList({String? operationID})
→ Future<List<GroupApplicationInfo>>
-
获取自己发出的入群申请记录
-
inviteUserToGroup({required String groupId, required List<String> uidList, String? reason, String? operationID})
→ Future<List<GroupInviteResult>>
-
邀请进组,直接进组无需同意。
groupId
组ID
uidList
用户ID列表
-
isJoinedGroup({required String gid, String? operationID})
→ Future<bool>
-
检查是否已加入组
gid
组ID
-
joinGroup({required String gid, String? reason, String? operationID, int joinSource = 3})
→ Future
-
申请加入组,需要通过管理员/群组同意。
joinSource
2:通过邀请 3:通过搜索 4:通过二维码
-
kickGroupMember({required String groupId, required List<String> uidList, String? reason, String? operationID})
→ Future<List<GroupInviteResult>>
-
移除组成员
groupId
组ID
uidList
用户ID列表
reason
备注说明
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
quitGroup({required String gid, String? operationID})
→ Future
-
退出组
-
refuseGroupApplication({required String gid, required String uid, String? handleMsg, String? operationID})
→ Future
-
管理员或者群主拒绝某人进入某群
注:主动申请入群需要通过管理员/群组处理,被别人拉入群不需要管理员/群组处理
gid
组id
uid
申请者用户ID
handleMsg
说明
-
searchGroupMembers({required String groupID, List<String> keywordList = const [], bool isSearchUserID = false, bool isSearchMemberNickname = false, int offset = 0, int count = 40, String? operationID})
→ Future<List<GroupMembersInfo>>
-
查询群
groupID
群id
keywordList
搜索关键词,目前仅支持一个关键词搜索,不能为空
isSearchUserID
是否以关键词搜成员id
isSearchMemberNickname
是否以关键词搜索成员昵称
offset
开始index
count
每次获取的总数
-
searchGroupMembersListMap({required String groupID, List<String> keywordList = const [], bool isSearchUserID = false, bool isSearchMemberNickname = false, int offset = 0, int count = 40, String? operationID})
→ Future<List>
-
查询群
groupID
群id
keywordList
搜索关键词,目前仅支持一个关键词搜索,不能为空
isSearchUserID
是否以关键词搜成员id
isSearchMemberNickname
是否以关键词搜索成员昵称
offset
开始index
count
每次获取的总数
-
searchGroups({List<String> keywordList = const [], bool isSearchGroupID = false, bool isSearchGroupName = false, String? operationID})
→ Future<List<GroupInfo>>
-
查询群
keywordList
搜索关键词,目前仅支持一个关键词搜索,不能为空
isSearchGroupID
是否以关键词搜索群ID(注:两个不可以同时为false),为空默认false
isSearchGroupName
是否以关键词搜索群名字,为空默认false
-
setGroupApplyMemberFriend({required String groupID, required int status, String? operationID})
→ Future
-
不允许通过群添加好友
groupID
群ID
status
0:关闭,1:打开
-
setGroupInfo({required String groupID, String? groupName, String? notification, String? introduction, String? faceUrl, String? ex, String? operationID})
→ Future
-
编辑组资料
groupID
被编辑的群ID
groupName
新的群名
notification
新的公告
introduction
新的群介绍
faceUrl
新的群头像
ex
新的额外信息
-
setGroupListener(OnGroupListener listener)
→ Future
-
组关系监听
-
setGroupLookMemberInfo({required String groupID, required int status, String? operationID})
→ Future
-
不允许通过群获取成员资料
groupID
群ID
status
0:关闭,1:打开
-
setGroupMemberNickname({required String groupID, required String userID, String? groupNickname, String? operationID})
→ Future
-
设置群成员昵称
groupID
群ID
userID
群成员的用户ID
groupNickname
群昵称
-
setGroupMemberRoleLevel({required String groupID, required String userID, required int roleLevel, String? operationID})
→ Future
-
设置群成员权限
groupID
群ID
userID
群成员的用户ID
roleLevel
角色等级,参考GroupRoleLevel
-
setGroupVerification({required String groupID, required int needVerification, String? operationID})
→ Future
-
进群验证设置
groupID
群ID
needVerification
进群设置,参考GroupVerification类
-
toString()
→ String
-
A string representation of this object.
inherited
-
transferGroupOwner({required String gid, required String uid, String? operationID})
→ Future
-
转移组拥有者权限
gid
组ID
uid
新拥有者ID