com.netease.nimlib.sdk.chatroom

接口 ChatRoomService

public interface ChatRoomService

聊天室接口

方法概要

限定符和类型	方法和说明
InvocationFuture<java.util.List<java.lang.String>>	batchUpdateQueue(java.lang.String roomId, java.util.List<Entry<java.lang.String,java.lang.String>> queues, boolean needNotify, java.util.Map<java.lang.String,java.lang.Object> notifyExt) 聊天室队列服务 ： 批量更新元素
AbortableFuture<java.lang.Void>	downloadAttachment(ChatRoomMessage msg, boolean thumb) 正常情况收到消息后附件会自动下载。
InvocationFuture<java.lang.Void>	dropQueue(java.lang.String roomId) 聊天室队列服务：删除队列
AbortableFuture<EnterChatRoomResultData>	enterChatRoom(EnterChatRoomData roomData) 进入聊天室
AbortableFuture<EnterChatRoomResultData>	enterChatRoomEx(EnterChatRoomData roomData, int retryCount) 进入聊天室
void	exitChatRoom(java.lang.String roomId) 离开聊天室
void	exitChatRooms(ChatRoomModeEnum mode) 离开聊天室
InvocationFuture<java.util.List<Entry<java.lang.String,java.lang.String>>>	fetchQueue(java.lang.String roomId) 聊天室队列服务：排序列出所有队列元素
InvocationFuture<ChatRoomInfo>	fetchRoomInfo(java.lang.String roomId) 获取当前聊天室信息
InvocationFuture<java.util.List<ChatRoomMember>>	fetchRoomMembers(java.lang.String roomId, MemberQueryType memberQueryType, long time, int limit) 获取聊天室成员信息
InvocationFuture<java.util.List<ChatRoomMember>>	fetchRoomMembersByIds(java.lang.String roomId, java.util.List<java.lang.String> accounts) 根据用户id获取聊天室成员信息
InvocationFuture<java.util.List<ChatRoomMember>>	fetchRoomMembersByTag(java.lang.String roomId, java.lang.String tag, long time, int limit) 获取聊天室成员信息
int	getEnterErrorCode(java.lang.String roomId) 获取进入聊天室失败的错误码 如果是手动登录，在enterChatRoom的回调函数中已有错误码。
InvocationFuture<java.util.List<ChatRoomMessage>>	getMessagesByTags(GetMessagesByTagsParam param) 通过标签从云端拉取消息
InvocationFuture<java.lang.Void>	kickMember(java.lang.String roomId, java.lang.String account, java.util.Map<java.lang.String,java.lang.Object> notifyExtension) 踢掉特定成员
InvocationFuture<ChatRoomMember>	markChatRoomBlackList(boolean isAdd, MemberOption memberOption) 添加/移出聊天室黑名单
InvocationFuture<ChatRoomMember>	markChatRoomManager(boolean isAdd, MemberOption memberOption) 设为/取消聊天室管理员
InvocationFuture<ChatRoomMember>	markChatRoomMutedList(boolean isAdd, MemberOption memberOption) 添加到禁言名单/取消禁言
InvocationFuture<java.lang.Void>	markChatRoomTempMute(boolean needNotify, long duration, MemberOption memberOption) 设置聊天室成员临时禁言
InvocationFuture<java.lang.Void>	markChatRoomTempMuteByTag(java.lang.String roomId, java.lang.String targetTag, boolean needNotify, long duration, java.util.Map<java.lang.String,java.lang.Object> notifyExtension, java.lang.String notifyTargetTags) 禁言某个标签的用户的发言，只有管理员或创建者能操作
InvocationFuture<ChatRoomMember>	markNormalMember(boolean isAdd, MemberOption memberOption) 设为/取消聊天室普通成员
InvocationFuture<Entry<java.lang.String,java.lang.String>>	pollQueue(java.lang.String roomId, java.lang.String key) 聊天室队列服务：取出队列头部或者指定元素
InvocationFuture<java.util.List<NimRobotInfo>>	pullAllRobots(java.lang.String roomId) 独立聊天室场景下，获取当前全部聊天室机器人
InvocationFuture<java.util.List<ChatRoomMessage>>	pullMessageHistory(java.lang.String roomId, long startTime, int limit) 获取历史消息，默认从给定时间点往前查询，排序为时间逆序
InvocationFuture<java.util.List<ChatRoomMessage>>	pullMessageHistoryEx(java.lang.String roomId, long startTime, int limit, QueryDirectionEnum direction) 获取历史消息,可选择给定时间往前或者往后查询，若方向往前，则结果排序按时间逆序，反之则结果排序按时间顺序。
InvocationFuture<java.util.List<ChatRoomMessage>>	pullMessageHistoryExType(java.lang.String roomId, long startTime, int limit, QueryDirectionEnum direction, MsgTypeEnum[] typeEnums) 获取历史消息,可选择给定时间往前或者往后查询，以及查询指定一种或多种类型的消息。
InvocationFuture<java.lang.Long>	queryTagMembersCount(java.lang.String roomId, java.lang.String tag) 根据用户id获取聊天室成员信息
InvocationFuture<java.lang.Void>	sendMessage(ChatRoomMessage msg, boolean resend) 发送消息
InvocationFuture<java.lang.Void>	updateChatRoomTags(java.lang.String roomId, ChatRoomTagsInfo tagsInfo) 更新聊天室标签
InvocationFuture<java.lang.Void>	updateLocation(java.lang.String roomId, ChatRoomSpatialLocation location) 更新位置信息 注意：每300ms只能上报一次位置信息给服务器，300ms 内多次调用返回 416
InvocationFuture<java.lang.Void>	updateMyRoomRole(java.lang.String roomId, ChatRoomMemberUpdate chatRoomMemberUpdate, boolean needNotify, java.util.Map<java.lang.String,java.lang.Object> notifyExtension) 更新本人在聊天室内的信息
InvocationFuture<java.lang.Void>	updateMyRoomRole(java.lang.String roomId, ChatRoomMemberUpdate chatRoomMemberUpdate, boolean needNotify, java.util.Map<java.lang.String,java.lang.Object> notifyExtension, AntiSpamConfig antiSpamConfig) 更新本人在聊天室内的信息
InvocationFuture<java.lang.Void>	updateQueue(java.lang.String roomId, java.lang.String key, java.lang.String value) 聊天室队列服务：加入或者更新队列元素
InvocationFuture<java.lang.Void>	updateQueue(java.lang.String roomId, java.lang.String key, java.lang.String value, boolean isTransient, java.lang.String elementAccid) 聊天室队列服务：加入或者更新队列元素，支持当用户掉线或退出聊天室后，是否删除这个元素
InvocationFuture<java.lang.Void>	updateQueueEx(java.lang.String roomId, java.lang.String key, java.lang.String value, boolean isTransient) 聊天室队列服务：加入或者更新队列元素，支持当用户掉线或退出聊天室后，是否删除这个元素
InvocationFuture<java.lang.Void>	updateRoomInfo(java.lang.String roomId, ChatRoomUpdateInfo chatRoomUpdateInfo, boolean needNotify, java.util.Map<java.lang.String,java.lang.Object> notifyExtension) 更新聊天室信息
InvocationFuture<java.lang.Void>	updateRoomInfo(java.lang.String roomId, ChatRoomUpdateInfo chatRoomUpdateInfo, boolean needNotify, java.util.Map<java.lang.String,java.lang.Object> notifyExtension, AntiSpamConfig antiSpamConfig) 更新聊天室信息

方法详细资料

enterChatRoom

AbortableFuture<EnterChatRoomResultData> enterChatRoom(EnterChatRoomData roomData)

进入聊天室

参数:

roomData - 聊天室基本数据（聊天室ID必填）

返回:

InvocationFuture 可取消的回调函数。回调中返回聊天室基本信息

enterChatRoomEx

AbortableFuture<EnterChatRoomResultData> enterChatRoomEx(EnterChatRoomData roomData,
                                                         int retryCount)

进入聊天室

参数:

roomData - 聊天室基本数据（聊天室ID必填）

retryCount - 如果进入失败，重试次数

返回:

InvocationFuture 可取消的回调函数。回调中返回聊天室基本信息

getEnterErrorCode

int getEnterErrorCode(java.lang.String roomId)

获取进入聊天室失败的错误码 如果是手动登录，在enterChatRoom的回调函数中已有错误码。 如果是断网重连，在自动登录失败时，即监听到在线状态变更为UNLOGIN时，可以采用此接口查看具体自动登录失败的原因。

参数:

roomId - 聊天室ID

返回:

聊天室断网重连、自动登录失败的错误码

exitChatRoom

void exitChatRoom(java.lang.String roomId)

离开聊天室

参数:

roomId - 聊天室ID

exitChatRooms

void exitChatRooms(ChatRoomModeEnum mode)

离开聊天室

参数:

mode - 聊天室类型

sendMessage

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

发送消息

参数:

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

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

返回:

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

downloadAttachment

AbortableFuture<java.lang.Void> downloadAttachment(ChatRoomMessage msg,
                                                   boolean thumb)

正常情况收到消息后附件会自动下载。如果下载失败，可调用该接口重新下载。

参数:

msg - 附件所在的消息体

thumb - 下载缩略图还是原文件。为true时，仅下载缩略图。
该参数仅对图片和视频类消息有效

返回:

AbortableFuture 调用跟踪。可设置回调函数，可中止下载操作

pullMessageHistory

InvocationFuture<java.util.List<ChatRoomMessage>> pullMessageHistory(java.lang.String roomId,
                                                                     long startTime,
                                                                     int limit)

获取历史消息，默认从给定时间点往前查询，排序为时间逆序

参数:

roomId - 聊天室id

startTime - 时间戳，单位毫秒

limit - 可拉取的消息数量

返回:

InvocationFuture 可以设置回调函数。回调中返回历史消息列表

pullMessageHistoryEx

InvocationFuture<java.util.List<ChatRoomMessage>> pullMessageHistoryEx(java.lang.String roomId,
                                                                       long startTime,
                                                                       int limit,
                                                                       QueryDirectionEnum direction)

获取历史消息,可选择给定时间往前或者往后查询，若方向往前，则结果排序按时间逆序，反之则结果排序按时间顺序。

参数:

roomId - 聊天室id

startTime - 时间戳，单位毫秒

limit - 可拉取的消息数量

direction - 查询方向

返回:

InvocationFuture 可以设置回调函数。回调中返回历史消息列表

pullMessageHistoryExType

InvocationFuture<java.util.List<ChatRoomMessage>> pullMessageHistoryExType(java.lang.String roomId,
                                                                           long startTime,
                                                                           int limit,
                                                                           QueryDirectionEnum direction,
                                                                           MsgTypeEnum[] typeEnums)

获取历史消息,可选择给定时间往前或者往后查询，以及查询指定一种或多种类型的消息。

若方向往前，则结果排序按时间逆序，反之则结果排序按时间顺序

消息类型仅支持 0:文本，1:图片，2:语音，3:视频，4:地理位置，5:通知，6:文件，10:提示，11:Robot，100:自定义，其它为非法参数

参数:

roomId - 聊天室id

startTime - 时间戳，单位毫秒

limit - 可拉取的消息数量

direction - 查询方向

typeEnums - 消息类型，数组

返回:

InvocationFuture 可以设置回调函数。回调中返回历史消息列表

getMessagesByTags

InvocationFuture<java.util.List<ChatRoomMessage>> getMessagesByTags(GetMessagesByTagsParam param)

通过标签从云端拉取消息

参数:

param - 参数

返回:

InvocationFuture 可以设置回调函数。回调中返回历史消息列表

fetchRoomInfo

InvocationFuture<ChatRoomInfo> fetchRoomInfo(java.lang.String roomId)

获取当前聊天室信息

参数:

roomId - 聊天室id

返回:

InvocationFuture 可以设置回调函数。回调中返回聊天室的信息

fetchRoomMembers

InvocationFuture<java.util.List<ChatRoomMember>> fetchRoomMembers(java.lang.String roomId,
                                                                  MemberQueryType memberQueryType,
                                                                  long time,
                                                                  int limit)

获取聊天室成员信息

参数:

roomId - 聊天室id

memberQueryType - 成员查询类型。见MemberQueryType

time - 固定成员列表用updateTime, 游客列表用进入enterTime， 填0会使用当前服务器最新时间开始查询，即第一页，单位毫秒

limit - 条数限制

返回:

InvocationFuture 可以设置回调函数。回调中返回成员信息列表

fetchRoomMembersByTag

InvocationFuture<java.util.List<ChatRoomMember>> fetchRoomMembersByTag(java.lang.String roomId,
                                                                       java.lang.String tag,
                                                                       long time,
                                                                       int limit)

获取聊天室成员信息

参数:

roomId - 聊天室id

tag - 标签

time - 起始时间，逆序查询，若传0则表示从当前时间往前查

limit - 条数

返回:

InvocationFuture 可以设置回调函数。回调中返回成员信息列表

fetchRoomMembersByIds

InvocationFuture<java.util.List<ChatRoomMember>> fetchRoomMembersByIds(java.lang.String roomId,
                                                                       java.util.List<java.lang.String> accounts)

根据用户id获取聊天室成员信息

参数:

roomId - 聊天室id

accounts - 成员帐号列表

返回:

InvocationFuture 可以设置回调函数。回调中返回成员信息列表

queryTagMembersCount

InvocationFuture<java.lang.Long> queryTagMembersCount(java.lang.String roomId,
                                                      java.lang.String tag)

根据用户id获取聊天室成员信息

参数:

roomId - 聊天室id

tag - 标签

返回:

InvocationFuture 可以设置回调函数。回调中返回成员信息列表

markChatRoomBlackList

InvocationFuture<ChatRoomMember> markChatRoomBlackList(boolean isAdd,
                                                       MemberOption memberOption)

添加/移出聊天室黑名单

参数:

isAdd - true:添加, false:移出

memberOption - 请求参数，包含聊天室id，帐号id以及可选的扩展字段

返回:

InvocationFuture 可以设置回调函数。回调中返回成员信息

markChatRoomMutedList

InvocationFuture<ChatRoomMember> markChatRoomMutedList(boolean isAdd,
                                                       MemberOption memberOption)

添加到禁言名单/取消禁言

参数:

isAdd - true:添加, false:取消

memberOption - 请求参数，包含聊天室id，帐号id以及可选的扩展字段

返回:

InvocationFuture 可以设置回调函数。回调中返回成员信息

markChatRoomTempMute

InvocationFuture<java.lang.Void> markChatRoomTempMute(boolean needNotify,
                                                      long duration,
                                                      MemberOption memberOption)

设置聊天室成员临时禁言

参数:

needNotify - 是否需要发送广播通知，true：通知，false：不通知

duration - 禁言时长,单位秒

memberOption - 请求参数，包含聊天室id，帐号id以及可选的扩展字段

返回:

InvocationFuture 可以设置回调函数。如果出错，会有具体的错误代码。

markChatRoomTempMuteByTag

InvocationFuture<java.lang.Void> markChatRoomTempMuteByTag(java.lang.String roomId,
                                                           java.lang.String targetTag,
                                                           boolean needNotify,
                                                           long duration,
                                                           java.util.Map<java.lang.String,java.lang.Object> notifyExtension,
                                                           java.lang.String notifyTargetTags)

禁言某个标签的用户的发言，只有管理员或创建者能操作

参数:

roomId - 聊天室id

targetTag - 禁言的tag

needNotify - 是否需要发送广播通知，true：通知，false：不通知

duration - 禁言时长,单位秒

notifyExtension - 操作产生的通知事件中开发者自定义的扩展字段（可选）

notifyTargetTags - 禁言通知广播的目标标签，默认是TARGET_TAG，这是一个标签表达式

返回:

InvocationFuture 可以设置回调函数。如果出错，会有具体的错误代码。

markChatRoomManager

InvocationFuture<ChatRoomMember> markChatRoomManager(boolean isAdd,
                                                     MemberOption memberOption)

设为/取消聊天室管理员

参数:

isAdd - true:设为, false:取消

memberOption - 请求参数，包含聊天室id，帐号id以及可选的扩展字段

返回:

InvocationFuture 可以设置回调函数。回调中返回成员信息

markNormalMember

InvocationFuture<ChatRoomMember> markNormalMember(boolean isAdd,
                                                  MemberOption memberOption)

设为/取消聊天室普通成员

参数:

isAdd - true:设为, false:取消

memberOption - 请求参数，包含聊天室id，帐号id以及可选的扩展字段

返回:

InvocationFuture 可以设置回调函数。回调中返回成员信息

kickMember

InvocationFuture<java.lang.Void> kickMember(java.lang.String roomId,
                                            java.lang.String account,
                                            java.util.Map<java.lang.String,java.lang.Object> notifyExtension)

踢掉特定成员

参数:

roomId - 聊天室id

account - 踢出成员帐号。仅管理员可以踢；如目标是管理员仅创建者可以踢

notifyExtension - 被踢通知扩展字段，这个字段会放到被踢通知的扩展字段中

返回:

InvocationFuture 可以设置回调函数。踢掉成员完成之后才会调用，如果出错，会有具体的错误代码。

updateRoomInfo

InvocationFuture<java.lang.Void> updateRoomInfo(java.lang.String roomId,
                                                ChatRoomUpdateInfo chatRoomUpdateInfo,
                                                boolean needNotify,
                                                java.util.Map<java.lang.String,java.lang.Object> notifyExtension)

更新聊天室信息

参数:

roomId - 聊天室id

chatRoomUpdateInfo - 可更新的聊天室信息

needNotify - 是否通知

notifyExtension - 更新聊天室信息扩展字段，这个字段会放到更新聊天室信息通知的扩展字段中

返回:

InvocationFuture 可以设置回调函数。更新聊天室信息完成之后才会调用，如果出错，会有具体的错误代码。

updateRoomInfo

InvocationFuture<java.lang.Void> updateRoomInfo(java.lang.String roomId,
                                                ChatRoomUpdateInfo chatRoomUpdateInfo,
                                                boolean needNotify,
                                                java.util.Map<java.lang.String,java.lang.Object> notifyExtension,
                                                AntiSpamConfig antiSpamConfig)

更新聊天室信息

参数:

roomId - 聊天室id

chatRoomUpdateInfo - 可更新的聊天室信息

needNotify - 是否通知

notifyExtension - 更新聊天室信息扩展字段，这个字段会放到更新聊天室信息通知的扩展字段中

antiSpamConfig - 反垃圾配置参数

返回:

InvocationFuture 可以设置回调函数。更新聊天室信息完成之后才会调用，如果出错，会有具体的错误代码。

updateMyRoomRole

InvocationFuture<java.lang.Void> updateMyRoomRole(java.lang.String roomId,
                                                  ChatRoomMemberUpdate chatRoomMemberUpdate,
                                                  boolean needNotify,
                                                  java.util.Map<java.lang.String,java.lang.Object> notifyExtension)

更新本人在聊天室内的信息

参数:

roomId - 聊天室id

chatRoomMemberUpdate - 可更新的本人角色信息

needNotify - 是否通知

notifyExtension - 更新聊天室信息扩展字段，这个字段会放到更新聊天室信息通知的扩展字段中,最大长度2k

返回:

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

updateMyRoomRole

InvocationFuture<java.lang.Void> updateMyRoomRole(java.lang.String roomId,
                                                  ChatRoomMemberUpdate chatRoomMemberUpdate,
                                                  boolean needNotify,
                                                  java.util.Map<java.lang.String,java.lang.Object> notifyExtension,
                                                  AntiSpamConfig antiSpamConfig)

更新本人在聊天室内的信息

参数:

roomId - 聊天室id

chatRoomMemberUpdate - 可更新的本人角色信息

needNotify - 是否通知

notifyExtension - 更新聊天室信息扩展字段，这个字段会放到更新聊天室信息通知的扩展字段中,最大长度2k

antiSpamConfig - 反垃圾配置参数

返回:

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

updateQueue

InvocationFuture<java.lang.Void> updateQueue(java.lang.String roomId,
                                             java.lang.String key,
                                             java.lang.String value)

聊天室队列服务：加入或者更新队列元素

参数:

roomId - 聊天室id

key - 新元素（或待更新元素）的唯一键

value - 新元素（待待更新元素）的内容

返回:

InvocationFuture 可以设置回调函数。回调中返回操作成功或者失败具体的错误码。

