com.netease.nimlib.sdk.chatroom

Interface ChatRoomService

public interface ChatRoomService

Chat room service interface

Method Summary

Modifier and Type	Method and Description
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) Update multiple elements in a chat room queue.
AbortableFuture<java.lang.Void>	downloadAttachment(ChatRoomMessage msg, boolean thumb) In most cases, attachments will be automatically downloaded when messages are received.
InvocationFuture<java.lang.Void>	dropQueue(java.lang.String roomId) Delete a queue
AbortableFuture<EnterChatRoomResultData>	enterChatRoom(EnterChatRoomData roomData) Join a chat room
AbortableFuture<EnterChatRoomResultData>	enterChatRoomEx(EnterChatRoomData roomData, int retryCount) Join a chat room
void	exitChatRoom(java.lang.String roomId) Leave a chat room
void	exitChatRooms(ChatRoomModeEnum mode) Leave a chat room
InvocationFuture<java.util.List<Entry<java.lang.String,java.lang.String>>>	fetchQueue(java.lang.String roomId) Sort all elements in a queue
InvocationFuture<ChatRoomInfo>	fetchRoomInfo(java.lang.String roomId) Get the messages in the current chat room
InvocationFuture<java.util.List<ChatRoomMember>>	fetchRoomMembers(java.lang.String roomId, MemberQueryType memberQueryType, long time, int limit) Get the members in a chat room
InvocationFuture<java.util.List<ChatRoomMember>>	fetchRoomMembersByIds(java.lang.String roomId, java.util.List<java.lang.String> accounts) Get member profiles based on user IDs
InvocationFuture<java.util.List<ChatRoomMember>>	fetchRoomMembersByTag(java.lang.String roomId, java.lang.String tag, long time, int limit) Get the members in a chat room
int	getEnterErrorCode(java.lang.String roomId) Get an error code for failures to join a chat room An error code is returned in the callback for enterChatRoom if a user manually logs in.
InvocationFuture<java.lang.Void>	kickMember(java.lang.String roomId, java.lang.String account, java.util.Map<java.lang.String,java.lang.Object> notifyExtension) Remove a specified member
InvocationFuture<ChatRoomMember>	markChatRoomBlackList(boolean isAdd, MemberOption memberOption) Add to or remove from the blacklist of a chat room
InvocationFuture<ChatRoomMember>	markChatRoomManager(boolean isAdd, MemberOption memberOption) Assign or revoke the adminstrator role
InvocationFuture<ChatRoomMember>	markChatRoomMutedList(boolean isAdd, MemberOption memberOption) Add to or removed from the muted list of a chat room
InvocationFuture<java.lang.Void>	markChatRoomTempMute(boolean needNotify, long duration, MemberOption memberOption) Temporarily mute a member in a chat room
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) Mute members with a specified tag.
InvocationFuture<ChatRoomMember>	markNormalMember(boolean isAdd, MemberOption memberOption) Assign or revoke membership of a user
InvocationFuture<Entry<java.lang.String,java.lang.String>>	pollQueue(java.lang.String roomId, java.lang.String key) Get the head of a queue or specified elements
InvocationFuture<java.util.List<NimRobotInfo>>	pullAllRobots(java.lang.String roomId) Get all the current chat bots
InvocationFuture<java.util.List<ChatRoomMessage>>	pullMessageHistory(java.lang.String roomId, long startTime, int limit) Get history messages.
InvocationFuture<java.util.List<ChatRoomMessage>>	pullMessageHistoryEx(java.lang.String roomId, long startTime, int limit, QueryDirectionEnum direction) Get history messages.
InvocationFuture<java.util.List<ChatRoomMessage>>	pullMessageHistoryExType(java.lang.String roomId, long startTime, int limit, QueryDirectionEnum direction, MsgTypeEnum[] typeEnums) Get history messages.
InvocationFuture<java.lang.Long>	queryTagMembersCount(java.lang.String roomId, java.lang.String tag) Get member profiles based on user IDs
InvocationFuture<java.lang.Void>	sendMessage(ChatRoomMessage msg, boolean resend) Send a message in a chat room
InvocationFuture<java.lang.Void>	updateChatRoomTags(java.lang.String roomId, ChatRoomTagsInfo tagsInfo) Update tags of a chat room
InvocationFuture<java.lang.Void>	updateLocation(java.lang.String roomId, ChatRoomSpatialLocation location) Update the location info Note: the location can be reported to the server every 300ms.
InvocationFuture<java.lang.Void>	updateMyRoomRole(java.lang.String roomId, ChatRoomMemberUpdate chatRoomMemberUpdate, boolean needNotify, java.util.Map<java.lang.String,java.lang.Object> notifyExtension) Update the profile of the current user in a chat room
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) Update the profile of the current user in a chat room
InvocationFuture<java.lang.Void>	updateQueue(java.lang.String roomId, java.lang.String key, java.lang.String value) Chat room queue service.
InvocationFuture<java.lang.Void>	updateQueue(java.lang.String roomId, java.lang.String key, java.lang.String value, boolean isTransient, java.lang.String elementAccid) Chat room queue service.
InvocationFuture<java.lang.Void>	updateQueueEx(java.lang.String roomId, java.lang.String key, java.lang.String value, boolean isTransient) Chat room queue service.
InvocationFuture<java.lang.Void>	updateRoomInfo(java.lang.String roomId, ChatRoomUpdateInfo chatRoomUpdateInfo, boolean needNotify, java.util.Map<java.lang.String,java.lang.Object> notifyExtension) Update the chat room profile
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) Update the chat room profile

