com.netease.nimlib.sdk.superteam

接口 SuperTeamService

public interface SuperTeamService

Created by hzsunyj on 2019-05-16.

方法概要

限定符和类型	方法和说明
InvocationFuture<java.lang.Void>	acceptInvite(java.lang.String teamId, java.lang.String inviter) 接受别人的入群邀请
InvocationFuture<java.util.List<SuperTeamMember>>	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, java.lang.String postscript) 邀请成员
InvocationFuture<SuperTeam>	applyJoinTeam(java.lang.String tid, java.lang.String postscript) 用户申请加入群。
InvocationFuture<java.util.List<SessionAckInfo>>	clearUnreadCount(java.util.List<java.lang.String> teamIdList) 将指定最近联系人的未读数清零(标记已读)。
InvocationFuture<java.lang.Void>	declineInvite(java.lang.String teamId, java.lang.String inviter, java.lang.String reason) 拒绝别人的入群邀请通知
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>	muteTeamMembers(java.lang.String teamId, java.util.ArrayList<java.lang.String> accountList, boolean mute) 禁言、解除禁言
InvocationFuture<java.lang.Void>	passApply(java.lang.String teamId, java.lang.String account) 通过用户的入群申请 仅群主和管理员拥有者有此权限
InvocationFuture<java.util.List<SuperTeamMember>>	queryMemberList(java.lang.String teamId) 获取指定群的成员信息列表.
InvocationFuture<java.util.List<SuperTeamMember>>	queryMemberListByPage(java.lang.String teamId, int offset, int limit) 分页获取指定群的成员信息列表.
java.util.List<SuperTeamMember>	queryMutedTeamMembers(java.lang.String teamId) 查询被禁言群成员列表 该操作，只返回调用muteTeamMembers(String, ArrayList, boolean) 禁言的用户。
InvocationFuture<SuperTeam>	queryTeam(java.lang.String teamId) 查询群资料，如果本地没有群组资料，则去服务器查询。
SuperTeam	queryTeamBlock(java.lang.String teamId) 查询群资料（仅查询本地，不会去服务器请求) 如果自己不在这个群中，该接口返回的可能是过期资料，如需最新的，请调用searchTeam(String teamId)接口
InvocationFuture<java.util.List<SuperTeam>>	queryTeamList() 获取自己加入的群的列表
java.util.List<SuperTeam>	queryTeamListBlock() 获取自己加入的群的列表(同步版本)
InvocationFuture<java.util.List<SuperTeam>>	queryTeamListById(java.util.List<java.lang.String> tidList) 根据群id列表批量查询群信息
java.util.List<SuperTeam>	queryTeamListByIdBlock(java.util.List<java.lang.String> tidList) 根据群id列表批量查询群信息（同步版本）
InvocationFuture<SuperTeamMember>	queryTeamMember(java.lang.String teamId, java.lang.String account) 查询群成员资料。
SuperTeamMember	queryTeamMemberBlock(java.lang.String teamId, java.lang.String account) 查询群成员资料。
InvocationFuture<java.lang.Void>	quitTeam(java.lang.String teamId) 退出群
InvocationFuture<java.lang.Void>	rejectApply(java.lang.String teamId, java.lang.String account, java.lang.String reason) 拒绝用户的入群申请 仅管理员和拥有者有此权限
InvocationFuture<java.util.List<SuperTeamMember>>	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<java.lang.Void>	replyMessage(IMMessage msg, IMMessage replyMsg, boolean resend) 回复消息。
InvocationFuture<java.lang.Void>	revokeMessage(IMMessage message) 消息撤回 ，默认没有第三方推送（包括IOS平台的推送），参考revokeMessage(IMMessage, String, Map)
InvocationFuture<java.lang.Void>	revokeMessage(IMMessage message, java.lang.String customApnsText, java.util.Map<java.lang.String,java.lang.Object> pushPayload) 消息撤回 ， 并设置相应的第三方推送配置（包括IOS平台的推送），如果想要关闭App内的返回消息提醒，参考NIMClient.toggleRevokeMessageNotification(boolean on)
InvocationFuture<java.lang.Void>	revokeMessage(IMMessage message, java.lang.String customApnsText, java.util.Map<java.lang.String,java.lang.Object> pushPayload, boolean shouldNotifyBeCount) 消息撤回 ， 并设置相应的第三方推送配置（包括IOS平台的推送），如果想要关闭App内的返回消息提醒，参考NIMClient.toggleRevokeMessageNotification(boolean on)
InvocationFuture<java.lang.Void>	revokeMessage(IMMessage message, java.lang.String customApnsText, java.util.Map<java.lang.String,java.lang.Object> pushPayload, boolean shouldNotifyBeCount, java.lang.String postscript) 消息撤回 ， 并设置相应的第三方推送配置（包括IOS平台的推送），如果想要关闭App内的返回消息提醒，参考NIMClient.toggleRevokeMessageNotification(boolean on)
InvocationFuture<SuperTeam>	searchTeam(java.lang.String teamId) 从服务器上查询群资料信息
InvocationFuture<java.util.List<java.lang.String>>	searchTeamIdByName(java.lang.String name) 通过群名称反查群组ID
InvocationFuture<java.util.List<SuperTeam>>	searchTeamsByKeyword(java.lang.String keyword) 搜索与关键字匹配的所有群
InvocationFuture<java.lang.Void>	sendAckSession(java.lang.String teamId, long timestamp) 标记会话ACK
InvocationFuture<java.lang.Void>	sendMessage(IMMessage msg, boolean resend) 发送消息。
InvocationFuture<java.util.List<SuperTeamMember>>	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.lang.String extension) 修改自己的群成员扩展字段（自定义属性，最长32个字符）
InvocationFuture<java.lang.Void>	updateMyTeamNick(java.lang.String teamId, java.lang.String nick) 修改自己的群昵称
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) 批量更新群组资料，可一次性更新多个字段的值。