updateQueueEx

InvocationFuture<java.lang.Void> updateQueueEx(java.lang.String roomId,
                                               java.lang.String key,
                                               java.lang.String value,
                                               boolean isTransient)

聊天室队列服务：加入或者更新队列元素，支持当用户掉线或退出聊天室后，是否删除这个元素

参数:

roomId - 聊天室id

key - 新元素（或待更新元素）的唯一键

value - 新元素（待待更新元素）的内容

isTransient - true表示当提交这个新元素的用户从聊天室掉线或退出的时候，需要删除这个元素；默认false表示不删除

返回:

InvocationFuture 可以设置回调函数。回调中返回操作成功或者失败具体的错误码。

updateQueue

InvocationFuture<java.lang.Void> updateQueue(java.lang.String roomId,
                                             java.lang.String key,
                                             java.lang.String value,
                                             boolean isTransient,
                                             java.lang.String elementAccid)

聊天室队列服务：加入或者更新队列元素，支持当用户掉线或退出聊天室后，是否删除这个元素

参数:

roomId - 聊天室id

key - 新元素（或待更新元素）的唯一键

value - 新元素（待待更新元素）的内容

isTransient - true表示当提交这个新元素的用户从聊天室掉线或退出的时候，需要删除这个元素；默认false表示不删除

elementAccid - 队列元素所属账号，默认不传表示队列元素属于当前操作人，管理员可以指定队列元素归属于其他合法账号

返回:

InvocationFuture 可以设置回调函数。回调中返回操作成功或者失败具体的错误码。

batchUpdateQueue

InvocationFuture<java.util.List<java.lang.String>> batchUpdateQueue(java.lang.String roomId,
                                                                    java.util.List<Entry<java.lang.String,java.lang.String>> queues,
                                                                    boolean needNotify,
                                                                    java.util.Map<java.lang.String,java.lang.Object> notifyExt)

聊天室队列服务 ： 批量更新元素

参数:

roomId - 聊天室id

queues - 待更新的队列元素

needNotify - 是否需要发送广播通知

notifyExt - 通知中的自定义字段 ， 最大长度2k

返回:

不存在的元素elementKey列表

pollQueue

InvocationFuture<Entry<java.lang.String,java.lang.String>> pollQueue(java.lang.String roomId,
                                                                     java.lang.String key)

聊天室队列服务：取出队列头部或者指定元素

参数:

roomId - 聊天室id

key - 需要取出的元素的唯一键。若为 null，则表示取出队头元素

返回:

InvocationFuture 可以设置回调函数。如果元素存在或者队列不为空，那么回调中返回元素的键值对，否则返回失败错误码。

fetchQueue

InvocationFuture<java.util.List<Entry<java.lang.String,java.lang.String>>> fetchQueue(java.lang.String roomId)

聊天室队列服务：排序列出所有队列元素

参数:

roomId - 聊天室id

返回:

InvocationFuture 可设置回调函数。回调中返回所有排列的队列元素键值对。

dropQueue

InvocationFuture<java.lang.Void> dropQueue(java.lang.String roomId)

聊天室队列服务：删除队列

参数:

roomId - 聊天室id

返回:

InvocationFuture 可设置回调函数。回调中返回操作成功或者失败具体的错误码。

pullAllRobots

InvocationFuture<java.util.List<NimRobotInfo>> pullAllRobots(java.lang.String roomId)

独立聊天室场景下，获取当前全部聊天室机器人

参数:

roomId - 当前聊天室id

返回:

InvocationFuture 可设置回调函数。回调中返回操作成功或者失败具体的错误码。

updateChatRoomTags

InvocationFuture<java.lang.Void> updateChatRoomTags(java.lang.String roomId,
                                                    ChatRoomTagsInfo tagsInfo)

更新聊天室标签

参数:

roomId - 当前聊天室id

tagsInfo - 标签信息

返回:

updateLocation

InvocationFuture<java.lang.Void> updateLocation(java.lang.String roomId,
                                                ChatRoomSpatialLocation location)

更新位置信息 注意：每300ms只能上报一次位置信息给服务器，300ms 内多次调用返回 416

参数:

roomId - 当前聊天室id

location - 空间位置信息

返回: