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