Method Detail

enterChatRoom

AbortableFuture<EnterChatRoomResultData> enterChatRoom(EnterChatRoomData roomData)

Join a chat room

Parameters:

roomData - chat room info. The chat room ID is required.

Returns:

InvocationFuture abortable callback The chat room info is returned

enterChatRoomEx

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

Join a chat room

Parameters:

roomData - chat room info. The chat room ID is required.

retryCount - retry count for failures

Returns:

InvocationFuture abortable callback The chat room info is returned

getEnterErrorCode

int getEnterErrorCode(java.lang.String roomId)

Get an error code for failures to join a chat room An error code is returned in the callback for enterChatRoom if a user manually logs in. The method can return specific error codes when a client fails to reconnect to the server and the online state changes to UNLOGIN.

Parameters:

roomId - chat room ID

Returns:

error codes for connection failures and login failures

exitChatRoom

void exitChatRoom(java.lang.String roomId)

Leave a chat room

Parameters:

roomId - chat room ID

exitChatRooms

void exitChatRooms(ChatRoomModeEnum mode)

Leave a chat room

Parameters:

mode - chat room mode

sendMessage

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

Send a message in a chat room

Parameters:

msg - message body constructed using ChatRoomMessageBuilder.

resend - set to true for reconnections after failure. Otherwise, set to false.

Returns:

InvocationFuture callback The method can be called after the message is sent. For information about error code, see specific error codes.

downloadAttachment

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

In most cases, attachments will be automatically downloaded when messages are received. If download fails, call this interface to download again.

Parameters:

msg - The message enclosed with an attachment

thumb - Specify whether to download the thumbnail or the original file. If the value is set to true, only the thumbnail will be downloaded.
The parameter is applied to image and video messages.

Returns:

AbortableFuture tracing calls Callbacks can be set. The interface can abort the download operation.

pullMessageHistory

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

Get history messages. The history messages before a specified anchor are returned and displayed in descending order.

Parameters:

roomId - chat room ID

startTime - start time in milliseconds

limit - limit of returned messages

Returns:

InvocationFuture callback A list of history messages are returned.

pullMessageHistoryEx

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

Get history messages. The query direction can be specified. If a query starts from an early point to the newest date, the result is displayed in descending order. Otherwise, in ascending order

Parameters:

roomId - chat room ID

startTime - start time in milliseconds

limit - limit of returned messages

direction - Query direction

Returns:

InvocationFuture callback A list of history messages are returned.

pullMessageHistoryExType

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

Get history messages. The query direction and message types can be specified.

If a query starts from an early point to the newest date, the result is displayed in descending order. Otherwise, in ascending order.