方法详细资料

sendMessage

InvocationFuture<java.lang.Void> sendMessage(IMMessage msg,
                                             boolean resend)

发送消息。
如果需要更新发送进度，请调用MsgServiceObserve.observeMsgStatus(com.netease.nimlib.sdk.Observer, boolean)

参数:

msg - 带发送的消息体，由MessageBuilder构造

resend - 如果是发送失败后重发，标记为true，否则填false

返回:

InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。

replyMessage

InvocationFuture<java.lang.Void> replyMessage(IMMessage msg,
                                              IMMessage replyMsg,
                                              boolean resend)

回复消息。
如果需要更新发送进度，请调用MsgServiceObserve.observeMsgStatus(com.netease.nimlib.sdk.Observer, boolean)

参数:

msg - 带发送的消息体，由MessageBuilder构造

replyMsg - 被回复的消息

resend - 如果是发送失败后重发，标记为true，否则填false

返回:

InvocationFuture 可以设置回调函数。消息发送完成后才会调用，如果出错，会有具体的错误代码。

addMembers

InvocationFuture<java.util.List<java.lang.String>> addMembers(java.lang.String teamId,
                                                              java.util.List<java.lang.String> accounts,
                                                              java.lang.String postscript)

邀请成员

参数:

teamId - 群组ID

accounts - 待加入的群成员帐号列表

postscript - 附言，长度不得超过5000

返回:

InvocationFuture 可以设置回调函数，监听操作结果

removeMember

InvocationFuture<java.lang.Void> removeMember(java.lang.String teamId,
                                              java.lang.String member)

移出群成员，只有群主有权限

参数:

teamId - 群ID

member - 被踢出的成员帐号

返回:

InvocationFuture 可以设置回调函数，监听操作结果

removeMembers

InvocationFuture<java.lang.Void> removeMembers(java.lang.String teamId,
                                               java.util.List<java.lang.String> members)

批量移出群成员，只有群主有权限

参数:

teamId - 群ID

members - 被踢出的成员帐号列表

返回:

InvocationFuture 可以设置回调函数，监听操作结果

quitTeam

InvocationFuture<java.lang.Void> quitTeam(java.lang.String teamId)

退出群

参数:

teamId - 群ID

返回:

InvocationFuture 可以设置回调函数，监听操作结果

clearUnreadCount

InvocationFuture<java.util.List<SessionAckInfo>> clearUnreadCount(java.util.List<java.lang.String> teamIdList)

将指定最近联系人的未读数清零(标记已读)。
调用该接口后，会触发MsgServiceObserve.observeRecentContact(Observer, boolean)

updateTeam

InvocationFuture<java.lang.Void> updateTeam(java.lang.String teamId,
                                            TeamFieldEnum field,
                                            java.io.Serializable value)

更新群组资料

参数:

teamId - 群ID

field - 待更新的域

value - 待更新的域的新值 该值类型必须和field中定义的fieldType一致

返回:

InvocationFuture 可以设置回调函数，监听操作结果

updateTeamFields

