GroupManager class

Constructors

GroupManager(MethodChannel _channel)

Properties

hashCode → int
The hash code for this object.
no setterinherited
listener ↔ OnGroupListener
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

acceptGroupApplication({required String groupID, required String userID, String? handleMsg, String? operationID}) → Future
Accept a group membership application as an administrator or group owner Note: Membership applications require approval from administrators or the group.
changeGroupMemberMute({required String groupID, required String userID, int seconds = 0, String? operationID}) → Future
Mute a group member groupID Group ID userID Member ID to mute seconds Duration of the mute in seconds (set to 0 to unmute)
changeGroupMute({required String groupID, required bool mute, String? operationID}) → Future
Enable or disable group mute, preventing all group members from sending messages groupID Group ID mute true: Enable, false: Disable
createGroup({required GroupInfo groupInfo, List<String> memberUserIDs = const [], List<String> adminUserIDs = const [], String? ownerUserID, String? operationID}) → Future<GroupInfo>
Create a new group groupInfo Group information memberUserIDs List of user IDs to add as initial members adminUserIDs List of user IDs to add as administrators ownerUserID User ID of the owner
dismissGroup({required String groupID, String? operationID}) → Future
Dissolve a group groupID Group ID
getGroupApplicationListAsApplicant({String? operationID}) → Future<List<GroupApplicationInfo>>
Get the list of group membership applications sent by the user
getGroupApplicationListAsRecipient({String? operationID}) → Future<List<GroupApplicationInfo>>
Handle group membership applications received as a group owner or administrator
getGroupMemberList({required String groupID, int filter = 0, int offset = 0, int count = 0, String? operationID}) → Future<List<GroupMembersInfo>>
Paginate and retrieve the group member list groupID Group ID filter Member filter (0: All, 1: Group owner, 2: Administrator, 3: Regular member, 4: Admin + Regular member, 5: Group owner + Admin) offset Starting index count Total count
getGroupMemberListByJoinTime({required String groupID, int offset = 0, int count = 0, int joinTimeBegin = 0, int joinTimeEnd = 0, List<String> filterUserIDList = const [], String? operationID}) → Future<List<GroupMembersInfo>>
Get a group member list based on join time
getGroupMemberListMap({required String groupID, int filter = 0, int offset = 0, int count = 0, String? operationID}) → Future<List>
Paginate and retrieve the group member list as a map groupID Group ID filter Member filter (0: All, 1: Group owner, 2: Administrator, 3: Regular member, 4: Admin + Regular member, 5: Group owner + Admin) offset Starting index count Total count
getGroupMembersInfo({required String groupID, required List<String> userIDList, String? operationID}) → Future<List<GroupMembersInfo>>
Query group member information groupID Group ID userIDList List of user IDs
getGroupOwnerAndAdmin({required String groupID, String? operationID}) → Future<List<GroupMembersInfo>>
Get group owners and administrators groupId Group ID
getGroupsInfo({required List<String> groupIDList, String? operationID}) → Future<List<GroupInfo>>
Query group information
getJoinedGroupList({String? operationID}) → Future<List<GroupInfo>>
Query the list of joined groups
getJoinedGroupListMap({String? operationID}) → Future<List>
Query the list of joined groups
inviteUserToGroup({required String groupID, required List<String> userIDList, String? reason, String? operationID}) → Future
Invite users to a group, allowing them to join without approval. groupID Group ID userIDList List of user IDs
isJoinedGroup({required String groupID, String? operationID}) → Future<bool>
Check if the user has joined a group groupID Group ID
joinGroup({required String groupID, String? reason, String? operationID, int joinSource = 3, String? ex}) → Future
Apply to join a group, requiring approval from an administrator or the group. joinSource 2: Invited, 3: Searched, 4: Using a QR code
kickGroupMember({required String groupID, required List<String> userIDList, String? reason, String? operationID}) → Future
Remove group members groupID Group ID userIDList List of user IDs reason Reason for removal
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
quitGroup({required String groupID, String? operationID}) → Future
Exit a group
refuseGroupApplication({required String groupID, required String userID, String? handleMsg, String? operationID}) → Future
Refuse a group membership application as an administrator or group owner Note: Membership applications require approval from administrators or the group.
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>>
Search for group members groupID Group ID keywordList Search keywords; currently, only one keyword is supported, and it cannot be empty. isSearchUserID Whether to search by member ID isSearchMemberNickname Whether to search by member nickname offset Start index count Total count to retrieve
searchGroupMembersListMap({required String groupID, List<String> keywordList = const [], bool isSearchUserID = false, bool isSearchMemberNickname = false, int offset = 0, int count = 40, String? operationID}) → Future<List>
Query a group groupID Group ID keywordList Search keyword, currently only supports searching with one keyword, and it cannot be empty isSearchUserID Whether to search member IDs with the keyword isSearchMemberNickname Whether to search member nicknames with the keyword offset Starting index count Total number to retrieve each time
searchGroups({List<String> keywordList = const [], bool isSearchGroupID = false, bool isSearchGroupName = false, String? operationID}) → Future<List<GroupInfo>>
Query a group keywordList Search keywords; currently, only one keyword is supported, and it cannot be empty. isSearchGroupID Whether to search by group ID (Note: cannot set both to false at the same time); defaults to false if not set. isSearchGroupName Whether to search by group name; defaults to false if not set.
setGroupApplyMemberFriend({required String groupID, required int status, String? operationID}) → Future
Allow/disallow members to add friends through the group groupID Group ID status 0: Disable, 1: Enable
setGroupInfo(GroupInfo groupInfo, {String? operationID}) → Future
Edit group information
setGroupListener(OnGroupListener listener) → Future
Group relationship listener
setGroupLookMemberInfo({required String groupID, required int status, String? operationID}) → Future
Allow/disallow members to view each other's information through the group groupID Group ID status 0: Disable, 1: Enable
setGroupMemberInfo({required GroupMembersInfo groupMembersInfo, String? operationID}) → Future
Modify the GroupMemberInfo ex field
setGroupMemberNickname({required String groupID, required String userID, String? groupNickname, String? operationID}) → Future
Set the nickname of a group member groupID Group ID userID User ID of the group member groupNickname Group nickname
setGroupMemberRoleLevel({required String groupID, required String userID, required int roleLevel, String? operationID}) → Future
Set group member role groupID Group ID userID User ID of the group member roleLevel Role level; see GroupRoleLevel
setGroupVerification({required String groupID, required int needVerification, String? operationID}) → Future
Set group verification for joining groupID Group ID needVerification Verification setting; see GroupVerification class
toString() → String
A string representation of this object.
inherited
transferGroupOwner({required String groupID, required String userID, String? operationID}) → Future
Transfer group ownership

Operators

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