V2TIMGroupManager class Manager

群组高级接口,包含了群组的高级功能,例如群成员邀请、非群成员申请进群等操作接口。

createGroup创建自定义群组(高级版本:可以指定初始的群成员)

getJoinedGroupList获取当前用户已经加入的群列表

getGroupsInfo拉取群资料

setGroupInfo修改群资料

setReceiveMessageOpt修改群消息接收选项

initGroupAttributes初始化群属性,会清空原有的群属性列表

setGroupAttributes设置群属性。已有该群属性则更新其 value 值,没有该群属性则添加该属性。

deleteGroupAttributes删除指定群属性,keys 传 null 则清空所有群属性。

getGroupAttributes获取指定群属性,keys 传 null 则获取所有群属性。

getGroupMemberList获取群成员列表

getGroupMembersInfo获取指定的群成员资料

setGroupMemberInfo修改指定的群成员资料

muteGroupMember禁言(只有管理员或群主能够调用)

inviteUserToGroup邀请他人入群

kickGroupMember踢人

setGroupMemberRole切换群成员的角色。

transferGroupOwner转让群主

getGroupApplicationList获取加群的申请列表

acceptGroupApplication同意某一条加群申请

refuseGroupApplication拒绝某一条加群申请

setGroupApplicationRead标记申请列表为已读

searchGroupByID 通过群ID搜索群信息

Constructors

V2TIMGroupManager()

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