InvocationFuture<java.lang.Void> updateTeamFields(java.lang.String teamId,
                                                  java.util.Map<TeamFieldEnum,java.io.Serializable> fields)

批量更新群组资料，可一次性更新多个字段的值。

参数:

teamId - 群ID

fields - 待更新的所有字段的新的资料，其中值类型必须和field中定义的fieldType一致

返回:

InvocationFuture 可以设置回调函数，监听操作结果

updateTeamFields

InvocationFuture<java.lang.Void> updateTeamFields(java.lang.String teamId,
                                                  java.util.Map<TeamFieldEnum,java.io.Serializable> fields,
                                                  AntiSpamConfig antiSpamConfig)

批量更新群组资料，可一次性更新多个字段的值。

参数:

teamId - 群ID

fields - 待更新的所有字段的新的资料，其中值类型必须和field中定义的fieldType一致

antiSpamConfig - 反垃圾相关配置参数

返回:

InvocationFuture 可以设置回调函数，监听操作结果

queryTeamList

InvocationFuture<java.util.List<SuperTeam>> queryTeamList()

获取自己加入的群的列表

返回:

InvocationFuture 可以设置回调函数，如果成功，参数为自己加入的群的列表

queryTeamListBlock

java.util.List<SuperTeam> queryTeamListBlock()

获取自己加入的群的列表(同步版本)

返回:

自己加入的群的列表

queryTeamListById

InvocationFuture<java.util.List<SuperTeam>> queryTeamListById(java.util.List<java.lang.String> tidList)

根据群id列表批量查询群信息

参数:

tidList - 群id列表

返回:

可以设置回调函数，如果成功，参数为查询的群信息列表

queryTeamListByIdBlock

java.util.List<SuperTeam> queryTeamListByIdBlock(java.util.List<java.lang.String> tidList)

根据群id列表批量查询群信息（同步版本）

参数:

tidList - 群id列表

返回:

查询的群信息列表

queryTeam

InvocationFuture<SuperTeam> queryTeam(java.lang.String teamId)

查询群资料，如果本地没有群组资料，则去服务器查询。
如果自己不在这个群中，该接口返回的可能是过期资料，如需最新的，请调用searchTeam(String teamId)接口

参数:

teamId - 群ID

返回:

InvocationFuture 可以设置回调函数，如果成功，参数为群资料

queryTeamBlock

SuperTeam queryTeamBlock(java.lang.String teamId)

查询群资料（仅查询本地，不会去服务器请求) 如果自己不在这个群中，该接口返回的可能是过期资料，如需最新的，请调用searchTeam(String teamId)接口

参数:

teamId - 群ID

返回:

群资料

searchTeam

InvocationFuture<SuperTeam> searchTeam(java.lang.String teamId)

从服务器上查询群资料信息

参数:

teamId -

返回:

queryMemberList

InvocationFuture<java.util.List<SuperTeamMember>> queryMemberList(java.lang.String teamId)

获取指定群的成员信息列表.
该操作有可能只是从本地数据库读取缓存数据，也有可能会从服务器同步新的数据, 因此耗时可能会比较长。

参数:

teamId - 群ID

返回:

InvocationFuture 可以设置回调函数，如果成功，参数为群的成员信息列表

queryMemberListByPage

InvocationFuture<java.util.List<SuperTeamMember>> queryMemberListByPage(java.lang.String teamId,
                                                                        int offset,
                                                                        int limit)

分页获取指定群的成员信息列表.
该操作有可能只是从本地数据库读取缓存数据，也有可能会从服务器同步新的数据, 因此耗时可能会比较长。

参数:

teamId - 群ID

offset - 偏移位置

limit - 获取条数，每次最多200

返回:

InvocationFuture 可以设置回调函数，如果成功，参数为群的成员信息列表

queryTeamMember

InvocationFuture<SuperTeamMember> queryTeamMember(java.lang.String teamId,
                                                  java.lang.String account)

查询群成员资料。如果本地群成员资料已过期会去服务器获取最新的。

参数:

teamId - 群ID

account - 群成员帐号

返回:

InvocationFuture 可以设置回调函数，如果成功，参数为该群成员信息

queryTeamMemberBlock

SuperTeamMember queryTeamMemberBlock(java.lang.String teamId,
                                     java.lang.String account)

查询群成员资料。（同步版本）

参数:

teamId - 群ID

account - 群成员帐号

返回:

群成员信息

queryMutedTeamMembers

java.util.List<SuperTeamMember> queryMutedTeamMembers(java.lang.String teamId)

查询被禁言群成员列表 该操作，只返回调用muteTeamMembers(String, ArrayList, boolean) 禁言的用户。