Message types, 0: text; 1: image; 2: audio; 3: video; 4: location; 5: notification; 6: file; 10: Tip; 11: custom; 100: custom. Other types are invalid.

Parameters:

roomId - chat room ID

startTime - start time in milliseconds

limit - limit of returned messages

direction - Query direction

typeEnums - message types in array

Returns:

InvocationFuture callback A list of history messages are returned.

fetchRoomInfo

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

Get the messages in the current chat room

Parameters:

roomId - The ID of a chat room

Returns:

InvocationFuture callback The callback returns messages in a chat room

fetchRoomMembers

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

Get the members in a chat room

Parameters:

roomId - chat room ID

memberQueryType - member types. For more information, see MemberQueryType

time - use updateTime for permanent members, use enterTime for temporary users. A value of 0 starts the query from the current time or the first page in milliseconds.

limit - limit of returned entries

Returns:

InvocationFuture callback The callback returns members

fetchRoomMembersByTag

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

Get the members in a chat room

Parameters:

roomId - chat room ID

tag - tag

time - the start ime in descending order. A value of 0 starts the query from the current time to the earliest.

limit - limit of returned entries

Returns:

InvocationFuture callback The callback returns members

fetchRoomMembersByIds

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

Get member profiles based on user IDs

Parameters:

roomId - chat room ID

accounts - The list of accounts in a chat room

Returns:

InvocationFuture callback The callback returns members

queryTagMembersCount

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

Get member profiles based on user IDs

Parameters:

roomId - chat room ID

tag - tag

Returns:

InvocationFuture callback The callback returns members

markChatRoomBlackList

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

Add to or remove from the blacklist of a chat room

Parameters:

isAdd - true: added, false: removed

memberOption - Request parameters, such as chat room ID, account ID, and optional extension fields

Returns:

InvocationFuture callback The callback returns member profiles.

markChatRoomMutedList

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

Add to or removed from the muted list of a chat room

Parameters:

isAdd - true: added; false: removed

memberOption - Request parameters, such as chat room ID, account ID, and optional extension fields

Returns:

InvocationFuture callback The callback returns member profiles.

markChatRoomTempMute

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

Temporarily mute a member in a chat room

Parameters:

needNotify - broadcast the notification. True: sends a notification to all members; false：does not send a notification to all members

duration - Mute duration in seconds

memberOption - Request parameters, such as chat room ID, account ID, and optional extension fields

Returns:

InvocationFuture callback If an error occurs, a specific error code will be returned.

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)

Mute members with a specified tag. Administrators or the owner can perform the operation

Parameters:

roomId - chat room ID

targetTag - the tag for muting

needNotify - broadcast the notification. True: sends a notification to all members; false：does not send a notification to all members

duration - Mute duration in seconds

notifyExtension - Custom extension field defined by developers. Optional.

notifyTargetTags - Tags for broadcast messages. The default value is TARGET_TAG. It is a tag expression.

Returns:

InvocationFuture callback If an error occurs, a specific error code will be returned.

markChatRoomManager

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

Assign or revoke the adminstrator role

Parameters:

isAdd - true: assign an administrator; false: revoke the administrator role of a member.

memberOption - Request parameters, such as chat room ID, account ID, and optional extension fields

Returns:

InvocationFuture callback The callback returns member profiles.

markNormalMember

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

Assign or revoke membership of a user

Parameters:

isAdd - true: assign an administrator; false: revoke the administrator role of a member.

memberOption - Request parameters, such as chat room ID, account ID, and optional extension fields

Returns:

InvocationFuture callback The callback returns member profiles.

kickMember

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

Remove a specified member

Parameters:

roomId - chat room ID

account - account to be removed Only administrators can remove members. Only the owner can remove administrators.

notifyExtension - notification extension field for being removed in a notification

Returns:

InvocationFuture callback The callback is triggered only when a member is removed from a chat room. If an error occurs, a specific error code will be returned.

updateRoomInfo

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

Update the chat room profile

Parameters:

roomId - chat room ID

chatRoomUpdateInfo - chat room profile to be updated

needNotify - enable or disable notifications

notifyExtension - extension field for updating the chat room profile in a notification

Returns:

InvocationFuture callback The callback is triggered only when a chat room profile is updated. If an error occurs, a specific error code will be returned.

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)

Update the chat room profile

Parameters:

roomId - chat room ID

chatRoomUpdateInfo - chat room profile to be updated

needNotify - enable or disable notifications

notifyExtension - extension field for updating the chat room profile in a notification

antiSpamConfig - Anti-spam configuration

Returns:

InvocationFuture callback The callback is triggered only when a chat room profile is updated. If an error occurs, a specific error code will be returned.

updateMyRoomRole

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

Update the profile of the current user in a chat room

Parameters:

roomId - chat room ID

chatRoomMemberUpdate - profile to be updated

needNotify - enable or disable notifications

notifyExtension - extension field for updating the chat room profile in a notification. A maximum of 2000 characters are allowed.

Returns:

InvocationFuture callback The callback is triggered only when a profile is updated. If an error occurs, a specific error code will be returned.

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)

Update the profile of the current user in a chat room

Parameters:

roomId - chat room ID

chatRoomMemberUpdate - profile to be updated

needNotify - enable or disable notifications

notifyExtension - extension field for updating the chat room profile in a notification. A maximum of 2000 characters are allowed.

antiSpamConfig - Anti-spam configuration

Returns:

InvocationFuture callback The callback is triggered only when a profile is updated. If an error occurs, a specific error code will be returned.

updateQueue

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

Chat room queue service. Add elements to a queue or update a queue

Parameters:

roomId - The ID of a chat room

key - unique key for new elements or elements to be updated.

value - value of a new element or an element to be updated

Returns:

InvocationFuture callback Return success or error codes for failures

updateQueueEx

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

Chat room queue service. Add elements to a queue or update a queue. An element can be deleted when a user gets disconnected or leaves a chat room.

Parameters:

roomId - chat room ID

key - unique key for new elements or elements to be updated.

value - value of a new element or an element to be updated

isTransient - true: delete an element when a user gets disconnected or leaves a chat room. The default false value indicates that an element is not deleted.

Returns:

InvocationFuture callback Return success or error codes for failures

updateQueue

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

Chat room queue service. Add elements to a queue or update a queue. An element can be deleted when a user gets disconnected or leaves a chat room.

Parameters:

roomId - chat room ID

key - unique key for new elements or elements to be updated.

value - value of a new element or an element to be updated

isTransient - true: delete an element when a user gets disconnected or leaves a chat room. The default false value indicates that an element is not deleted.

elementAccid - accounts to which an element belongs. No argument is taken by default. The element belongs to the current user. Administrators can assign specified elements to other valid accounts.

Returns:

InvocationFuture callback Return success or error codes for failures

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)

Update multiple elements in a chat room queue.

Parameters:

roomId - chat room ID

queues - elements to be updated

needNotify - Enable or disable broadcast

notifyExt - extension field in a notification. A maximum of 2000 characters are allowed

Returns:

list of elementKey

pollQueue

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

Get the head of a queue or specified elements

Parameters:

roomId - The ID of a chat room

key - unique key of an element If a value of null is taken, the head elements are selected.

Returns:

InvocationFuture callback If the element exists or a queue is not emptu, the callback returns key-value pairs. Otherwise an error code is returned.

fetchQueue

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

Sort all elements in a queue

Parameters:

roomId - The ID of a chat room

Returns:

InvocationFuture callback The callback returns all key-value pairs in a queue

dropQueue

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

Delete a queue

Parameters:

roomId - The ID of a chat room

Returns:

InvocationFuture callback Return success or error codes for failures

pullAllRobots

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

Get all the current chat bots

Parameters:

roomId - chat room ID

Returns:

InvocationFuture callback Return success or error codes for failures

updateChatRoomTags

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

Update tags of a chat room

Parameters:

roomId - chat room ID

tagsInfo - tag info

Returns:

updateLocation

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

Update the location info Note: the location can be reported to the server every 300ms. If mutiple calls are performed during 300ms, a 416 code is returned.

Parameters:

roomId - chat room ID

location - location info

Returns: