NIMSDK-AOS
9.19.0
|
群组操作相关接口
群更新的通知监测见 TeamServiceObserver
更多...
Public 成员函数 | |
InvocationFuture< CreateTeamResult > | createTeam (Map< TeamFieldEnum, Serializable > fields, TeamTypeEnum type, String postscript, List< String > members) |
创建一个群组 更多... | |
InvocationFuture< CreateTeamResult > | createTeam (Map< TeamFieldEnum, Serializable > fields, TeamTypeEnum type, String postscript, List< String > members, AntiSpamConfig antiSpamConfig) |
创建一个群组 更多... | |
InvocationFuture< List< String > > | addMembers (String teamId, List< String > accounts) |
添加成员 更多... | |
InvocationFuture< List< String > > | addMembersEx (String teamId, List< String > accounts, String msg, String customInfo) |
添加成员 更多... | |
InvocationFuture< Void > | removeMember (String teamId, String member) |
移除成员,只有创建者有此权限 更多... | |
InvocationFuture< Void > | removeMembers (String teamId, List< String > members) |
批量移出群成员,只有创建者有此权限 更多... | |
InvocationFuture< Void > | updateName (String teamId, String name) |
修改群名称 更多... | |
InvocationFuture< Void > | updateTeam (String teamId, TeamFieldEnum field, Serializable value) |
更新群组资料 更多... | |
InvocationFuture< Void > | updateTeamFields (String teamId, Map< TeamFieldEnum, Serializable > fields) |
批量更新群组资料,可一次性更新多个字段的值。 更多... | |
InvocationFuture< Void > | updateTeamFields (String teamId, Map< TeamFieldEnum, Serializable > fields, AntiSpamConfig antiSpamConfig) |
批量更新群组资料,可一次性更新多个字段的值。 更多... | |
InvocationFuture< Void > | dismissTeam (String teamId) |
解散群,只有创建者有此权限 更多... | |
InvocationFuture< Void > | quitTeam (String teamId) |
退出群 更多... | |
InvocationFuture< Team > | queryTeam (String teamId) |
查询群资料,如果本地没有群组资料,则去服务器查询。 如果自己不在这个群中,该接口返回的可能是过期资料,如需最新的,请调用searchTeam(String)接口 更多... | |
Team | queryTeamBlock (String teamId) |
查询群资料(仅查询本地,不会去服务器请求) 如果自己不在这个群中,该接口返回的可能是过期资料,如需最新的,请调用searchTeam(String)接口 更多... | |
InvocationFuture< List< Team > > | queryTeamList () |
获取自己加入的群的列表 更多... | |
List< Team > | queryTeamListBlock () |
获取自己加入的群的列表(同步版本) 更多... | |
InvocationFuture< List< Team > > | queryTeamListById (List< String > tidList) |
根据群id列表批量查询群信息 更多... | |
List< Team > | queryTeamListByIdBlock (List< String > tidList) |
根据群id列表批量查询群信息(同步版本) 更多... | |
InvocationFuture< List< Team > > | queryTeamListByType (TeamTypeEnum type) |
获取自己加入的指定类型群(讨论组/高级群)列表 更多... | |
List< Team > | queryTeamListByTypeBlock (TeamTypeEnum type) |
获取自己加入的指定类型群(讨论组/高级群)列表(同步版本) 更多... | |
int | queryTeamCountBlock () |
获取自己加入的群的数量 更多... | |
int | queryTeamCountByTypeBlock (TeamTypeEnum type) |
获取自己加入的指定类型群的数量 更多... | |
InvocationFuture< Team > | searchTeam (String teamId) |
从服务器上查询群资料信息 更多... | |
InvocationFuture< TeamInfoResult > | searchTeam (List< Long > teamIdList) |
从服务器上查询群资料信息 更多... | |
InvocationFuture< Team > | applyJoinTeam (String tid, String postscript) |
用户申请加入群。 更多... | |
InvocationFuture< Void > | passApply (String teamId, String account) |
通过用户的入群申请 仅管理员和拥有者有此权限 更多... | |
InvocationFuture< Void > | rejectApply (String teamId, String account, String reason) |
拒绝用户的入群申请 仅管理员和拥有者有此权限 更多... | |
InvocationFuture< List< TeamMember > > | addManagers (String teamId, List< String > accounts) |
拥有者添加管理员 仅拥有者有此权限 更多... | |
InvocationFuture< List< TeamMember > > | removeManagers (String teamId, List< String > managers) |
拥有者撤销管理员权限 仅拥有者有此权限 更多... | |
InvocationFuture< List< TeamMember > > | transferTeam (String tid, String account, boolean quit) |
拥有者将群的拥有者权限转给另外一个人,转移后,另外一个人成为拥有者。 原拥有者变成普通成员。若参数quit为true,原拥有者直接退出该群。 更多... | |
InvocationFuture< Void > | acceptInvite (String teamId, String inviter) |
接受别人的入群邀请 更多... | |
InvocationFuture< Void > | declineInvite (String teamId, String inviter, String reason) |
拒绝别人的入群邀请通知 更多... | |
InvocationFuture< List< TeamMember > > | queryMemberList (String teamId) |
获取指定群的成员信息列表. 更多... | |
InvocationFuture< TeamMember > | queryTeamMember (String teamId, String account) |
查询群成员资料。如果本地群成员资料已过期会去服务器获取最新的。 更多... | |
TeamMember | queryTeamMemberBlock (String teamId, String account) |
查询群成员资料。(同步版本) 更多... | |
List< TeamMember > | queryMutedTeamMembers (String teamId) |
查询被禁言群成员列表 该操作,只返回调用TeamService#muteTeamMember(String, String, boolean) 禁言的用户。 更多... | |
InvocationFuture< Void > | updateMyTeamNick (String teamId, String nick) |
修改自己的群昵称 更多... | |
InvocationFuture< Void > | updateMemberNick (String teamId, String account, String nick) |
群组管理员修改群内其他成员的群昵称。 仅群管理员和拥有者有此权限 更多... | |
InvocationFuture< Void > | updateMyMemberExtension (String teamId, Map< String, Object > extension) |
修改自己的群成员扩展字段(自定义属性) 更多... | |
InvocationFuture< Void > | muteTeam (String teamId, TeamMessageNotifyTypeEnum notifyType) |
设置指定群消息通知类型,查看com.netease.nimlib.sdk.team.constant.TeamMessageNotifyTypeEnum 更多... | |
InvocationFuture< Void > | muteTeamMember (String teamId, String account, boolean mute) |
禁言、解除禁言 更多... | |
InvocationFuture< Void > | muteAllTeamMember (String teamId, boolean mute) |
对整个群禁言、解除禁言,对普通成员生效,只有群组、管理员有权限 更多... | |
InvocationFuture< Void > | sendTeamMessageReceipt (IMMessage message) |
(群消息接收方)标记群组消息已读 更多... | |
void | refreshTeamMessageReceipt (List< IMMessage > messages) |
(群消息发送方)批量刷新群组消息已读、未读的数量信息,没有异步回调 如果已读、未读数有变更,会通过 com.netease.nimlib.sdk.msg.MsgServiceObserve#observeTeamMessageReceipt(Observer, boolean)来批量通知,没有变更则不会通知 更多... | |
InvocationFuture< TeamMsgAckInfo > | fetchTeamMessageReceiptDetail (IMMessage message) |
(群消息发送方)查询单条群组消息已读、未读账号列表 更多... | |
InvocationFuture< TeamMsgAckInfo > | fetchTeamMessageReceiptDetail (IMMessage message, Set< String > accountSet) |
(群消息发送方)查询单条群组消息在指定用户中的已读、未读账号列表 更多... | |
TeamMsgAckInfo | queryTeamMessageReceiptDetailBlock (IMMessage message) |
从本地数据库查询单条群组消息已读、未读账号列表(同步接口) 注意!!!:这里获取的数据通常比离线前的列表信息更陈旧 更多... | |
TeamMsgAckInfo | queryTeamMessageReceiptDetailBlock (IMMessage message, Set< String > accountSet) |
从本地数据库查询单条群组消息在指定用户中的已读、未读账号列表(同步接口) 注意!!!:这里获取的数据通常比离线前的列表信息更陈旧 更多... | |
InvocationFuture< Map< String, String > > | getMemberInvitor (String tid, List< String > accids) |
获取群成员入群邀请人(为空表示主动入群,没有邀请人) 更多... | |
InvocationFuture< List< Team > > | searchTeamsByKeyword (String keyword) |
搜索与关键字匹配的所有群 更多... | |
InvocationFuture< List< IMMessage > > | searchTeamMsgByKeyword (long tid, long fromTime, long endTime, String keyword, int limit, boolean reverse) |
群组会话云端历史消息关键词查询 更多... | |
InvocationFuture< List< String > > | searchTeamIdByName (String name) |
通过群名称反查群组ID 更多... | |
InvocationFuture< NIMTeamMemberSearchResult > | getTeamMemberList (String teamId, NIMTeamMemberRoleTypeSearchOption option) |
查询群成员列表 更多... | |
InvocationFuture< Void > | addTeamMembersFollow (String teamId, List< String > accountIds) |
添加特别关注群成员列表 更多... | |
InvocationFuture< Void > | removeTeamMembersFollow (String teamId, List< String > accountIds) |
移除特别关注群成员列表 更多... | |
群组操作相关接口
群更新的通知监测见 TeamServiceObserver
在文件 TeamService.java 第 28 行定义.
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.acceptInvite | ( | String | teamId, |
String | inviter | ||
) |
InvocationFuture<List<TeamMember> > com.netease.nimlib.sdk.team.TeamService.addManagers | ( | String | teamId, |
List< String > | accounts | ||
) |
InvocationFuture<List<String> > com.netease.nimlib.sdk.team.TeamService.addMembers | ( | String | teamId, |
List< String > | accounts | ||
) |
InvocationFuture<List<String> > com.netease.nimlib.sdk.team.TeamService.addMembersEx | ( | String | teamId, |
List< String > | accounts, | ||
String | msg, | ||
String | customInfo | ||
) |
添加成员
teamId | 群组ID |
accounts | 待加入的群成员帐号列表 |
msg | 邀请附言 ,不需要的话设置为空 |
customInfo | 自定义扩展字段,不需要的话设置为空 ,最长512字符 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.addTeamMembersFollow | ( | String | teamId, |
List< String > | accountIds | ||
) |
InvocationFuture<Team> com.netease.nimlib.sdk.team.TeamService.applyJoinTeam | ( | String | tid, |
String | postscript | ||
) |
InvocationFuture<CreateTeamResult> com.netease.nimlib.sdk.team.TeamService.createTeam | ( | Map< TeamFieldEnum, Serializable > | fields, |
TeamTypeEnum | type, | ||
String | postscript, | ||
List< String > | members | ||
) |
创建一个群组
fields | 群组预设资料, key为数据字段,value对对应的值,该值类型必须和field中定义的fieldType一致。 |
type | 要创建的群组类型 |
postscript | 邀请入群的附言。如果是创建临时群,该参数无效 |
members | 邀请加入的成员帐号列表 |
InvocationFuture<CreateTeamResult> com.netease.nimlib.sdk.team.TeamService.createTeam | ( | Map< TeamFieldEnum, Serializable > | fields, |
TeamTypeEnum | type, | ||
String | postscript, | ||
List< String > | members, | ||
AntiSpamConfig | antiSpamConfig | ||
) |
创建一个群组
fields | 群组预设资料, key为数据字段,value对对应的值,该值类型必须和field中定义的fieldType一致。 |
type | 要创建的群组类型 |
postscript | 邀请入群的附言。如果是创建临时群,该参数无效 |
members | 邀请加入的成员帐号列表 |
antiSpamConfig | 反垃圾相关配置参数 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.declineInvite | ( | String | teamId, |
String | inviter, | ||
String | reason | ||
) |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.dismissTeam | ( | String | teamId | ) |
InvocationFuture<TeamMsgAckInfo> com.netease.nimlib.sdk.team.TeamService.fetchTeamMessageReceiptDetail | ( | IMMessage | message | ) |
(群消息发送方)查询单条群组消息已读、未读账号列表
message | 待查询的消息 |
InvocationFuture<TeamMsgAckInfo> com.netease.nimlib.sdk.team.TeamService.fetchTeamMessageReceiptDetail | ( | IMMessage | message, |
Set< String > | accountSet | ||
) |
(群消息发送方)查询单条群组消息在指定用户中的已读、未读账号列表
message | 待查询的消息 |
accountSet | 指定的用户的账号组成的Set<String>。 如果传空,则返回的列表也是空 |
InvocationFuture<Map<String, String> > com.netease.nimlib.sdk.team.TeamService.getMemberInvitor | ( | String | tid, |
List< String > | accids | ||
) |
获取群成员入群邀请人(为空表示主动入群,没有邀请人)
tid | |
accids | 查询用户accid列表,最多两百 |
InvocationFuture<NIMTeamMemberSearchResult> com.netease.nimlib.sdk.team.TeamService.getTeamMemberList | ( | String | teamId, |
NIMTeamMemberRoleTypeSearchOption | option | ||
) |
查询群成员列表
teamId | 群组ID |
option | 查询选项 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.muteAllTeamMember | ( | String | teamId, |
boolean | mute | ||
) |
对整个群禁言、解除禁言,对普通成员生效,只有群组、管理员有权限
teamId | 群组 ID |
mute | true表示禁言,false表示解除禁言 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.muteTeam | ( | String | teamId, |
TeamMessageNotifyTypeEnum | notifyType | ||
) |
设置指定群消息通知类型,查看com.netease.nimlib.sdk.team.constant.TeamMessageNotifyTypeEnum
teamId | 群组ID |
notifyType | 通知类型枚举 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.muteTeamMember | ( | String | teamId, |
String | account, | ||
boolean | mute | ||
) |
禁言、解除禁言
teamId | 群组ID |
account | 被禁言、被解除禁言的账号 |
mute | true表示禁言,false表示解除禁言 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.passApply | ( | String | teamId, |
String | account | ||
) |
InvocationFuture<List<TeamMember> > com.netease.nimlib.sdk.team.TeamService.queryMemberList | ( | String | teamId | ) |
获取指定群的成员信息列表.
该操作有可能只是从本地数据库读取缓存数据,也有可能会从服务器同步新的数据, 因此耗时可能会比较长。
teamId | 群ID |
List<TeamMember> com.netease.nimlib.sdk.team.TeamService.queryMutedTeamMembers | ( | String | teamId | ) |
查询被禁言群成员列表 该操作,只返回调用TeamService#muteTeamMember(String, String, boolean) 禁言的用户。
teamId | 群ID |
InvocationFuture<Team> com.netease.nimlib.sdk.team.TeamService.queryTeam | ( | String | teamId | ) |
查询群资料,如果本地没有群组资料,则去服务器查询。
如果自己不在这个群中,该接口返回的可能是过期资料,如需最新的,请调用searchTeam(String)接口
teamId | 群ID |
Team com.netease.nimlib.sdk.team.TeamService.queryTeamBlock | ( | String | teamId | ) |
int com.netease.nimlib.sdk.team.TeamService.queryTeamCountBlock | ( | ) |
获取自己加入的群的数量
int com.netease.nimlib.sdk.team.TeamService.queryTeamCountByTypeBlock | ( | TeamTypeEnum | type | ) |
获取自己加入的指定类型群的数量
type | 群类型 |
InvocationFuture<List<Team> > com.netease.nimlib.sdk.team.TeamService.queryTeamList | ( | ) |
获取自己加入的群的列表
List<Team> com.netease.nimlib.sdk.team.TeamService.queryTeamListBlock | ( | ) |
获取自己加入的群的列表(同步版本)
InvocationFuture<List<Team> > com.netease.nimlib.sdk.team.TeamService.queryTeamListById | ( | List< String > | tidList | ) |
根据群id列表批量查询群信息
tidList | 群id列表 |
List<Team> com.netease.nimlib.sdk.team.TeamService.queryTeamListByIdBlock | ( | List< String > | tidList | ) |
根据群id列表批量查询群信息(同步版本)
tidList | 群id列表 |
InvocationFuture<List<Team> > com.netease.nimlib.sdk.team.TeamService.queryTeamListByType | ( | TeamTypeEnum | type | ) |
获取自己加入的指定类型群(讨论组/高级群)列表
type | 群类型 |
List<Team> com.netease.nimlib.sdk.team.TeamService.queryTeamListByTypeBlock | ( | TeamTypeEnum | type | ) |
获取自己加入的指定类型群(讨论组/高级群)列表(同步版本)
type | 群类型 |
InvocationFuture<TeamMember> com.netease.nimlib.sdk.team.TeamService.queryTeamMember | ( | String | teamId, |
String | account | ||
) |
查询群成员资料。如果本地群成员资料已过期会去服务器获取最新的。
teamId | 群ID |
account | 群成员帐号 |
TeamMember com.netease.nimlib.sdk.team.TeamService.queryTeamMemberBlock | ( | String | teamId, |
String | account | ||
) |
查询群成员资料。(同步版本)
teamId | 群ID |
account | 群成员帐号 |
TeamMsgAckInfo com.netease.nimlib.sdk.team.TeamService.queryTeamMessageReceiptDetailBlock | ( | IMMessage | message | ) |
从本地数据库查询单条群组消息已读、未读账号列表(同步接口) 注意!!!:这里获取的数据通常比离线前的列表信息更陈旧
message | 待查询的消息 |
TeamMsgAckInfo com.netease.nimlib.sdk.team.TeamService.queryTeamMessageReceiptDetailBlock | ( | IMMessage | message, |
Set< String > | accountSet | ||
) |
从本地数据库查询单条群组消息在指定用户中的已读、未读账号列表(同步接口) 注意!!!:这里获取的数据通常比离线前的列表信息更陈旧
message | 待查询的消息 |
accountSet | 指定的用户的账号组成的Set<String>。 如果传空,则返回的列表也是空 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.quitTeam | ( | String | teamId | ) |
void com.netease.nimlib.sdk.team.TeamService.refreshTeamMessageReceipt | ( | List< IMMessage > | messages | ) |
(群消息发送方)批量刷新群组消息已读、未读的数量信息,没有异步回调 如果已读、未读数有变更,会通过 com.netease.nimlib.sdk.msg.MsgServiceObserve#observeTeamMessageReceipt(Observer, boolean)来批量通知,没有变更则不会通知
messages | 请求刷新的群组消息集合 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.rejectApply | ( | String | teamId, |
String | account, | ||
String | reason | ||
) |
InvocationFuture<List<TeamMember> > com.netease.nimlib.sdk.team.TeamService.removeManagers | ( | String | teamId, |
List< String > | managers | ||
) |
拥有者撤销管理员权限
仅拥有者有此权限
teamId | 群ID |
managers | 待撤销的管理员的帐号列表 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.removeMember | ( | String | teamId, |
String | member | ||
) |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.removeMembers | ( | String | teamId, |
List< String > | members | ||
) |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.removeTeamMembersFollow | ( | String | teamId, |
List< String > | accountIds | ||
) |
InvocationFuture<Team> com.netease.nimlib.sdk.team.TeamService.searchTeam | ( | String | teamId | ) |
从服务器上查询群资料信息
teamId | 群ID列表 |
InvocationFuture<TeamInfoResult> com.netease.nimlib.sdk.team.TeamService.searchTeam | ( | List< Long > | teamIdList | ) |
从服务器上查询群资料信息
teamIdList | 群ID列表,如果大小超过10,取前10个 |
InvocationFuture<List<String> > com.netease.nimlib.sdk.team.TeamService.searchTeamIdByName | ( | String | name | ) |
通过群名称反查群组ID
name | 群组名称 |
InvocationFuture<List<IMMessage> > com.netease.nimlib.sdk.team.TeamService.searchTeamMsgByKeyword | ( | long | tid, |
long | fromTime, | ||
long | endTime, | ||
String | keyword, | ||
int | limit, | ||
boolean | reverse | ||
) |
群组会话云端历史消息关键词查询
tid | 群组id |
fromTime | 起始时间点单位毫秒 |
endTime | 结束时间点单位毫秒 |
keyword | 查询关键词 |
limit | 本次查询的消息条数上限(最多100条) |
reverse | (可选参数,不传默认false),true是表示反向查询(按时间正序起查,正序排列),默认false表示按时间逆序起查,逆序排列 |
InvocationFuture<List<Team> > com.netease.nimlib.sdk.team.TeamService.searchTeamsByKeyword | ( | String | keyword | ) |
搜索与关键字匹配的所有群
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.sendTeamMessageReceipt | ( | IMMessage | message | ) |
InvocationFuture<List<TeamMember> > com.netease.nimlib.sdk.team.TeamService.transferTeam | ( | String | tid, |
String | account, | ||
boolean | quit | ||
) |
拥有者将群的拥有者权限转给另外一个人,转移后,另外一个人成为拥有者。
原拥有者变成普通成员。若参数quit为true,原拥有者直接退出该群。
tid | 群ID |
account | 新任拥有者的用户帐号 |
quit | 转移时是否要同时退出该群 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.updateMemberNick | ( | String | teamId, |
String | account, | ||
String | nick | ||
) |
群组管理员修改群内其他成员的群昵称。
仅群管理员和拥有者有此权限
teamId | 所在群组ID |
account | 要修改的群成员帐号 |
nick | 新的群昵称 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.updateMyMemberExtension | ( | String | teamId, |
Map< String, Object > | extension | ||
) |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.updateMyTeamNick | ( | String | teamId, |
String | nick | ||
) |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.updateName | ( | String | teamId, |
String | name | ||
) |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.updateTeam | ( | String | teamId, |
TeamFieldEnum | field, | ||
Serializable | value | ||
) |
更新群组资料
teamId | 群ID |
field | 待更新的域 |
value | 待更新的域的新值 该值类型必须和field中定义的fieldType一致 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.updateTeamFields | ( | String | teamId, |
Map< TeamFieldEnum, Serializable > | fields | ||
) |
批量更新群组资料,可一次性更新多个字段的值。
teamId | 群ID |
fields | 待更新的所有字段的新的资料,其中值类型必须和field中定义的fieldType一致 |
InvocationFuture<Void> com.netease.nimlib.sdk.team.TeamService.updateTeamFields | ( | String | teamId, |
Map< TeamFieldEnum, Serializable > | fields, | ||
AntiSpamConfig | antiSpamConfig | ||
) |
批量更新群组资料,可一次性更新多个字段的值。
teamId | 群ID |
fields | 待更新的所有字段的新的资料,其中值类型必须和field中定义的fieldType一致 |
antiSpamConfig | 反垃圾相关配置参数 |