参数:

teamId - 群ID

返回:

群成员信息列表

updateMyTeamNick

InvocationFuture<java.lang.Void> updateMyTeamNick(java.lang.String teamId,
                                                  java.lang.String nick)

修改自己的群昵称

参数:

teamId - 所在群组ID

nick - 新的群昵称

返回:

InvocationFuture 可以设置回调函数，监听操作结果

updateMyMemberExtension

InvocationFuture<java.lang.Void> updateMyMemberExtension(java.lang.String teamId,
                                                         java.lang.String extension)

修改自己的群成员扩展字段（自定义属性，最长32个字符）

参数:

teamId - 所在群组ID

extension - 扩展字段（自定义属性）

返回:

InvocationFuture 可以设置回调函数，监听操作结果

muteTeam

InvocationFuture<java.lang.Void> muteTeam(java.lang.String teamId,
                                          TeamMessageNotifyTypeEnum notifyType)

设置指定群消息通知类型，查看TeamMessageNotifyTypeEnum

参数:

teamId - 群组ID

notifyType - 通知类型枚举

返回:

InvocationFuture 可以设置回调函数，监听操作结果

revokeMessage

InvocationFuture<java.lang.Void> revokeMessage(IMMessage message)

消息撤回 ，默认没有第三方推送（包括IOS平台的推送），参考revokeMessage(IMMessage, String, Map)

参数:

message - 待撤回的消息

返回:

InvocationFuture 可设置回调函数，监听发送结果。

revokeMessage

InvocationFuture<java.lang.Void> revokeMessage(IMMessage message,
                                               java.lang.String customApnsText,
                                               java.util.Map<java.lang.String,java.lang.Object> pushPayload)

消息撤回 ， 并设置相应的第三方推送配置（包括IOS平台的推送），如果想要关闭App内的返回消息提醒，参考NIMClient.toggleRevokeMessageNotification(boolean on)

参数:

message - 待撤回的消息

customApnsText - 第三方透传消息推送文本，不填则不推送

pushPayload - 第三方自定义的推送属性，限制json，长度2048

返回:

InvocationFuture 可设置回调函数，监听发送结果。

revokeMessage

InvocationFuture<java.lang.Void> revokeMessage(IMMessage message,
                                               java.lang.String customApnsText,
                                               java.util.Map<java.lang.String,java.lang.Object> pushPayload,
                                               boolean shouldNotifyBeCount)

消息撤回 ， 并设置相应的第三方推送配置（包括IOS平台的推送），如果想要关闭App内的返回消息提醒，参考NIMClient.toggleRevokeMessageNotification(boolean on)

参数:

message - 待撤回的消息

customApnsText - 第三方透传消息推送文本，不填则不推送

pushPayload - 第三方自定义的推送属性，限制json，长度2048

shouldNotifyBeCount - 撤回通知是否更新未读数

返回:

InvocationFuture 可设置回调函数，监听发送结果。

revokeMessage

InvocationFuture<java.lang.Void> revokeMessage(IMMessage message,
                                               java.lang.String customApnsText,
                                               java.util.Map<java.lang.String,java.lang.Object> pushPayload,
                                               boolean shouldNotifyBeCount,
                                               java.lang.String postscript)

消息撤回 ， 并设置相应的第三方推送配置（包括IOS平台的推送），如果想要关闭App内的返回消息提醒，参考NIMClient.toggleRevokeMessageNotification(boolean on)

参数:

message - 待撤回的消息

customApnsText - 第三方透传消息推送文本，不填则不推送

pushPayload - 第三方自定义的推送属性，限制json，长度2048

shouldNotifyBeCount - 撤回通知是否更新未读数

postscript - 附言

返回:

InvocationFuture 可设置回调函数，监听发送结果。

searchTeamsByKeyword

InvocationFuture<java.util.List<SuperTeam>> searchTeamsByKeyword(java.lang.String keyword)

搜索与关键字匹配的所有群

返回:

群集合

applyJoinTeam

InvocationFuture<SuperTeam> applyJoinTeam(java.lang.String tid,
                                          java.lang.String postscript)

用户申请加入群。

参数:

tid - 申请加入的群ID

postscript - 附言，长度不得超过5000

返回:

InvocationFuture 可以设置回调函数，如果成功，参数为群资料

passApply

InvocationFuture<java.lang.Void> passApply(java.lang.String teamId,
                                           java.lang.String account)

通过用户的入群申请
仅群主和管理员拥有者有此权限

参数:

teamId - 群ID

account - 申请入群的用户ID

返回:

InvocationFuture 可以设置回调函数

rejectApply

InvocationFuture<java.lang.Void> rejectApply(java.lang.String teamId,
                                             java.lang.String account,
                                             java.lang.String reason)

拒绝用户的入群申请
仅管理员和拥有者有此权限

参数:

teamId - 群ID

account - 申请入群的用户ID

reason - 拒绝理由，长度不得超过5000

返回:

InvocationFuture 可以设置回调函数

acceptInvite

InvocationFuture<java.lang.Void> acceptInvite(java.lang.String teamId,
                                              java.lang.String inviter)

接受别人的入群邀请

参数:

teamId - 群ID

inviter - 邀请我的用户帐号

返回:

InvocationFuture 可以设置回调函数

declineInvite

InvocationFuture<java.lang.Void> declineInvite(java.lang.String teamId,
                                               java.lang.String inviter,
                                               java.lang.String reason)

拒绝别人的入群邀请通知

参数:

teamId - 群ID

inviter - 邀请我的用户帐号

reason - 拒绝理由，长度不得超过5000

返回:

InvocationFuture 可以设置回调函数

sendAckSession

InvocationFuture<java.lang.Void> sendAckSession(java.lang.String teamId,
                                                long timestamp)

标记会话ACK

参数:

teamId - 群ID

timestamp - 会话最后一条ACK消息的时间戳，单位毫秒

返回:

InvocationFuture 可以设置回调函数

addManagers

InvocationFuture<java.util.List<SuperTeamMember>> addManagers(java.lang.String teamId,
                                                              java.util.List<java.lang.String> accounts)

拥有者添加管理员
仅拥有者有此权限

参数:

teamId - 群ID

accounts - 待提升为管理员的用户帐号列表

返回:

InvocationFuture 可以设置回调函数,如果成功，参数为新增的群管理员列表

removeManagers

InvocationFuture<java.util.List<SuperTeamMember>> removeManagers(java.lang.String teamId,
                                                                 java.util.List<java.lang.String> managers)

拥有者撤销管理员权限
仅拥有者有此权限

参数:

teamId - 群ID

managers - 待撤销的管理员的帐号列表

返回:

InvocationFuture 可以设置回调函数，如果成功，参数为被撤销的群成员列表(权限已被降为Normal)。

muteAllTeamMember

InvocationFuture<java.lang.Void> muteAllTeamMember(java.lang.String teamId,
                                                   boolean mute)

对整个群禁言、解除禁言，对普通成员生效，只有群组、管理员有权限

参数:

teamId - 群组 ID

mute - true表示禁言，false表示解除禁言

返回:

InvocationFuture 可以设置回调函数，监听操作结果

muteTeamMembers

InvocationFuture<java.lang.Void> muteTeamMembers(java.lang.String teamId,
                                                 java.util.ArrayList<java.lang.String> accountList,
                                                 boolean mute)

禁言、解除禁言

参数:

teamId - 群组ID

accountList - 被禁言、被解除禁言的账号列表

mute - true表示禁言，false表示解除禁言

返回:

InvocationFuture 可以设置回调函数，监听操作结果

updateMemberNick

InvocationFuture<java.lang.Void> updateMemberNick(java.lang.String teamId,
                                                  java.lang.String account,
                                                  java.lang.String nick)

群组管理员修改群内其他成员的群昵称。
仅群管理员和拥有者有此权限

参数:

teamId - 所在群组ID

account - 要修改的群成员帐号

nick - 新的群昵称

返回:

InvocationFuture 可以设置回调函数，监听操作结果

transferTeam

InvocationFuture<java.util.List<SuperTeamMember>> transferTeam(java.lang.String tid,
                                                               java.lang.String account,
                                                               boolean quit)

拥有者将群的拥有者权限转给另外一个人，转移后，另外一个人成为拥有者。
原拥有者变成普通成员。若参数quit为true，原拥有者直接退出该群。

参数:

tid - 群ID

account - 新任拥有者的用户帐号

quit - 转移时是否要同时退出该群

返回:

InvocationFuture 可以设置回调函数，如果成功，视参数quit值：
quit为false：参数仅包含原拥有者和当前拥有者的(即操作者和account)，权限已被更新。
quit为true: 参数为空。

searchTeamIdByName

InvocationFuture<java.util.List<java.lang.String>> searchTeamIdByName(java.lang.String name)

通过群名称反查群组ID

参数:

name - 群组名称

返回:

群ID列表