acceptGroupApplication({required String groupID, String? reason, required String fromUser, required String toUser, int? addTime, GroupApplicationTypeEnum? type, String? webMessageInstance}) Future<V2TimCallback>
同意某一条加群申请
createGroup({String? groupID, required String groupType, required String groupName, String? notification, String? introduction, String? faceUrl, bool? isAllMuted, bool? isSupportTopic = false, GroupAddOptTypeEnum? addOpt, List<V2TimGroupMember>? memberList, GroupAddOptTypeEnum? approveOpt}) Future<V2TimValueCallback<String>>
创建自定义群组(高级版本:可以指定初始的群成员)
createTopicInCommunity({required String groupID, required V2TimTopicInfo topicInfo}) Future<V2TimValueCallback<String>>
创建话题 4.0.1及以上版本支持 web版本不支持
decreaseGroupCounter({required String groupID, required String key, required int value}) Future<V2TimValueCallback<Map<String, int>>>
递减群计数器(7.0 及其以上版本支持)
deleteGroupAttributes({required String groupID, required List<String> keys}) Future<V2TimCallback>
删除指定群属性,keys 传 null 则清空所有群属性。
deleteTopicFromCommunity({required String groupID, required List<String> topicIDList}) Future<V2TimValueCallback<List<V2TimTopicOperationResult>>>
删除话题 4.0.1及以上版本支持 web版本不支持
getGroupApplicationList() Future<V2TimValueCallback<V2TimGroupApplicationResult>>
获取加群的申请列表
getGroupAttributes({required String groupID, List<String>? keys}) Future<V2TimValueCallback<Map<String, String>>>
获取指定群属性,keys 传 null 则获取所有群属性。
getGroupCounters({required String groupID, required List<String> keys}) Future<V2TimValueCallback<Map<String, int>>>
获取群计数器(5.0.8 及其以上版本支持)
getGroupMemberList({required String groupID, required GroupMemberFilterTypeEnum filter, required String nextSeq, int count = 15, int offset = 0}) Future<V2TimValueCallback<V2TimGroupMemberInfoResult>>
获取群成员列表
getGroupMembersInfo({required String groupID, required List<String> memberList}) Future<V2TimValueCallback<List<V2TimGroupMemberFullInfo>>>
获取指定的群成员资料
getGroupOnlineMemberCount({required String groupID}) Future<V2TimValueCallback<int>>
获取指定群在线人数 请注意:
getGroupsInfo({required List<String> groupIDList}) Future<V2TimValueCallback<List<V2TimGroupInfoResult>>>
拉取群资料
getJoinedCommunityList() Future<V2TimValueCallback<List<V2TimGroupInfo>>>
获取当前用户已经加入的支持话题的社群列表 4.0.1及以上版本支持 web版本不支持
getJoinedGroupList() Future<V2TimValueCallback<List<V2TimGroupInfo>>>
获取当前用户已经加入的群列表
getTopicInfoList({required String groupID, required List<String> topicIDList}) Future<V2TimValueCallback<List<V2TimTopicInfoResult>>>
获取话题列表。 4.0.1及以上版本支持 web版本不支持
increaseGroupCounter({required String groupID, required String key, required int value}) Future<V2TimValueCallback<Map<String, int>>>
递增群计数器(5.0.8 及其以上版本支持)
initGroupAttributes({required String groupID, required Map<String, String> attributes}) Future<V2TimCallback>
这个接口移到messageManager下面去了,2020-6-4 修改群消息接收选项
inviteUserToGroup({required String groupID, required List<String> userList}) Future<V2TimValueCallback<List<V2TimGroupMemberOperationResult>>>
邀请他人入群
kickGroupMember({required String groupID, required List<String> memberList, int? duration, String? reason}) Future<V2TimCallback>
踢人
markGroupMemberList({required String groupID, required List<String> memberIDList, required int markType, required bool enableMark}) Future<V2TimCallback>
muteGroupMember({required String groupID, required String userID, required int seconds}) Future<V2TimCallback>
禁言(只有管理员或群主能够调用)
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
refuseGroupApplication({required String groupID, String? reason, required String fromUser, required String toUser, required int addTime, required GroupApplicationTypeEnum type, String? webMessageInstance}) Future<V2TimCallback>
拒绝某一条加群申请
searchGroupByID({required String groupID}) Future<V2TimValueCallback<V2TimGroupInfo>>
通过 groupID 搜索群组 注意: 好友工作群不能被搜索 仅 web 支持该搜索方式
searchGroupMembers({required V2TimGroupMemberSearchParam param}) Future<V2TimValueCallback<V2GroupMemberInfoSearchResult>>
搜索群成员
searchGroups({required V2TimGroupSearchParam searchParam}) Future<V2TimValueCallback<List<V2TimGroupInfo>>>
搜索群资料(需要您购买旗舰套餐)
setGroupApplicationRead() Future<V2TimCallback>
标记申请列表为已读
setGroupAttributes({required String groupID, required Map<String, String> attributes}) Future<V2TimCallback>
设置群属性。已有该群属性则更新其 value 值,没有该群属性则添加该属性。
setGroupCounters({required String groupID, required Map<String, int> counters}) Future<V2TimValueCallback<Map<String, int>>>
设置群计数器(5.0.8 及其以上版本支持) 注意 该计数器的 key 如果存在,则直接更新计数器的 value 值;如果不存在,则添加该计数器的 key-value; 当群计数器设置成功后,在 succ 回调中会返回最终成功设置的群计数器信息; 除了社群和话题,群计数器支持所有的群组类型。
setGroupInfo({required V2TimGroupInfo info}) Future<V2TimCallback>
修改群资料
setGroupMemberInfo({required String groupID, required String userID, String? nameCard, Map<String, String>? customInfo}) Future<V2TimCallback>
修改指定的群成员资料
setGroupMemberRole({required String groupID, required String userID, required GroupMemberRoleTypeEnum role}) Future<V2TimCallback>
切换群成员的角色。
setTopicInfo({required String groupID, required V2TimTopicInfo topicInfo}) Future<V2TimCallback>
删除话题 4.0.1及以上版本支持 web版本不支持
toString() String
A string representation of this object.
inherited
transferGroupOwner({required String groupID, required String userID}) Future<V2TimCallback>
转让群主

Operators

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