TeamService class
Methods
-
acceptInvite(String teamId, String inviter)
→ Future<NIMResult<void>>
-
接受别人的入群邀请
-
addManagers(String teamId, List<String> accounts)
→ Future<NIMResult<List<NIMTeamMember>>>
-
群主添加管理员
仅群主有此权限
teamId 群ID
accounts 待提升为管理员的用户帐号列表
Future 可以设置回调函数,如果成功,参数为新增的群管理员列表
-
addMembersEx({required String teamId, required List<String> accounts, required String msg, required String customInfo})
→ Future<NIMResult<List<String>>>
-
添加成员并设置自定义字段
teamId 群组ID
accounts 待加入的群成员帐号列表
msg 邀请附言 ,不需要的话设置为空
customInfo 自定义扩展字段,不需要的话设置为空
-
applyJoinTeam(String teamId, String postscript)
→ Future<NIMResult<NIMTeam>>
-
用户申请加入群。
teamId 申请加入的群ID
postscript 申请附言
-
createTeam({required NIMCreateTeamOptions createTeamOptions, required List<String> members})
→ Future<NIMResult<NIMCreateTeamResult>>
-
创建一个群组
云信群组分为两类:普通群和高级群,两种群组的消息功能都是相同的,区别在于管理功能。普通群所有人都可以拉人入群,除群主外,其他人都不能踢人;
高级群则拥有完善的成员权限体系及管理功能。创建群的接口相同,传入不同的类型参数即可。
-
declineInvite(String teamId, String inviter, String reason)
→ Future<NIMResult<void>>
-
拒绝入群邀请
teamId
群组ID
inviter
邀请我的用户帐号
reason
拒绝理由,长度不得超过5000
-
dismissTeam(String teamId)
→ Future<NIMResult<void>>
-
解散群,只有群主有此权限
可以设置回调函数,监听操作结果
-
getMemberInvitor(String teamId, List<String> accids)
→ Future<NIMResult<Map<String, String>>>
-
获取群成员入群邀请人(为空表示主动入群,没有邀请人)
teamId
accids 查询用户accid列表,最多两百
返回用户的对应关系,key为accid value是inviteAccid
-
muteAllTeamMember(String teamId, bool mute)
→ Future<NIMResult<void>>
-
对整个群禁言、解除禁言,对普通成员生效,只有群组、管理员有权限
teamId 群组 ID
mute true表示禁言,false表示解除禁言
-
muteTeam(String teamId, NIMTeamMessageNotifyTypeEnum notifyType)
→ Future<NIMResult<void>>
-
设置指定群消息通知类型,支持多端同步
notifyType 通知类型枚举
-
muteTeamMember(String teamId, String account, bool mute)
→ Future<NIMResult<void>>
-
禁言、解除禁言
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
passApply(String teamId, String account)
→ Future<NIMResult<void>>
-
通过用户的入群申请
仅管理员和群主有此权限
-
queryMemberList(String teamId)
→ Future<NIMResult<List<NIMTeamMember>>>
-
获取指定群的成员信息列表.
该操作有可能只是从本地数据库读取缓存数据,也有可能会从服务器同步新的数据, 因此耗时可能会比较长。
teamId 群ID
可以设置回调函数,如果成功,参数为群的成员信息列表
-
queryMutedTeamMembers(String teamId)
→ Future<NIMResult<List<NIMTeamMember>>>
-
查询被禁言群成员列表
该操作,只返回调用TeamService#muteTeamMember(String, String, boolean) 禁言的用户。
teamId 群ID
群成员信息列表
-
queryTeam(String teamId)
→ Future<NIMResult<NIMTeam>>
-
查询群资料,如果本地没有群组资料,则去服务器查询。
如果自己不在这个群中,该接口返回的可能是过期资料,如需最新的,请调用{@link #searchTeam(String)}接口
teamId
群ID
-
queryTeamList()
→ Future<NIMResult<List<NIMTeam>>>
-
从本地获取所有群组
获取自己加入的群的列表
可以设置回调函数,如果成功,参数为自己加入的群的列表
-
queryTeamMember(String teamId, String account)
→ Future<NIMResult<NIMTeamMember>>
-
查询群成员资料。如果本地群成员资料已过期会去服务器获取最新的。
teamId
群ID
account
群成员帐号
-
quitTeam(String teamId)
→ Future<NIMResult<void>>
-
退出群
teamId 群ID
-
rejectApply(String teamId, String account, String reason)
→ Future<NIMResult<void>>
-
拒绝用户的入群申请
仅管理员和拥有者有此权限
-
removeManagers(String teamId, List<String> managers)
→ Future<NIMResult<List<NIMTeamMember>>>
-
群主撤销管理员权限
仅群主有此权限
teamId 群ID
managers 待撤销的管理员的帐号列表
可以设置回调函数,如果成功,参数为被撤销的群成员列表(权限已被降为Normal)。
-
removeMembers(String teamId, List<String> members)
→ Future<NIMResult<void>>
-
移除成员,只有创建者有此权限
-
searchTeam(String teamId)
→ Future<NIMResult<NIMTeam>>
-
从服务器上查询群资料信息
teamId 群ID
-
searchTeamIdByName(String name)
→ Future<NIMResult<List<String>>>
-
通过群名称反查群组ID
name 群组名称
群ID列表
-
searchTeamsByKeyword(String keyword)
→ Future<NIMResult<List<NIMTeam>>>
-
用户在客户端本地可以搜索与关键字匹配的所有群:
通过群名称反查群组ID
name 群组名称
群ID列表
-
toString()
→ String
-
A string representation of this object.
inherited
-
transferTeam(String teamId, String account, bool quit)
→ Future<NIMResult<List<NIMTeamMember>>>
-
群主将群的群主权限转给另外一个人,转移后,另外一个人成为群主。
原群主变成普通成员。若参数quit为true,原群主直接退出该群。
InvocationFuture 可以设置回调函数,如果成功,视参数quit值:
quit为false:参数仅包含原群主和当前群主的(即操作者和account),权限已被更新。
quit为true: 参数为空。
-
updateMemberNick(String teamId, String account, String nick)
→ Future<NIMResult<void>>
-
群组管理员修改群内其他成员的群昵称。
仅群管理员和群主有此权限
teamId
所在群组ID
account
要修改的群成员帐号
nick
新的群昵称
-
updateMyMemberExtension(String teamId, Map<String, Object> extension)
→ Future<NIMResult<void>>
-
修改自己的群成员扩展字段(自定义属性)
teamId 所在群组ID
extension 新的扩展字段(自定义属性)
-
updateMyTeamNick(String teamId, String nick)
→ Future<NIMResult<void>>
-
修改自己的群昵称
-
updateTeamFields(String teamId, NIMTeamUpdateFieldRequest request)
→ Future<NIMResult<void>>
-
批量更新群组资料,可一次性更新多个字段的值。
teamId 群ID
request 需要更新的属性及其值