NIMSDK-AOS
9.17.0
|
聊天室接口 更多...
Public 成员函数 | |
AbortableFuture< EnterChatRoomResultData > | enterChatRoom (EnterChatRoomData roomData) |
进入聊天室 更多... | |
AbortableFuture< EnterChatRoomResultData > | enterChatRoomEx (EnterChatRoomData roomData, int retryCount) |
进入聊天室 更多... | |
int | getEnterErrorCode (String roomId) |
获取进入聊天室失败的错误码 如果是手动登录,在enterChatRoom的回调函数中已有错误码。 如果是断网重连,在自动登录失败时,即监听到在线状态变更为UNLOGIN时,可以采用此接口查看具体自动登录失败的原因。 更多... | |
void | exitChatRoom (String roomId) |
离开聊天室 更多... | |
void | exitChatRooms (ChatRoomModeEnum mode) |
离开聊天室 更多... | |
InvocationFuture< Void > | sendMessage (ChatRoomMessage msg, boolean resend) |
发送消息 更多... | |
AbortableFuture< Void > | downloadAttachment (ChatRoomMessage msg, boolean thumb) |
正常情况收到消息后附件会自动下载。如果下载失败,可调用该接口重新下载。 更多... | |
InvocationFuture< List< ChatRoomMessage > > | pullMessageHistory (String roomId, long startTime, int limit) |
获取历史消息,默认从给定时间点往前查询,排序为时间逆序 更多... | |
InvocationFuture< List< ChatRoomMessage > > | pullMessageHistoryEx (String roomId, long startTime, int limit, QueryDirectionEnum direction) |
获取历史消息,可选择给定时间往前或者往后查询,若方向往前,则结果排序按时间逆序,反之则结果排序按时间顺序。 更多... | |
InvocationFuture< List< ChatRoomMessage > > | pullMessageHistoryExType (String roomId, long startTime, int limit, QueryDirectionEnum direction, MsgTypeEnum[] typeEnums) |
获取历史消息,可选择给定时间往前或者往后查询,以及查询指定一种或多种类型的消息。 更多... | |
InvocationFuture< List< ChatRoomMessage > > | getMessagesByTags (GetMessagesByTagsParam param) |
通过标签从云端拉取消息 更多... | |
InvocationFuture< ChatRoomInfo > | fetchRoomInfo (String roomId) |
获取当前聊天室信息 更多... | |
InvocationFuture< List< ChatRoomMember > > | fetchRoomMembers (String roomId, MemberQueryType memberQueryType, long time, int limit) |
获取聊天室成员信息 更多... | |
InvocationFuture< List< ChatRoomMember > > | fetchRoomMembersByTag (String roomId, String tag, long time, int limit) |
获取聊天室成员信息 更多... | |
InvocationFuture< List< ChatRoomMember > > | fetchRoomMembersByIds (String roomId, List< String > accounts) |
根据用户id获取聊天室成员信息 更多... | |
InvocationFuture< Long > | queryTagMembersCount (String roomId, String tag) |
根据用户id获取聊天室成员信息 更多... | |
InvocationFuture< ChatRoomMember > | markChatRoomBlackList (boolean isAdd, MemberOption memberOption) |
添加/移出聊天室黑名单 更多... | |
InvocationFuture< ChatRoomMember > | markChatRoomMutedList (boolean isAdd, MemberOption memberOption) |
添加到禁言名单/取消禁言 更多... | |
InvocationFuture< Void > | markChatRoomTempMute (boolean needNotify, long duration, MemberOption memberOption) |
设置聊天室成员临时禁言 更多... | |
InvocationFuture< Void > | markChatRoomTempMuteByTag (String roomId, String targetTag, boolean needNotify, long duration, Map< String, Object > notifyExtension, String notifyTargetTags) |
禁言某个标签的用户的发言,只有管理员或创建者能操作 更多... | |
InvocationFuture< ChatRoomMember > | markChatRoomManager (boolean isAdd, MemberOption memberOption) |
设为/取消聊天室管理员 更多... | |
InvocationFuture< ChatRoomMember > | markNormalMember (boolean isAdd, MemberOption memberOption) |
设为/取消聊天室普通成员 更多... | |
InvocationFuture< Void > | kickMember (String roomId, String account, Map< String, Object > notifyExtension) |
踢掉特定成员 更多... | |
InvocationFuture< Void > | updateRoomInfo (String roomId, ChatRoomUpdateInfo chatRoomUpdateInfo, boolean needNotify, Map< String, Object > notifyExtension) |
更新聊天室信息 更多... | |
InvocationFuture< Void > | updateRoomInfo (String roomId, ChatRoomUpdateInfo chatRoomUpdateInfo, boolean needNotify, Map< String, Object > notifyExtension, AntiSpamConfig antiSpamConfig) |
更新聊天室信息 更多... | |
InvocationFuture< Void > | updateMyRoomRole (String roomId, ChatRoomMemberUpdate chatRoomMemberUpdate, boolean needNotify, Map< String, Object > notifyExtension) |
更新本人在聊天室内的信息 更多... | |
InvocationFuture< Void > | updateMyRoomRole (String roomId, ChatRoomMemberUpdate chatRoomMemberUpdate, boolean needNotify, Map< String, Object > notifyExtension, AntiSpamConfig antiSpamConfig) |
更新本人在聊天室内的信息 更多... | |
InvocationFuture< Void > | updateQueue (String roomId, String key, String value) |
聊天室队列服务:加入或者更新队列元素 更多... | |
InvocationFuture< Void > | updateQueueEx (String roomId, String key, String value, boolean isTransient) |
聊天室队列服务:加入或者更新队列元素,支持当用户掉线或退出聊天室后,是否删除这个元素 更多... | |
InvocationFuture< Void > | updateQueue (String roomId, String key, String value, boolean isTransient, String elementAccid) |
聊天室队列服务:加入或者更新队列元素,支持当用户掉线或退出聊天室后,是否删除这个元素 更多... | |
InvocationFuture< List< String > > | batchUpdateQueue (String roomId, List< Entry< String, String >> queues, boolean needNotify, Map< String, Object > notifyExt) |
聊天室队列服务 : 批量更新元素 更多... | |
InvocationFuture< Entry< String, String > > | pollQueue (String roomId, String key) |
聊天室队列服务:取出队列头部或者指定元素 更多... | |
InvocationFuture< List< Entry< String, String > > > | fetchQueue (String roomId) |
聊天室队列服务:排序列出所有队列元素 更多... | |
InvocationFuture< Void > | dropQueue (String roomId) |
聊天室队列服务:删除队列 更多... | |
InvocationFuture< List< NimRobotInfo > > | pullAllRobots (String roomId) |
独立聊天室场景下,获取当前全部聊天室机器人 更多... | |
InvocationFuture< Void > | updateChatRoomTags (String roomId, ChatRoomTagsInfo tagsInfo) |
更新聊天室标签 更多... | |
InvocationFuture< Void > | updateLocation (String roomId, ChatRoomSpatialLocation location) |
更新位置信息 注意:每300ms只能上报一次位置信息给服务器,300ms 内多次调用返回 416 更多... | |
聊天室接口
在文件 ChatRoomService.java 第 34 行定义.
InvocationFuture<List<String> > com.netease.nimlib.sdk.chatroom.ChatRoomService.batchUpdateQueue | ( | String | roomId, |
List< Entry< String, String >> | queues, | ||
boolean | needNotify, | ||
Map< String, Object > | notifyExt | ||
) |
聊天室队列服务 : 批量更新元素
roomId | 聊天室id |
queues | 待更新的队列元素 |
needNotify | 是否需要发送广播通知 |
notifyExt | 通知中的自定义字段 , 最大长度2k |
AbortableFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.downloadAttachment | ( | ChatRoomMessage | msg, |
boolean | thumb | ||
) |
正常情况收到消息后附件会自动下载。如果下载失败,可调用该接口重新下载。
msg | 附件所在的消息体 |
thumb | 下载缩略图还是原文件。为true时,仅下载缩略图。 该参数仅对图片和视频类消息有效 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.dropQueue | ( | String | roomId | ) |
AbortableFuture<EnterChatRoomResultData> com.netease.nimlib.sdk.chatroom.ChatRoomService.enterChatRoom | ( | EnterChatRoomData | roomData | ) |
AbortableFuture<EnterChatRoomResultData> com.netease.nimlib.sdk.chatroom.ChatRoomService.enterChatRoomEx | ( | EnterChatRoomData | roomData, |
int | retryCount | ||
) |
void com.netease.nimlib.sdk.chatroom.ChatRoomService.exitChatRoom | ( | String | roomId | ) |
离开聊天室
roomId | 聊天室ID |
void com.netease.nimlib.sdk.chatroom.ChatRoomService.exitChatRooms | ( | ChatRoomModeEnum | mode | ) |
离开聊天室
mode | 聊天室类型 |
InvocationFuture<List<Entry<String, String> > > com.netease.nimlib.sdk.chatroom.ChatRoomService.fetchQueue | ( | String | roomId | ) |
InvocationFuture<ChatRoomInfo> com.netease.nimlib.sdk.chatroom.ChatRoomService.fetchRoomInfo | ( | String | roomId | ) |
InvocationFuture<List<ChatRoomMember> > com.netease.nimlib.sdk.chatroom.ChatRoomService.fetchRoomMembers | ( | String | roomId, |
MemberQueryType | memberQueryType, | ||
long | time, | ||
int | limit | ||
) |
获取聊天室成员信息
roomId | 聊天室id |
memberQueryType | 成员查询类型。见MemberQueryType |
time | 固定成员列表用updateTime, 游客列表用进入enterTime, 填0会使用当前服务器最新时间开始查询,即第一页,单位毫秒 |
limit | 条数限制 |
InvocationFuture<List<ChatRoomMember> > com.netease.nimlib.sdk.chatroom.ChatRoomService.fetchRoomMembersByIds | ( | String | roomId, |
List< String > | accounts | ||
) |
InvocationFuture<List<ChatRoomMember> > com.netease.nimlib.sdk.chatroom.ChatRoomService.fetchRoomMembersByTag | ( | String | roomId, |
String | tag, | ||
long | time, | ||
int | limit | ||
) |
获取聊天室成员信息
roomId | 聊天室id |
tag | 标签 |
time | 起始时间,逆序查询,若传0则表示从当前时间往前查 |
limit | 条数 |
int com.netease.nimlib.sdk.chatroom.ChatRoomService.getEnterErrorCode | ( | String | roomId | ) |
获取进入聊天室失败的错误码 如果是手动登录,在enterChatRoom的回调函数中已有错误码。 如果是断网重连,在自动登录失败时,即监听到在线状态变更为UNLOGIN时,可以采用此接口查看具体自动登录失败的原因。
roomId | 聊天室ID |
InvocationFuture<List<ChatRoomMessage> > com.netease.nimlib.sdk.chatroom.ChatRoomService.getMessagesByTags | ( | GetMessagesByTagsParam | param | ) |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.kickMember | ( | String | roomId, |
String | account, | ||
Map< String, Object > | notifyExtension | ||
) |
踢掉特定成员
roomId | 聊天室id |
account | 踢出成员帐号。仅管理员可以踢;如目标是管理员仅创建者可以踢 |
notifyExtension | 被踢通知扩展字段,这个字段会放到被踢通知的扩展字段中 |
InvocationFuture<ChatRoomMember> com.netease.nimlib.sdk.chatroom.ChatRoomService.markChatRoomBlackList | ( | boolean | isAdd, |
MemberOption | memberOption | ||
) |
添加/移出聊天室黑名单
isAdd | true:添加, false:移出 |
memberOption | 请求参数,包含聊天室id,帐号id以及可选的扩展字段 |
InvocationFuture<ChatRoomMember> com.netease.nimlib.sdk.chatroom.ChatRoomService.markChatRoomManager | ( | boolean | isAdd, |
MemberOption | memberOption | ||
) |
设为/取消聊天室管理员
isAdd | true:设为, false:取消 |
memberOption | 请求参数,包含聊天室id,帐号id以及可选的扩展字段 |
InvocationFuture<ChatRoomMember> com.netease.nimlib.sdk.chatroom.ChatRoomService.markChatRoomMutedList | ( | boolean | isAdd, |
MemberOption | memberOption | ||
) |
添加到禁言名单/取消禁言
isAdd | true:添加, false:取消 |
memberOption | 请求参数,包含聊天室id,帐号id以及可选的扩展字段 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.markChatRoomTempMute | ( | boolean | needNotify, |
long | duration, | ||
MemberOption | memberOption | ||
) |
设置聊天室成员临时禁言
needNotify | 是否需要发送广播通知,true:通知,false:不通知 |
duration | 禁言时长,单位秒 |
memberOption | 请求参数,包含聊天室id,帐号id以及可选的扩展字段 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.markChatRoomTempMuteByTag | ( | String | roomId, |
String | targetTag, | ||
boolean | needNotify, | ||
long | duration, | ||
Map< String, Object > | notifyExtension, | ||
String | notifyTargetTags | ||
) |
禁言某个标签的用户的发言,只有管理员或创建者能操作
roomId | 聊天室id |
targetTag | 禁言的tag |
needNotify | 是否需要发送广播通知,true:通知,false:不通知 |
duration | 禁言时长,单位秒 |
notifyExtension | 操作产生的通知事件中开发者自定义的扩展字段(可选) |
notifyTargetTags | 禁言通知广播的目标标签,默认是TARGET_TAG,这是一个标签表达式 |
InvocationFuture<ChatRoomMember> com.netease.nimlib.sdk.chatroom.ChatRoomService.markNormalMember | ( | boolean | isAdd, |
MemberOption | memberOption | ||
) |
设为/取消聊天室普通成员
isAdd | true:设为, false:取消 |
memberOption | 请求参数,包含聊天室id,帐号id以及可选的扩展字段 |
InvocationFuture<Entry<String, String> > com.netease.nimlib.sdk.chatroom.ChatRoomService.pollQueue | ( | String | roomId, |
String | key | ||
) |
聊天室队列服务:取出队列头部或者指定元素
roomId | 聊天室id |
key | 需要取出的元素的唯一键。若为 null,则表示取出队头元素 |
InvocationFuture<List<NimRobotInfo> > com.netease.nimlib.sdk.chatroom.ChatRoomService.pullAllRobots | ( | String | roomId | ) |
InvocationFuture<List<ChatRoomMessage> > com.netease.nimlib.sdk.chatroom.ChatRoomService.pullMessageHistory | ( | String | roomId, |
long | startTime, | ||
int | limit | ||
) |
获取历史消息,默认从给定时间点往前查询,排序为时间逆序
roomId | 聊天室id |
startTime | 时间戳,单位毫秒 |
limit | 可拉取的消息数量 |
InvocationFuture<List<ChatRoomMessage> > com.netease.nimlib.sdk.chatroom.ChatRoomService.pullMessageHistoryEx | ( | String | roomId, |
long | startTime, | ||
int | limit, | ||
QueryDirectionEnum | direction | ||
) |
获取历史消息,可选择给定时间往前或者往后查询,若方向往前,则结果排序按时间逆序,反之则结果排序按时间顺序。
roomId | 聊天室id |
startTime | 时间戳,单位毫秒 |
limit | 可拉取的消息数量 |
direction | 查询方向 |
InvocationFuture<List<ChatRoomMessage> > com.netease.nimlib.sdk.chatroom.ChatRoomService.pullMessageHistoryExType | ( | 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<Long> com.netease.nimlib.sdk.chatroom.ChatRoomService.queryTagMembersCount | ( | String | roomId, |
String | tag | ||
) |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.sendMessage | ( | ChatRoomMessage | msg, |
boolean | resend | ||
) |
发送消息
msg | 带发送的消息体,由ChatRoomMessageBuilder构造。 |
resend | 如果是发送失败后重发,标记为true,否则填false。 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.updateChatRoomTags | ( | String | roomId, |
ChatRoomTagsInfo | tagsInfo | ||
) |
更新聊天室标签
roomId | 当前聊天室id |
tagsInfo | 标签信息 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.updateLocation | ( | String | roomId, |
ChatRoomSpatialLocation | location | ||
) |
更新位置信息 注意:每300ms只能上报一次位置信息给服务器,300ms 内多次调用返回 416
roomId | 当前聊天室id |
location | 空间位置信息 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.updateMyRoomRole | ( | String | roomId, |
ChatRoomMemberUpdate | chatRoomMemberUpdate, | ||
boolean | needNotify, | ||
Map< String, Object > | notifyExtension | ||
) |
更新本人在聊天室内的信息
roomId | 聊天室id |
chatRoomMemberUpdate | 可更新的本人角色信息 |
needNotify | 是否通知 |
notifyExtension | 更新聊天室信息扩展字段,这个字段会放到更新聊天室信息通知的扩展字段中,最大长度2k |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.updateMyRoomRole | ( | String | roomId, |
ChatRoomMemberUpdate | chatRoomMemberUpdate, | ||
boolean | needNotify, | ||
Map< String, Object > | notifyExtension, | ||
AntiSpamConfig | antiSpamConfig | ||
) |
更新本人在聊天室内的信息
roomId | 聊天室id |
chatRoomMemberUpdate | 可更新的本人角色信息 |
needNotify | 是否通知 |
notifyExtension | 更新聊天室信息扩展字段,这个字段会放到更新聊天室信息通知的扩展字段中,最大长度2k |
antiSpamConfig | 反垃圾配置参数 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.updateQueue | ( | String | roomId, |
String | key, | ||
String | value | ||
) |
聊天室队列服务:加入或者更新队列元素
roomId | 聊天室id |
key | 新元素(或待更新元素)的唯一键 |
value | 新元素(待待更新元素)的内容 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.updateQueue | ( | String | roomId, |
String | key, | ||
String | value, | ||
boolean | isTransient, | ||
String | elementAccid | ||
) |
聊天室队列服务:加入或者更新队列元素,支持当用户掉线或退出聊天室后,是否删除这个元素
roomId | 聊天室id |
key | 新元素(或待更新元素)的唯一键 |
value | 新元素(待待更新元素)的内容 |
isTransient | true表示当提交这个新元素的用户从聊天室掉线或退出的时候,需要删除这个元素;默认false表示不删除 |
elementAccid | 队列元素所属账号,默认不传表示队列元素属于当前操作人,管理员可以指定队列元素归属于其他合法账号 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.updateQueueEx | ( | String | roomId, |
String | key, | ||
String | value, | ||
boolean | isTransient | ||
) |
聊天室队列服务:加入或者更新队列元素,支持当用户掉线或退出聊天室后,是否删除这个元素
roomId | 聊天室id |
key | 新元素(或待更新元素)的唯一键 |
value | 新元素(待待更新元素)的内容 |
isTransient | true表示当提交这个新元素的用户从聊天室掉线或退出的时候,需要删除这个元素;默认false表示不删除 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.updateRoomInfo | ( | String | roomId, |
ChatRoomUpdateInfo | chatRoomUpdateInfo, | ||
boolean | needNotify, | ||
Map< String, Object > | notifyExtension | ||
) |
更新聊天室信息
roomId | 聊天室id |
chatRoomUpdateInfo | 可更新的聊天室信息 |
needNotify | 是否通知 |
notifyExtension | 更新聊天室信息扩展字段,这个字段会放到更新聊天室信息通知的扩展字段中 |
InvocationFuture<Void> com.netease.nimlib.sdk.chatroom.ChatRoomService.updateRoomInfo | ( | String | roomId, |
ChatRoomUpdateInfo | chatRoomUpdateInfo, | ||
boolean | needNotify, | ||
Map< String, Object > | notifyExtension, | ||
AntiSpamConfig | antiSpamConfig | ||
) |
更新聊天室信息
roomId | 聊天室id |
chatRoomUpdateInfo | 可更新的聊天室信息 |
needNotify | 是否通知 |
notifyExtension | 更新聊天室信息扩展字段,这个字段会放到更新聊天室信息通知的扩展字段中 |
antiSpamConfig | 反垃圾配置参数 |