MsgService

```
public interface MsgService
```
CommsEase message service interface

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`MSG_CHATTING_ACCOUNT_ALL` No chat but alerts messages can be seen on the message UI.
`static java.lang.String`	`MSG_CHATTING_ACCOUNT_NONE` No chat.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`InvocationFuture<CollectInfo>`	`addCollect(int type, java.lang.String date, java.lang.String ext, java.lang.String uniqueId)` Add a bookmark
`InvocationFuture<java.lang.Long>`	`addMsgPin(IMMessage msg, java.lang.String ext)` Add a PIN tag to a message
`InvocationFuture<java.lang.Void>`	`addQuickComment(IMMessage msg, long replyType, java.lang.String ext)` Add a quick comment.
`InvocationFuture<java.lang.Long>`	`addQuickComment(IMMessage msg, long replyType, java.lang.String ext, boolean needPush, boolean needBadge, java.lang.String pushTitle, java.lang.String pushContent, java.util.Map<java.lang.String,java.lang.Object> pushPayload)` Add a quick comment.
`InvocationFuture<StickTopSessionInfo>`	`addStickTopSession(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String ext)` Add a pinned session
`InvocationFuture<java.lang.Void>`	`cancelUploadAttachment(IMMessage imMessage)` Cancel uploading message attachment, such as image, video, and file.
`LocalAntiSpamResult`	`checkLocalAntiSpam(java.lang.String content, java.lang.String replacement)` Check local spam trigger words
`void`	`clearAllUnreadCount()` Clear all unread count of all contacts (tag read) The interface call also triggers `MsgServiceObserve.observeRecentContact(Observer, boolean)` notifications
`void`	`clearChattingHistory(java.lang.String account, SessionTypeEnum sessionType)` Clear all messages of a specified user and the clear operation is not recorded in the database.
`void`	`clearChattingHistory(java.lang.String account, SessionTypeEnum sessionType, boolean ignore)` Clear all local messages of a specified user.
`InvocationFuture<java.lang.Void>`	`clearMsgDatabase(boolean clearRecent)` Clear all messages in the database.
`void`	`clearServerHistory(java.lang.String sessionId, boolean deleteRoam)` Clear history P2P messages
`void`	`clearServerHistory(java.lang.String sessionId, SessionTypeEnum sessionType)` Clear history P2P messages.
`void`	`clearServerHistory(java.lang.String sessionId, SessionTypeEnum sessionType, boolean deleteRoam)` Deprecated. Roaming messages for P2P chats can be retained on the server. To retain roaming messages, use `clearServerHistory(String, boolean)` To delete roaming messages, use `clearServerHistory(String, SessionTypeEnum)`
`void`	`clearServerHistory(java.lang.String sessionId, SessionTypeEnum sessionType, boolean sync, java.lang.String ext)` Clear history messages.
`InvocationFuture<java.util.List<SessionAckInfo>>`	`clearUnreadCount(java.util.List<<any>> sessionKeyList)` Set the unread count of specified recent contact to 0 (tag read).
`InvocationFuture<java.lang.Void>`	`clearUnreadCount(java.lang.String account, SessionTypeEnum sessionType)` Set the unread count of specified recent contact to 0 (tag read).
`RecentContact`	`createEmptyRecentContact(java.lang.String contactId, SessionTypeEnum sessionType, long tag, long time, boolean saveToDB)` Create an empty session with a specified contact
`RecentContact`	`createEmptyRecentContact(java.lang.String contactId, SessionTypeEnum sessionType, long tag, long time, boolean saveToDB, boolean withLastMsg)` Create an empty session with a specified contact
`void`	`deleteChattingHistory(IMMessage message)` Delete a message and record the delete operation in the database.
`void`	`deleteChattingHistory(IMMessage message, boolean ignore)` Delete a message
`void`	`deleteChattingHistory(java.util.List<IMMessage> msgList, boolean ignore)` Delete multiple messages
`InvocationFuture<java.lang.Long>`	`deleteMsgSelf(IMMessage msg, java.lang.String ext)` Delete a message sent from the current user
`InvocationFuture<java.lang.Long>`	`deleteMsgSelf(java.util.List<IMMessage> msgList, java.lang.String ext)` Delete multiple messages sent from the current user.
`InvocationFuture<java.lang.Void>`	`deleteMySession(java.lang.String[] sessionIdArr)` Delete a session
`void`	`deleteRangeHistory(java.lang.String account, SessionTypeEnum sessionType, long startTime, long endTime)` Delete local history messages with in a time range between startTime and entTime.
`void`	`deleteRecentContact(RecentContact recent)` Delete a recent contact session from a local storage and roaming data.
`InvocationFuture<java.lang.Void>`	`deleteRecentContact(java.lang.String account, SessionTypeEnum sessionType, DeleteTypeEnum deleteType, boolean sendAck)` Delete a recent contact record The method call will trigger `MsgServiceObserve.observeRecentContactDeleted(Observer, boolean)` to send a notification.
`void`	`deleteRecentContact2(java.lang.String account, SessionTypeEnum sessionType)` Delete a recent contact record from the local storage and roaming data.
`InvocationFuture<java.lang.Void>`	`deleteRoamingRecentContact(java.lang.String contactId, SessionTypeEnum sessionTypeEnum)` Delete the roaming messages of a specified recent contact.
`void`	`deleteRoamMsgHasMoreTag(java.lang.String sessionId, SessionTypeEnum sessionType)` Delete the tag for more roaming messages
`AbortableFuture<java.lang.Void>`	`downloadAttachment(IMMessage msg, boolean thumb)` In most cases, attachments will be automatically downloaded when messages are received.
`boolean`	`everBeenDeleted(IMMessage message)` Check if the message is deleted from the local storage.
`AbortableFuture<java.lang.Void>`	`exportAllMessage(IMsgExportProcessor exportProcessor, boolean safeMode)` Export all messages stored in the local database and upload the messages to the server.
`int`	`getTotalUnreadCount()` Get the total unread count
`int`	`getTotalUnreadCount(boolean notify)` Get the total unread count
`AbortableFuture<java.lang.Void>`	`importAllMessage(IMsgImportProcessor iMsgImportProcessor, boolean safeMode)` Import exported messages.
`InvocationFuture<java.lang.Void>`	`importRecentSessions(java.util.List<<any>> sessions)` Import multiple recent sessions with contactId and sessionType fields
`InvocationFuture<java.lang.Void>`	`insertLocalMessage(IMMessage msg, java.lang.String fromAccount)` Insert a message into the local database and update the UI interface but the message is not sent to the server.
`boolean`	`isStickTopSession(java.lang.String sessionId, SessionTypeEnum sessionType)` Check if the session is pinned.
`void`	`migrateMessages(java.lang.String from, java.lang.String to, boolean changeFrom)` Migrate message data Migrate history message data of accounts in the from field to the message data of accounts in the to field.
`InvocationFuture<java.util.List<IMMessage>>`	`pullHistoryById(java.util.List<MessageKey> msgKeyList, boolean persist)` Query history messages by message ID.
`InvocationFuture<java.util.List<IMMessage>>`	`pullMessageHistory(IMMessage anchor, int limit, boolean persist)` Get history messages from the server.
`InvocationFuture<java.util.List<IMMessage>>`	`pullMessageHistory(IMMessage anchor, int limit, boolean persist, boolean persistClear)` Get history messages from the server.
`InvocationFuture<java.util.List<IMMessage>>`	`pullMessageHistory(MsgFullKeywordSearchConfig config)` Global search for history messages on the cloud
`InvocationFuture<java.util.List<IMMessage>>`	`pullMessageHistoryEx(IMMessage anchor, long toTime, int limit, QueryDirectionEnum direction, boolean persist)` Get history messages from the server.
`InvocationFuture<java.util.List<IMMessage>>`	`pullMessageHistoryExType(IMMessage anchor, long toTime, int limit, QueryDirectionEnum direction, MsgTypeEnum[] msgTypes)` Get history messages from the server with a specified type.
`InvocationFuture<java.util.List<IMMessage>>`	`pullMessageHistoryExType(IMMessage anchor, long toTime, int limit, QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist)` Get history messages from the server with a specified type.
`InvocationFuture<java.util.List<IMMessage>>`	`pullMessageHistoryExType(IMMessage anchor, long toTime, int limit, QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist, boolean persistClear)` Get history messages from the server with a specified type.
`InvocationFuture<java.util.List<IMMessage>>`	`pullMessageHistoryExType(IMMessage anchor, long toTime, int limit, QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist, boolean persistClear, IMMessageFilter customFilter)` Get history messages from the server with a specified type.
`InvocationFuture<java.util.List<IMMessage>>`	`pullMessageHistoryExType(IMMessage anchor, long toTime, int limit, QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist, boolean persistClear, IMMessageFilter customFilter, boolean updateUnread)` Get history messages from the server with a specified type.
`InvocationFuture<java.util.List<IMMessage>>`	`pullMessageHistoryOrderByTime(MsgTimingFullKeywordSearchConfig config)` Global search for history messages on the cloud by time not session group
`InvocationFuture<CollectInfoPage>`	`queryCollect(CollectInfo anchor, long toTime, int limit, QueryDirectionEnum direction)` Query bookmarks on the server page
`InvocationFuture<CollectInfoPage>`	`queryCollect(CollectInfo anchor, long toTime, int limit, QueryDirectionEnum direction, int type, boolean persist)` Query bookmarks on the service page
`InvocationFuture<CollectInfoPage>`	`queryCollect(int limit)` Query bookmarks
`IMMessage`	`queryLastMessage(java.lang.String account, SessionTypeEnum sessionType)` Query the most recent message of a specifed user
`InvocationFuture<java.util.List<IMMessage>>`	`queryMessageList(java.lang.String account, SessionTypeEnum sessionType, long offset, int limit)` Deprecated. replaced with `queryMessageListEx(IMMessage, QueryDirectionEnum, int, boolean)`
`java.util.List<IMMessage>`	`queryMessageListByServerIdBlock(java.util.List<java.lang.String> serverIds)` Get multiple messages using the Server ID (sync) Note: a server ID can be associated with multiple messages
`InvocationFuture<java.util.List<IMMessage>>`	`queryMessageListBySubtype(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit, int subtype)` Query local messages by subtype (async)
`java.util.List<IMMessage>`	`queryMessageListBySubtypeBlock(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit, int subtype)` Query local messages by subtype (sync)
`InvocationFuture<java.util.List<IMMessage>>`	`queryMessageListByType(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit)` query history messages on the local database by type.
`InvocationFuture<java.util.List<IMMessage>>`	`queryMessageListByType(MsgTypeEnum msgTypeEnum, java.lang.Long maxTime, int limit)` Query all messages by message type
`InvocationFuture<java.util.List<IMMessage>>`	`queryMessageListByTypes(java.util.List<MsgTypeEnum> types, IMMessage anchor, long toTime, QueryDirectionEnum direction, int limit, boolean asc)` Query history messages based on the start time, end time, and direction.
`InvocationFuture<java.util.List<IMMessage>>`	`queryMessageListByUuid(java.util.List<java.lang.String> uuids)` Get multiple messages with UUIDs
`java.util.List<IMMessage>`	`queryMessageListByUuidBlock(java.util.List<java.lang.String> uuids)` Get multiple messages (sync)
`InvocationFuture<java.util.List<IMMessage>>`	`queryMessageListEx(IMMessage anchor, QueryDirectionEnum direction, int limit, boolean asc)` Query history messages on the local database by anchor and direction Query messages earlier than or later than the anchor by direction with a limit.
`java.util.List<IMMessage>`	`queryMessageListExBlock(IMMessage anchor, QueryDirectionEnum direction, int limit, boolean asc)` Query history messages on the local database by anchor and direction (sync) Query messages earlier than or later than the anchor by direction with a limit.
`InvocationFuture<java.util.List<IMMessage>>`	`queryMessageListExTime(IMMessage anchor, long toTime, QueryDirectionEnum direction, int limit)` query history messages on the local database based on the start time, end time, and direction.
`java.util.List<MsgPinDbOption>`	`queryMsgPinBlock(java.lang.String sessionId, SessionTypeEnum sessionType)` Get a list of PIN messages
`InvocationFuture<RecentSession>`	`queryMySession(java.lang.String sessionId)` Get a session
`InvocationFuture<RecentSessionList>`	`queryMySessionList(long minTimestamp, java.lang.Long maxTimestamp, java.lang.Integer needLastMsg, java.lang.Integer limit, java.lang.Integer hasMore)` Deprecated.
`InvocationFuture<RecentSessionList>`	`queryMySessionList(QueryMySessionOption option)` Get a list of session by increment.
`InvocationFuture<java.util.List<QuickCommentOptionWrapper>>`	`queryQuickComment(java.util.List<IMMessage> msgList)` Get a quick comment
`RecentContact`	`queryRecentContact(java.lang.String contactId, SessionTypeEnum sessionType)` Query session records in the database by contactId and sessionType.
`InvocationFuture<java.util.List<RecentContact>>`	`queryRecentContacts()` Query the recent contact list
`InvocationFuture<java.util.List<RecentContact>>`	`queryRecentContacts(int limit)` Query the recent contact list.
`InvocationFuture<java.util.List<RecentContact>>`	`queryRecentContacts(MsgTypeEnum filterMsgType)` Query the recent contact list.
`InvocationFuture<java.util.List<RecentContact>>`	`queryRecentContacts(RecentContact anchor, QueryDirectionEnum direction, int limit)` Query the recent contact list sorted in descending or ascending order with a limit of displayed contacts.
`InvocationFuture<java.util.List<RecentContact>>`	`queryRecentContacts(java.util.Set<MsgTypeEnum> filterMsgTypeSet)` Query the recent contact list.
`java.util.List<RecentContact>`	`queryRecentContactsBlock()` Query the recent contact list (sync)
`java.util.List<RecentContact>`	`queryRecentContactsBlock(int limit)` Query the recent contact list (sync).
`java.util.List<RecentContact>`	`queryRecentContactsBlock(MsgTypeEnum filterMsgType)` Query the recent contact list (sync).
`java.util.List<RecentContact>`	`queryRecentContactsBlock(RecentContact anchor, QueryDirectionEnum direction, int limit)` Query the recent contact list (sync) sorted in descending or ascending order with a limit of displayed contacts.
`java.util.List<RecentContact>`	`queryRecentContactsBlock(java.util.Set<MsgTypeEnum> filterMsgTypeSet)` Query the recent contact list (sync).
`int`	`queryReplyCountInThreadTalkBlock(IMMessage msg)` Get the reply count of a thread chat.
`InvocationFuture<java.lang.Long>`	`queryRoamMsgHasMoreTagServerId(java.lang.String sessionId, SessionTypeEnum sessionType)` Get roaming messages with a specified server ID.
`long`	`queryRoamMsgHasMoreTagServerIdBlock(java.lang.String sessionId, SessionTypeEnum sessionType)` Get roaming messages with a specified server ID.
`InvocationFuture<java.lang.Long>`	`queryRoamMsgHasMoreTime(java.lang.String sessionId, SessionTypeEnum sessionType)` Get the timestamp of roaming messages.
`long`	`queryRoamMsgHasMoreTimeBlock(java.lang.String sessionId, SessionTypeEnum sessionType)` Get the timestamp of roaming messages.
`java.util.List<StickTopSessionInfo>`	`queryStickTopSessionBlock()` Get the pinned sessions
`InvocationFuture<ThreadTalkHistory>`	`queryThreadTalkHistory(IMMessage anchor, long fromTime, long toTime, int limit, QueryDirectionEnum direction, boolean persist)` Query history thread chats on the cloud.
`InvocationFuture<java.util.List<IMMessage>>`	`queryUnreadMessageList(java.lang.String sessionId, SessionTypeEnum sessionType)` query all unread messages by session ID and type
`java.util.List<IMMessage>`	`queryUnreadMessageListBlock(java.lang.String sessionId, SessionTypeEnum sessionType)` query all unread messages by session ID and type (sync)
`void`	`registerCustomAttachmentParser(MsgAttachmentParser customParser)` If third party apps require custom message types with attachments, the attachment parser must also be registered.
`void`	`registerIMMessageFilter(IMMessageFilter filter)` Register the message filter
`void`	`registerShouldShowNotificationWhenRevokeFilter(ShowNotificationWhenRevokeFilter filter)` Register the filter to show notifications when a message is recalled.
`InvocationFuture<java.lang.Integer>`	`removeCollect(java.util.List<<any>> collectInfo)` Remove multiple bookmarks
`InvocationFuture<java.lang.Long>`	`removeMsgPin(IMMessage msg, java.lang.String ext)` Remove the PIN tag of a message
`InvocationFuture<java.lang.Void>`	`removeQuickComment(IMMessage msg, long replyType, java.lang.String ext)` Remove a quick comment
`InvocationFuture<java.lang.Long>`	`removeQuickComment(IMMessage msg, long replyType, java.lang.String ext, boolean needPush, boolean needBadge, java.lang.String pushTitle, java.lang.String pushContent, java.util.Map<java.lang.String,java.lang.Object> pushPayload)` Remove a quick comment
`InvocationFuture<java.lang.Void>`	`removeStickTopSession(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String ext)` Delete a pinned session
`InvocationFuture<java.lang.Void>`	`replyMessage(IMMessage msg, IMMessage replyMsg, boolean resend)` Reply a message.
`InvocationFuture<java.lang.Void>`	`revokeMessage(IMMessage message)` Recall a messages.
`InvocationFuture<java.lang.Void>`	`revokeMessage(IMMessage message, java.lang.String customApnsText, java.util.Map<java.lang.String,java.lang.Object> pushPayload, boolean shouldNotifyBeCount)` Recall a message and set third-party push notifications including the iOS platform and changes of the unread count.
`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)` Recall a message and set third-party push notifications including the iOS platform and changes of the unread count.
`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, java.lang.String attach)` Recall a message and set third-party push notifications including the iOS platform and changes of the unread count.
`InvocationFuture<java.lang.Void>`	`revokeMessageEx(IMMessage message, java.lang.String customApnsText, java.util.Map<java.lang.String,java.lang.Object> pushPayload)` Recall a message and set third party push notifications, including the iOS platform.
`InvocationFuture<java.lang.Void>`	`saveMessageToLocal(IMMessage msg, boolean notify)` Store the message to the local database instead of server side.
`InvocationFuture<java.lang.Void>`	`saveMessageToLocalEx(IMMessage msg, boolean notify, long time)` Store the message to the local database instead of server side.
`InvocationFuture<java.util.List<IMMessage>>`	`searchAllMessage(MsgSearchOption option)` Global search for all history messages on the local database.
`InvocationFuture<java.util.List<IMMessage>>`	`searchAllMessageHistory(java.lang.String keyword, java.util.List<java.lang.String> fromAccounts, long time, int limit)` Query history messages on the local database.
`InvocationFuture<java.util.List<MsgIndexRecord>>`	`searchAllSession(java.lang.String query, int limit)` Query all sessions and return the count of all matched messages from each session and the most recent message that hit the search condition.
`java.util.List<MsgIndexRecord>`	`searchAllSessionBlock(java.lang.String query, int limit)` Query all sessions and return the count of all matched messages from each session and the most recent message that hit the search condition.
`InvocationFuture<java.util.List<IMMessage>>`	`searchMessage(SessionTypeEnum sessionType, java.lang.String sessionId, MsgSearchOption option)` Query history messages on the local database.
`InvocationFuture<java.util.List<IMMessage>>`	`searchMessageHistory(java.lang.String keyword, java.util.List<java.lang.String> fromAccounts, IMMessage anchor, int limit)` Query history messages on the local database.
`InvocationFuture<java.util.List<IMMessage>>`	`searchMessageHistory(java.lang.String keyword, java.util.List<java.lang.String> fromAccounts, IMMessage anchor, QueryDirectionEnum direction, int limit)` Query history messages on the local database.
`InvocationFuture<java.util.ArrayList<IMMessage>>`	`searchRoamingMsg(java.lang.String otherAccid, long fromTime, long endTime, java.lang.String keyword, int limit, boolean reverse)` Search chat records using keywords
`InvocationFuture<java.util.List<MsgIndexRecord>>`	`searchSession(java.lang.String query, SessionTypeEnum sessionType, java.lang.String sessionId)` Query messages in a specified session and return the matched result.
`java.util.List<MsgIndexRecord>`	`searchSessionBlock(java.lang.String query, SessionTypeEnum sessionType, java.lang.String sessionId)` Query messages in a specified session and return the matched result.
`InvocationFuture<java.lang.Void>`	`sendCustomNotification(CustomNotification notification)` Send an instruction message.
`AbortableFuture<FileAttachment>`	`sendFile(FileAttachment attachment)` Upload a file
`InvocationFuture<java.lang.Void>`	`sendMessage(IMMessage msg, boolean resend)` Sending a message.
`InvocationFuture<java.lang.Void>`	`sendMessageReceipt(java.lang.String sessionId, IMMessage message)` Send read receipt of P2P messages.
`void`	`setChattingAccount(java.lang.String account, SessionTypeEnum sessionType)` Set the current chat peer The built-in message alert will be affected.
`InvocationFuture<MsgPinSyncResponseOptionWrapper>`	`syncMsgPin(SessionTypeEnum sessionType, java.lang.String sessionId, long timestamp)` Sync PIN messages in a session
`AbortableFuture<java.lang.String>`	`transVoiceToText(java.lang.String voiceUrl, java.lang.String path, long duration)` Convert voice to text
`AbortableFuture<java.lang.String>`	`transVoiceToTextAtScene(java.lang.String voiceUrl, java.lang.String path, long duration, java.lang.String sceneKey)` Convert voice to text and specify a file for upload
`AbortableFuture<java.lang.String>`	`transVoiceToTextEnableForce(java.lang.String voiceUrl, java.lang.String path, long duration, java.lang.String sceneKey, boolean enableForceUploadFile)` Convert voice to text and specify a file for upload.
`InvocationFuture<CollectInfo>`	`updateCollect(CollectInfo info, java.lang.String ext)` Update the extension field of the bookmark
`InvocationFuture<CollectInfo>`	`updateCollect(long infoId, long createTime, java.lang.String ext)` Update the extension field of the bookmark
`void`	`updateIMMessage(IMMessage message)` Update messages.
`void`	`updateIMMessageStatus(IMMessage message)` Update message status.
`InvocationFuture<java.lang.Long>`	`updateMsgPin(IMMessage msg, java.lang.String ext)` Update a PIN message
`InvocationFuture<java.lang.Void>`	`updateMySession(java.lang.String sessionId, java.lang.String ext)` Update the extension field of a session.
`void`	`updateRecent(RecentContact recent)` Update the property of a recent contact To receive notifications from `MsgServiceObserve.observeRecentContact(Observer, boolean)`, use `updateRecentAndNotify(RecentContact)` Properties that can be set: tag and extension
`void`	`updateRecentAndNotify(RecentContact recent)` Update the property of a recent contact and trigger a notification sent by `MsgServiceObserve.observeRecentContact(Observer, boolean)`.
`void`	`updateRecentByMessage(IMMessage message, boolean needNotify)` Update a recent contact by sending a message.
`void`	`updateRoamMsgHasMoreTag(IMMessage newTag)` Update the tag of more roaming messages
`InvocationFuture<StickTopSessionInfo>`	`updateStickTopSession(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String ext)` Update the extension field of a pinned session

- Field Detail
  - MSG_CHATTING_ACCOUNT_ALL
```
static final java.lang.String MSG_CHATTING_ACCOUNT_ALL
```
    No chat but alerts messages can be seen on the message UI. Notification in the status bar is not needed
    
    See Also:
    
    setChattingAccount(String, SessionTypeEnum), Constant Field Values
  - MSG_CHATTING_ACCOUNT_NONE
```
static final java.lang.String MSG_CHATTING_ACCOUNT_NONE
```
    No chat. Notification in the status bar is needed.
    
    See Also:
    
    setChattingAccount(String, SessionTypeEnum)
- Method Detail
  - sendMessage
```
InvocationFuture<java.lang.Void> sendMessage(IMMessage msg,
                                             boolean resend)
```
    Sending a message.
    To update the progress of the message delivery, call MsgServiceObserve.observeMsgStatus(Observer, boolean)
    
    Parameters:
    
    msg - Message body constructed by MessageBuilder
    
    resend - To resend the message if failed, set the value to true. Otherwise, set the value to false.
    
    Returns:
    
    InvocationFuture that can set a callback function. The method can be called after the message is sent. For information about error code, see specific error codes.
  - replyMessage
```
InvocationFuture<java.lang.Void> replyMessage(IMMessage msg,
                                              IMMessage replyMsg,
                                              boolean resend)
```
    Reply a message.
    To update the progress of the message delivery, call MsgServiceObserve.observeMsgStatus(Observer, boolean)
    
    Parameters:
    
    msg - Message body constructed by MessageBuilder
    
    replyMsg - The message to be replied.
    
    resend - To resend the message if failed, set the value to true. Otherwise, set the value to false.
    
    Returns:
    
    InvocationFuture can set a callback function. The method can be called after the message is sent. For information about error code, see specific error codes.
  - sendFile
```
AbortableFuture<FileAttachment> sendFile(FileAttachment attachment)
```
    Upload a file
    
    Returns:
    
    The method that can be set as callback The method can be called after the message is sent. For information about error code, see specific error codes.
  - insertLocalMessage
```
InvocationFuture<java.lang.Void> insertLocalMessage(IMMessage msg,
                                                    java.lang.String fromAccount)
```
    Insert a message into the local database and update the UI interface but the message is not sent to the server. Send a local message that can be set others as sender to the current user.
    The interface saves the message to the database and notifies the UI view. In this case, MsgServiceObserve.observeReceiveMessage(Observer, boolean) is triggered.
    
    Parameters:
    
    msg - Message to be saved
    
    fromAccount - The sender ID
    
    Returns:
    
    InvocationFuture that can set a callback function. The callback is triggered when the message is saved to the database.
  - saveMessageToLocal
```
InvocationFuture<java.lang.Void> saveMessageToLocal(IMMessage msg,
                                                    boolean notify)
```
    Store the message to the local database instead of server side. Used to store local alert for third-party apps.
    Store the message to the database. If the message needs to be notified on a UI view, set notify to true and MsgServiceObserve.observeReceiveMessage(Observer, boolean) will be triggered.
    
    Parameters:
    
    msg - Message to be saved
    
    notify - Specify whether to update the UI view for the message
    
    Returns:
    
    InvocationFuture can set a callback function. The callback is triggered when the message is saved to the database.
  - saveMessageToLocalEx
```
InvocationFuture<java.lang.Void> saveMessageToLocalEx(IMMessage msg,
                                                      boolean notify,
                                                      long time)
```
    Store the message to the local database instead of server side. You can set the time when the message is saved Used to store local alerts for third-party apps. Store the message to the database. If the message needs to be notified on a UI view, set notify to true and MsgServiceObserve.observeReceiveMessage(Observer, boolean) will be triggered.
    
    Parameters:
    
    msg - Message to be saved
    
    notify - Specify whether to update the UI view for the message
    
    time - Set the time when a message is saved using IMMessage.getTime()
    
    Returns:
    
    InvocationFuture can set a callback function. The callback is triggered when the message is saved to the database.
  - downloadAttachment
```
AbortableFuture<java.lang.Void> downloadAttachment(IMMessage msg,
                                                   boolean thumb)
```
    In most cases, attachments will be automatically downloaded when messages are received. If download fails, the interface can be called to download the attachment 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.
  - queryMessageListByUuidBlock
```
java.util.List<IMMessage> queryMessageListByUuidBlock(java.util.List<java.lang.String> uuids)
```
    Get multiple messages (sync)
    
    Parameters:
    
    uuids - UUID list of messages
    
    Returns:
  - queryMessageListByUuid
```
InvocationFuture<java.util.List<IMMessage>> queryMessageListByUuid(java.util.List<java.lang.String> uuids)
```
    Get multiple messages with UUIDs
    
    Parameters:
    
    uuids - UUID list of messages
    
    Returns:
  - queryMessageListByServerIdBlock
```
java.util.List<IMMessage> queryMessageListByServerIdBlock(java.util.List<java.lang.String> serverIds)
```
    Get multiple messages using the Server ID (sync) Note: a server ID can be associated with multiple messages
    
    Parameters:
    
    serverIds - List of server IDs
    
    Returns:
    
    List of messages with the ServerId parameter
  - queryMessageListByType
```
InvocationFuture<java.util.List<IMMessage>> queryMessageListByType(MsgTypeEnum msgTypeEnum,
                                                                   IMMessage anchor,
                                                                   int limit)
```
    query history messages on the local database by type. The query scope is determined by msgTypeEnum and sessionId The result is sorted in descending order. Query a limited number of messages from the anchor
    
    Parameters:
    
    msgTypeEnum - Message type
    
    anchor - The anchor for search
    
    limit - The result limit
    
    Returns:
  - queryMessageListByType
```
InvocationFuture<java.util.List<IMMessage>> queryMessageListByType(MsgTypeEnum msgTypeEnum,
                                                                   java.lang.Long maxTime,
                                                                   int limit)
```
    Query all messages by message type
    
    Parameters:
    
    maxTime - The start time (start time not included). Display a maximum of limit messages from the start time. If the maxTime parameter is empty, all messages are queried.
    
    msgTypeEnum - Message type
    
    limit - The number of messages by each call. If limit is less than or equal to 0, a parameter error message is returned.
    
    Returns:
  - queryMessageListBySubtypeBlock
```
java.util.List<IMMessage> queryMessageListBySubtypeBlock(MsgTypeEnum msgTypeEnum,
                                                         IMMessage anchor,
                                                         int limit,
                                                         int subtype)
```
    Query local messages by subtype (sync)
    
    Parameters:
    
    msgTypeEnum - Message type
    
    anchor - The anchor for search
    
    limit - The result limit
    
    child - message subtype
    
    Returns:
    
    a list of messages whose subtype is the same as the value of the specified subtype parameter.
  - queryMessageListBySubtype
```
InvocationFuture<java.util.List<IMMessage>> queryMessageListBySubtype(MsgTypeEnum msgTypeEnum,
                                                                      IMMessage anchor,
                                                                      int limit,
                                                                      int subtype)
```
    Query local messages by subtype (async)
    
    Parameters:
    
    child - message subtype
    
    anchor - The anchor for search
    
    limit - The result limit
    
    Returns:
    
    InvocationFuture
  - queryMessageList
```
InvocationFuture<java.util.List<IMMessage>> queryMessageList(java.lang.String account,
                                                             SessionTypeEnum sessionType,
                                                             long offset,
                                                             int limit)
```
    Deprecated. replaced with queryMessageListEx(IMMessage, QueryDirectionEnum, int, boolean)
    
    query history messages on the local database.
    Query the messages that are displayed in descending order using the condition: "ORDER BY time desc limit ${limit} offset ${offset}".
    Note: The query result is displayed in descending order. The newest messages are displayed at the top.
    
    Parameters:
    
    account - The peer account to be queried (individual account or group ID)
    
    sessionType - Session type (P2P or group chat)
    
    offset - query offset
    
    limit - Limit of messages displayed per page
    
    Returns:
    
    InvocationFuture
  - queryMessageListEx
```
InvocationFuture<java.util.List<IMMessage>> queryMessageListEx(IMMessage anchor,
                                                               QueryDirectionEnum direction,
                                                               int limit,
                                                               boolean asc)
```
    Query history messages on the local database by anchor and direction
    Query messages earlier than or later than the anchor by direction with a limit.
    The caller can specify the asc parameter to sort the result using the time field.
    Note: Messages at the anchor are not returned.
    
    Parameters:
    
    anchor - Query anchor
    
    direction - Query direction
    
    limit - The limit of messages per query
    
    asc - The sorting order of the result. True: in ascending order; false: in descending order.
    
    Returns:
    
    Tracing call. Callbacks can be set to receive the result.
  - queryMessageListExBlock
```
java.util.List<IMMessage> queryMessageListExBlock(IMMessage anchor,
                                                  QueryDirectionEnum direction,
                                                  int limit,
                                                  boolean asc)
```
    Query history messages on the local database by anchor and direction (sync)
    Query messages earlier than or later than the anchor by direction with a limit.
    The caller can specify the asc parameter to sort the result using the time field.
    Note: Messages at the anchor are not returned.
    
    Parameters:
    
    anchor - Query anchor
    
    direction - Query direction
    
    limit - The limit of messages per query
    
    asc - The sorting order of the result. True: in ascending order; false: in descending order.
    
    Returns:
    
    Tracing call. Callbacks can be set to receive the result.
  - queryMessageListExTime
```
InvocationFuture<java.util.List<IMMessage>> queryMessageListExTime(IMMessage anchor,
                                                                   long toTime,
                                                                   QueryDirectionEnum direction,
                                                                   int limit)
```
    query history messages on the local database based on the start time, end time, and direction.
    The query is executed with the specified direction, the start time and end time of the anchor. The result of messages between the anchor and toTime is returned with a limit on the number of returned messages.
    The query scope is determined by toTime and limit. The parameter that applies first is prioritiezed. For example, if the messages sent or received between the anchor and toTime is greater than the limit number, the limit number of messages are returned. If less than the limit number, the actual number of messages are returned.
    The sort rule for query results: if the direction is set to QUERY_OLD, the result is displayed in descending order; if QUERY_NEW, the result is displayed in ascending order.
    Note: Messages at the anchor are not returned.
    
    Parameters:
    
    anchor - Query anchor
    
    toTime - the end time for a query. If the direction is set to QUERY_OLD, toTime must be less than anchor.getTime(). If the direction is set to QUERY_NEW, toTime must be greater than anchor.getTime().
    
    direction - Query direction
    
    limit - The limit of messages per query
    
    Returns:
    
    Tracing call. Callbacks can be set to receive the result.
  - queryMessageListByTypes
```
InvocationFuture<java.util.List<IMMessage>> queryMessageListByTypes(java.util.List<MsgTypeEnum> types,
                                                                    IMMessage anchor,
                                                                    long toTime,
                                                                    QueryDirectionEnum direction,
                                                                    int limit,
                                                                    boolean asc)
```
    Query history messages based on the start time, end time, and direction.
    The query is executed with the specified direction, the start time and end time of the anchor. The result of messages between the anchor and toTime is returned with a limit on the number of returned messages.
    The query scope is determined by toTime and limit. The parameter that applies first is prioritized. For example, if the messages sent or received between the anchor and toTime is greater than the limit number, the limit number of messages are returned. If less than the limit number, the actual number of messages are returned.
    Sorting rule for a query result. If the asc parameter is set to true, the result is displayed in ascending order. If false, the result is displayed in descending order.
    Note: Messages at the anchor are not returned.
    
    Parameters:
    
    types - types of messages for query. A value of null indicates all message types. The result is the same as queryMessageListExTime(com.netease.nimlib.sdk.msg.model.IMMessage, long, com.netease.nimlib.sdk.msg.model.QueryDirectionEnum, int).
    
    anchor - Query anchor
    
    toTime - the end time for a query. If the direction is set to QUERY_OLD, toTime must be less than anchor.getTime(). If the direction is se to QUERY_NEW, toTime must be greater than anchor.getTime(). A value of 0 indicates no time limit. The number of messags returned is controlled by the limit parameter.
    
    direction - Query direction
    
    limit - The limit of messages per query
    
    asc - The sorting order of the result. True: in ascending order; false: in descending order.
    
    Returns:
    
    Tracing call. Callbacks can be set to receive the result.
  - queryRoamMsgHasMoreTime
```
InvocationFuture<java.lang.Long> queryRoamMsgHasMoreTime(java.lang.String sessionId,
                                                         SessionTypeEnum sessionType)
```
    Get the timestamp of roaming messages. If no roaming messages exist, the callback is triggered.
    
    Parameters:
    
    sessionId - Session ID
    
    sessionType - Session type
    
    Returns:
    
    Tracing call. Callbacks can be set to receive the result.
  - queryRoamMsgHasMoreTimeBlock
```
long queryRoamMsgHasMoreTimeBlock(java.lang.String sessionId,
                                  SessionTypeEnum sessionType)
```
    Get the timestamp of roaming messages. If no roaming messages exist, the callback is triggered.(sync)
    
    Parameters:
    
    sessionId - Session ID
    
    sessionType - Session type
    
    Returns:
    
    Tracing call. Callbacks can be set to receive the result.
  - queryRoamMsgHasMoreTagServerId
```
InvocationFuture<java.lang.Long> queryRoamMsgHasMoreTagServerId(java.lang.String sessionId,
                                                                SessionTypeEnum sessionType)
```
    Get roaming messages with a specified server ID. If no such roaming messages exist, the callback is triggered.
    
    Parameters:
    
    sessionId - Session ID
    
    sessionType - Session type
    
    Returns:
    
    Tracing call. Callbacks can be set to receive the result.
  - queryRoamMsgHasMoreTagServerIdBlock
```
long queryRoamMsgHasMoreTagServerIdBlock(java.lang.String sessionId,
                                         SessionTypeEnum sessionType)
```
    Get roaming messages with a specified server ID. If no such roaming messages exist, the callback is triggered.(sync)
    
    Parameters:
    
    sessionId - Session ID
    
    sessionType - Session type
    
    Returns:
    
    Tracing call. Callbacks can be set to receive the result.
  - pullHistoryById
```
InvocationFuture<java.util.List<IMMessage>> pullHistoryById(java.util.List<MessageKey> msgKeyList,
                                                            boolean persist)
```
    Query history messages by message ID.
    
    Parameters:
    
    msgKeyList - Keywords for query
    
    persist - Specify whether to persist the result
    
    Returns:
    
    InvocationFuture
  - queryLastMessage
```
IMMessage queryLastMessage(java.lang.String account,
                           SessionTypeEnum sessionType)
```
    Query the most recent message of a specifed user
    
    Parameters:
    
    account - User account
    
    sessionType - Session type
    
    Returns:
    
    message
  - pullMessageHistory
```
InvocationFuture<java.util.List<IMMessage>> pullMessageHistory(IMMessage anchor,
                                                               int limit,
                                                               boolean persist)
```
    Get history messages from the server. The returned result is displayed in asceding order. Query a limited number of messages from the anchor
    The returned result may have a smaller size than the limit.
    
    Parameters:
    
    anchor - Query anchor
    Use MessageBuilder.createEmptyMessage(String, SessionTypeEnum, long) to create an empty object for the first time.
    
    limit - The upper limited of the returned result of the query (100 messages)
    
    persist - Specify whether to persist the result to the local database.
    
    Returns:
    
    InvocationFuture
  - pullMessageHistory
```
InvocationFuture<java.util.List<IMMessage>> pullMessageHistory(IMMessage anchor,
                                                               int limit,
                                                               boolean persist,
                                                               boolean persistClear)
```
    Get history messages from the server. The returned result is displayed in asceding order. Query a limited number of messages from the anchor
    The returned result may have a smaller size than the limit.
    
    Parameters:
    
    anchor - Query anchor
    Use MessageBuilder.createEmptyMessage(String, SessionTypeEnum, long) to create an empty object for the first time.
    
    limit - The upper limited of the returned result of the query (100 messages)
    
    persist - Specify whether to persist the result to the local database.
    
    persistClear - Specify whether to persist the messages before clearing to the local storage. The setting applies when persist is set to true.
    
    Returns:
    
    InvocationFuture
  - pullMessageHistoryEx
```
InvocationFuture<java.util.List<IMMessage>> pullMessageHistoryEx(IMMessage anchor,
                                                                 long toTime,
                                                                 int limit,
                                                                 QueryDirectionEnum direction,
                                                                 boolean persist)
```
    Get history messages from the server. The query starts from the anchor (excluded) to toTime based on the direction parameter. The result of messages in a limit number is returned.
    The query scope is determined by toTime and limit. The parameter that applies first is prioritized. For example, if the messages sent or received between the anchor and toTime is greater than the limit number, the limit number of messages are returned. If less than the limit number, the actual number of messages are returned. The returned result may have a smaller size than the limit.
    
    Parameters:
    
    anchor - The start time. A value of null is not allowed.
    Set a custom anchor. Create an empty object using MessageBuilder.createEmptyMessage(String, SessionTypeEnum, long).
    
    toTime - The end time in milliseconds
    
    limit - The upper limit of the returned messages (100)
    
    direction - The query direction. QUERY_OLD: desceding order; QUERY_NEW: ascending order.
    
    persist - Specify whether to persist the result to the local database.
    
    Returns:
    
    InvocationFuture
  - pullMessageHistoryExType
```
InvocationFuture<java.util.List<IMMessage>> pullMessageHistoryExType(IMMessage anchor,
                                                                     long toTime,
                                                                     int limit,
                                                                     QueryDirectionEnum direction,
                                                                     MsgTypeEnum[] msgTypes)
```
    Get history messages from the server with a specified type. The result is not stored in the local database.
    The query starts from the anchor (excluded) to toTime based on the direction parameter. The result of messages in a limit number is returned.
    The query scope is determined by toTime and limit. The parameter that applies first is prioritized. For example, if the messages sent or received between the anchor and toTime is greater than the limit number, the limit number of messages are returned. If less than the limit number, the actual number of messages are returned. The returned result may have a smaller size than the limit. The result is not stored in the database by default.
    
    Parameters:
    
    anchor - The start time. A value of null is not allowed.
    Set a custom anchor. Create an empty object using MessageBuilder.createEmptyMessage(String, SessionTypeEnum, long).
    
    toTime - The end time in milliseconds
    
    limit - The upper limit of the returned messages (100)
    
    direction - The query direction. QUERY_OLD: desceding order; QUERY_NEW: ascending order.
    
    msgTypes - Message types in an array. Message types, 0: text; 1: image; 2: audio; 3: video; 4: location; 5: notification; 6: file; 10: Tip; 100: custom. Other types are invalid.
    
    Returns:
    
    InvocationFuture
  - pullMessageHistoryExType
```
InvocationFuture<java.util.List<IMMessage>> pullMessageHistoryExType(IMMessage anchor,
                                                                     long toTime,
                                                                     int limit,
                                                                     QueryDirectionEnum direction,
                                                                     MsgTypeEnum[] msgTypes,
                                                                     boolean persist)
```
    Get history messages from the server with a specified type. Users can specify whether to store the result in the local database.
    The query starts from the anchor (excluded) to toTime based on the direction parameter. The result of messages in a limit number is returned.
    The query scope is determined by toTime and limit. The parameter that applies first is prioritized. For example, if the messages sent or received between the anchor and toTime is greater than the limit number, the limit number of messages are returned. If less than the limit number, the actual number of messages are returned. The returned result may have a smaller size than the limit.
    
    Parameters:
    
    anchor - The start time. A value of null is not allowed.
    Set a custom anchor. Create an empty object using MessageBuilder.createEmptyMessage(String, SessionTypeEnum, long).
    
    toTime - The end time in milliseconds
    
    limit - The upper limit of the returned messages (100)
    
    direction - The query direction. QUERY_OLD: desceding order; QUERY_NEW: ascending order.
    
    msgTypes - Message types in an array. Message types, 0: text; 1: image; 2: audio; 3: video; 4: location; 5: notification; 6: file; 10: Tip; 100: custom. Other types are invalid.
    
    persist - Specify whether to persist the result to the local database.
    
    Returns:
    
    InvocationFuture
  - pullMessageHistoryExType
```
InvocationFuture<java.util.List<IMMessage>> pullMessageHistoryExType(IMMessage anchor,
                                                                     long toTime,
                                                                     int limit,
                                                                     QueryDirectionEnum direction,
                                                                     MsgTypeEnum[] msgTypes,
                                                                     boolean persist,
                                                                     boolean persistClear)
```
    Get history messages from the server with a specified type. The result is not stored in the local database.
    The query starts from the anchor (excluded) to toTime based on the direction parameter. The result of messages in a limit number is returned.
    The query scope is determined by toTime and limit. The parameter that applies first is prioritized. For example, if the messages sent or received between the anchor and toTime is greater than the limit number, the limit number of messages are returned. If less than the limit number, the actual number of messages are returned. The returned result may have a smaller size than the limit.
    
    Parameters:
    
    anchor - The start time. A value of null is not allowed.
    Set a custom anchor. Create an empty object using MessageBuilder.createEmptyMessage(String, SessionTypeEnum, long).
    
    toTime - The end time in milliseconds
    
    limit - The upper limit of the returned messages (100)
    
    direction - The query direction. QUERY_OLD: desceding order; QUERY_NEW: ascending order.
    
    msgTypes - Message types in an array. Message types, 0: text; 1: image; 2: audio; 3: video; 4: location; 5: notification; 6: file; 10: Tip; 100: custom. Other types are invalid.
    
    persist - Specify whether to store roaming messages obtained using the interface to the local database.
    
    persistClear - Specify whether to persist the messages before clearing to the local storage. The setting applies when persist is set to true.
    
    Returns:
    
    InvocationFuture
  - pullMessageHistoryExType
```
InvocationFuture<java.util.List<IMMessage>> pullMessageHistoryExType(IMMessage anchor,
                                                                     long toTime,
                                                                     int limit,
                                                                     QueryDirectionEnum direction,
                                                                     MsgTypeEnum[] msgTypes,
                                                                     boolean persist,
                                                                     boolean persistClear,
                                                                     IMMessageFilter customFilter)
```
    Get history messages from the server with a specified type. The result is not stored in the local database.
    The query starts from the anchor (excluded) to toTime based on the direction parameter. The result of messages in a limit number is returned.
    The query scope is determined by toTime and limit. The parameter that applies first is prioritized. For example, if the messages sent or received between the anchor and toTime is greater than the limit number, the limit number of messages are returned. If less than the limit number, the actual number of messages are returned. The returned result may have a smaller size than the limit.
    
    Parameters:
    
    anchor - The start time. A value of null is not allowed.
    Set a custom anchor. Create an empty object using MessageBuilder.createEmptyMessage(String, SessionTypeEnum, long).
    
    toTime - The end time in milliseconds
    
    limit - The upper limit of the returned messages (100)
    
    direction - The query direction. QUERY_OLD: desceding order; QUERY_NEW: ascending order.
    
    msgTypes - Message types in an array. Message types, 0: text; 1: image; 2: audio; 3: video; 4: location; 5: notification; 6: file; 10: Tip; 100: custom. Other types are invalid.
    
    persist - Specify whether to store roaming messages obtained using the interface to the local database.
    
    persistClear - Specify whether to persist the messages before clearing to the local storage. The setting applies when persist is set to true.
    
    customFilter - The custom filter. If true is returned, ignore the filter. In this case, the message is not pulled.
    
    Returns:
    
    InvocationFuture
  - pullMessageHistoryExType
```
InvocationFuture<java.util.List<IMMessage>> pullMessageHistoryExType(IMMessage anchor,
                                                                     long toTime,
                                                                     int limit,
                                                                     QueryDirectionEnum direction,
                                                                     MsgTypeEnum[] msgTypes,
                                                                     boolean persist,
                                                                     boolean persistClear,
                                                                     IMMessageFilter customFilter,
                                                                     boolean updateUnread)
```
    Get history messages from the server with a specified type. The result is not stored in the local database.
    The query starts from the anchor (excluded) to toTime based on the direction parameter. The result of messages in a limit number is returned.
    The query scope is determined by toTime and limit. The parameter that applies first is prioritized. For example, if the messages sent or received between the anchor and toTime is greater than the limit number, the limit number of messages are returned. If less than the limit number, the actual number of messages are returned. The returned result may have a smaller size than the limit.
    
    Parameters:
    
    anchor - The start time. A value of null is not allowed.
    Set a custom anchor. Create an empty object using MessageBuilder.createEmptyMessage(String, SessionTypeEnum, long).
    
    toTime - The end time in milliseconds
    
    limit - The upper limit of the returned messages (100)
    
    direction - The query direction. QUERY_OLD: desceding order; QUERY_NEW: ascending order.
    
    msgTypes - Message types in an array. Message types, 0: text; 1: image; 2: audio; 3: video; 4: location; 5: notification; 6: file; 10: Tip; 100: custom. Other types are invalid.
    
    persist - Specify whether to store roaming messages obtained using the interface to the local database.
    
    persistClear - Specify whether to persist the messages before clearing to the local storage. The setting applies when persist is set to true.
    
    customFilter - The custom filter. If true is returned, ignore the filter. In this case, the message is not pulled.
    
    updateUnread - Specified whether to update the unread count.
    
    Returns:
    
    InvocationFuture
  - pullMessageHistory
```
InvocationFuture<java.util.List<IMMessage>> pullMessageHistory(MsgFullKeywordSearchConfig config)
```
    Global search for history messages on the cloud
    
    Parameters:
    
    config - The search configuration
  - pullMessageHistoryOrderByTime
```
InvocationFuture<java.util.List<IMMessage>> pullMessageHistoryOrderByTime(MsgTimingFullKeywordSearchConfig config)
```
    Global search for history messages on the cloud by time not session group
    
    Parameters:
    
    config - Search configuration
  - searchMessageHistory
```
InvocationFuture<java.util.List<IMMessage>> searchMessageHistory(java.lang.String keyword,
                                                                 java.util.List<java.lang.String> fromAccounts,
                                                                 IMMessage anchor,
                                                                 int limit)
```
    Query history messages on the local database. The scope is specified by the session ID and type of the anchor.
    The query starts from the anchor and returns a limit number of messages with matched keys.
    The interface is used for only text messages using keywords for exact match searches. Fuzzy match and Chinese Pinying are not supported.
    SDK does not store user data and keywords cannot match user data. To query the conversation of a specified account, set the fromAccounts parameter.
    If the fromAccounts parameter is specified, in the messages of the session ID and type for the anchor, all the messages with fromAccounts are added to the match result. Note that the query result does not include the anchor.
    
    Parameters:
    
    keyword - The keyword for searching text messages
    
    fromAccounts - The accounts that sent or received messages. If the parameter is specified, the messages from the specified accounts are added to the query result even if no matches are hit.
    
    anchor - The anchor for search
    
    limit - The limit for the number of messages returned.
    
    Returns:
    
    InvocationFuture
  - searchMessageHistory
```
InvocationFuture<java.util.List<IMMessage>> searchMessageHistory(java.lang.String keyword,
                                                                 java.util.List<java.lang.String> fromAccounts,
                                                                 IMMessage anchor,
                                                                 QueryDirectionEnum direction,
                                                                 int limit)
```
    Query history messages on the local database. The scope is specified by the session ID and type of the anchor.
    The result is sorted in descending order. * The query starts from the anchor and returns a limit number of messages with matched keys.
    The interface is used for only text messages using keywords for exact match searches. Fuzzy match and Chinese Pinying are not supported.
    SDK does not store user data and keywords cannot match user data. To query the conversation of a specified account, set the fromAccounts parameter.
    If the fromAccounts parameter is specified, in the messages of the session ID and type for the anchor, all the messages with fromAccounts are added to the match result. Note that the query result does not include the anchor.
    
    Parameters:
    
    keyword - The keyword for searching text messages
    
    fromAccounts - The accounts that sent or received messages. If the parameter is specified, the messages from the specified accounts are added to the query result even if no matches are hit.
    
    anchor - The anchor for search
    
    direction - Query direction
    
    limit - The limit for the number of messages returned.
    
    Returns:
    
    InvocationFuture
  - searchAllMessageHistory
```
InvocationFuture<java.util.List<IMMessage>> searchAllMessageHistory(java.lang.String keyword,
                                                                    java.util.List<java.lang.String> fromAccounts,
                                                                    long time,
                                                                    int limit)
```
    Query history messages on the local database. The interface is used to search messages from a specified point of time and return matched result in asceding order with a limit on the result hit by matched keys
    The interface is used for only text messages using keywords for exact match searches. Fuzzy match and Chinese Pinying are not supported.
    SDK does not store user data and keywords cannot match user data. To query the conversation of a specified account, set the fromAccounts parameter.
    If the fromAccounts parameter is specified, the messages in the fromAccounts list are added to the search result.
    
    Parameters:
    
    keyword - The keyword for searching text messages
    
    fromAccounts - The accounts that sent or received messages. If the parameter is specified, the messages from the specified accounts are added to the query result even if no matches are hit.
    
    time - the time for search.
    
    limit - The limit for the number of messages returned.
    
    Returns:
    
    InvocationFuture
  - searchMessage
```
InvocationFuture<java.util.List<IMMessage>> searchMessage(SessionTypeEnum sessionType,
                                                          java.lang.String sessionId,
                                                          MsgSearchOption option)
```
    Query history messages on the local database. The matched result falls between startTime and endTime with a specified type. The messages in the fromAccount list are also added to the result.
    
    Parameters:
    
    sessionType - Session type
    
    sessionId - Session ID
    
    option - Search option
    
    Returns:
    
    InvocationFuture
  - searchAllMessage
```
InvocationFuture<java.util.List<IMMessage>> searchAllMessage(MsgSearchOption option)
```
    Global search for all history messages on the local database. The matched result falls between startTime and endTime with a specified type. The messages in the fromAccount list are also added to the result.
    
    Parameters:
    
    option - Search option
    
    Returns:
    
    InvocationFuture
  - searchAllSession
```
InvocationFuture<java.util.List<MsgIndexRecord>> searchAllSession(java.lang.String query,
                                                                  int limit)
```
    Query all sessions and return the count of all matched messages from each session and the most recent message that hit the search condition. (async)
    
    Parameters:
    
    query - The strings to be queried
    
    limit - The limit of returned messages
    
    Returns:
    
    InvocationFuture Callback that return the matched result.
  - searchAllSessionBlock
```
java.util.List<MsgIndexRecord> searchAllSessionBlock(java.lang.String query,
                                                     int limit)
```
    Query all sessions and return the count of all matched messages from each session and the most recent message that hit the search condition. (sync)
    
    Parameters:
    
    query - The strings to be queried
    
    limit - The limit of returned messages
    
    Returns:
    
    the matched result
  - searchSession
```
InvocationFuture<java.util.List<MsgIndexRecord>> searchSession(java.lang.String query,
                                                               SessionTypeEnum sessionType,
                                                               java.lang.String sessionId)
```
    Query messages in a specified session and return the matched result. (async)
    
    Parameters:
    
    query - The strings to be queried
    
    sessionType - The session type (P2P or group)
    
    sessionId - the session ID
    
    Returns:
    
    the matched result
  - searchSessionBlock
```
java.util.List<MsgIndexRecord> searchSessionBlock(java.lang.String query,
                                                  SessionTypeEnum sessionType,
                                                  java.lang.String sessionId)
```
    Query messages in a specified session and return the matched result. (sync)
    
    Parameters:
    
    query - The strings to be queried
    
    sessionType - The session type (P2P or group)
    
    sessionId - the session ID
    
    Returns:
    
    InvocationFuture Callback that return the matched result.
  - deleteChattingHistory
```
void deleteChattingHistory(IMMessage message)
```
    Delete a message and record the delete operation in the database. If the messages are retrieved from the cloud, the local delete operation will not recorded in the database. The delete tag will be overwriten by the clear tag
    
    Parameters:
    
    message - The message to be deleted
  - deleteChattingHistory
```
void deleteChattingHistory(IMMessage message,
                           boolean ignore)
```
    Delete a message
    
    Parameters:
    
    message - The message to be deleted
    
    ignore - true: The clear operation is not recorded locally; false: Record the delete operation locally If the messages are retrieved from the cloud, the local delete operation will not recorded in the database. The delete tag will be overwriten by the clear tag
  - deleteChattingHistory
```
void deleteChattingHistory(java.util.List<IMMessage> msgList,
                           boolean ignore)
```
    Delete multiple messages
    
    Parameters:
    
    msgList - The messages to be deleted.
    
    ignore - true: The clear operation is not recorded locally; false: Record the delete operation locally If the messages are retrieved from the cloud, the local delete operation will not recorded in the database. The delete tag will be overwriten by the clear tag
  - clearChattingHistory
```
void clearChattingHistory(java.lang.String account,
                          SessionTypeEnum sessionType)
```
    Clear all messages of a specified user and the clear operation is not recorded in the database.
    
    Parameters:
    
    account - the specified account
    
    sessionType - Session type
  - clearChattingHistory
```
void clearChattingHistory(java.lang.String account,
                          SessionTypeEnum sessionType,
                          boolean ignore)
```
    Clear all local messages of a specified user.
    
    Parameters:
    
    account - the specified account
    
    sessionType - Session type
    
    ignore - true: The clear operation is not recorded locally; false: record the clear operation. For information about the functionality of a clear operation, seepullMessageHistory(IMMessage, int, boolean, boolean)
  - clearMsgDatabase
```
InvocationFuture<java.lang.Void> clearMsgDatabase(boolean clearRecent)
```
    Clear all messages in the database.
    The option to clear the recent contact list is optional.
    If the recent contact list is cleared, MsgServiceObserve.observeRecentContactDeleted(Observer, boolean) will be triggered.
    
    Parameters:
    
    clearRecent - If the value is set to true, the recent contacts list is also cleared.
  - deleteMsgSelf
```
InvocationFuture<java.lang.Long> deleteMsgSelf(IMMessage msg,
                                               java.lang.String ext)
```
    Delete a message sent from the current user
    
    Parameters:
    
    msg - The message to be deleted
    
    ext - extension field
  - deleteMsgSelf
```
InvocationFuture<java.lang.Long> deleteMsgSelf(java.util.List<IMMessage> msgList,
                                               java.lang.String ext)
```
    Delete multiple messages sent from the current user.
    
    Parameters:
    
    msgList - The messages to be deleted.
    
    ext - extension field
  - everBeenDeleted
```
boolean everBeenDeleted(IMMessage message)
```
    Check if the message is deleted from the local storage.
    
    Parameters:
    
    message - The message to be queried
    
    Returns:
    
    the result
  - setChattingAccount
```
void setChattingAccount(java.lang.String account,
                        SessionTypeEnum sessionType)
```
    Set the current chat peer The built-in message alert will be affected. If new messages come from the chat peer, no alert will be indicated.
    The interface also triggers clearUnreadCount(String, SessionTypeEnum) to reset the unread count of the current chat to 0
    
    Parameters:
    
    account, - The peer account or the following to values:
    MSG_CHATTING_ACCOUNT_ALL
    MSG_CHATTING_ACCOUNT_NONE
    
    sessionType - Session type If the account is not specified, ignore this parameter.
  - getTotalUnreadCount
```
int getTotalUnreadCount()
```
    Get the total unread count
  - getTotalUnreadCount
```
int getTotalUnreadCount(boolean notify)
```
    Get the total unread count
    
    Parameters:
    
    notify - true: the count of all unread messages excluding the Do-Not-Disturb messages is returned. False: The acount of the Do-Not-Disturb messages is returned.
    
    Returns:
    
    total unread count
  - queryUnreadMessageList
```
InvocationFuture<java.util.List<IMMessage>> queryUnreadMessageList(java.lang.String sessionId,
                                                                   SessionTypeEnum sessionType)
```
    query all unread messages by session ID and type
    
    Parameters:
    
    sessionId - Session ID
    
    sessionType - Session type
    
    Returns:
    
    The list of unread messages
  - queryUnreadMessageListBlock
```
java.util.List<IMMessage> queryUnreadMessageListBlock(java.lang.String sessionId,
                                                      SessionTypeEnum sessionType)
```
    query all unread messages by session ID and type (sync)
    
    Parameters:
    
    sessionId - Session ID
    
    sessionType - Session type
    
    Returns:
    
    The list of unread messages
  - clearUnreadCount
```
InvocationFuture<java.lang.Void> clearUnreadCount(java.lang.String account,
                                                  SessionTypeEnum sessionType)
```
    Set the unread count of specified recent contact to 0 (tag read).
    The interface call also triggers MsgServiceObserve.observeRecentContact(Observer, boolean) notifications
    
    Parameters:
    
    account - The peer account
    
    sessionType - Session type
  - clearUnreadCount
```
InvocationFuture<java.util.List<SessionAckInfo>> clearUnreadCount(java.util.List<<any>> sessionKeyList)
```
    Set the unread count of specified recent contact to 0 (tag read).
    The interface call also triggers MsgServiceObserve.observeRecentContact(Observer, boolean) notifications
    
    Parameters:
    
    sessionKeyList - The accounts in the chats. Pair includes the session ID and type. SessionTypeEnum.P2P and SessionTypeEnum.Team are supported types.
  - clearAllUnreadCount
```
void clearAllUnreadCount()
```
    Clear all unread count of all contacts (tag read) The interface call also triggers MsgServiceObserve.observeRecentContact(Observer, boolean) notifications
  - sendMessageReceipt
```
InvocationFuture<java.lang.Void> sendMessageReceipt(java.lang.String sessionId,
                                                    IMMessage message)
```
    Send read receipt of P2P messages.
    
    Parameters:
    
    sessionId - Session ID
    
    message - P2P read messages
  - updateIMMessageStatus
```
void updateIMMessageStatus(IMMessage message)
```
    Update message status. The items to be updated:
    Messages status IMMessage.getStatus(). Update the status if null is not set
    Attachment status IMMessage.getAttachStatus(). Update the status if null is not set
    Attachment content IMMessage.getAttachment(). Update the status if null is not set
    
    Parameters:
    
    message - Message to be updated
  - updateIMMessage
```
void updateIMMessage(IMMessage message)
```
    Update messages. Update the local extension field LocalExtension
    
    Parameters:
    
    message - Message to be updated
  - registerCustomAttachmentParser
```
void registerCustomAttachmentParser(MsgAttachmentParser customParser)
```
    If third party apps require custom message types with attachments, the attachment parser must also be registered.
    Custom message type is MsgTypeEnum.custom
    the attachment of a custom message must inherit MsgAttachment。
    
    Parameters:
    
    customParser - Attachment parser
  - sendCustomNotification
```
InvocationFuture<java.lang.Void> sendCustomNotification(CustomNotification notification)
```
    Send an instruction message.
    The SDK send the message in transparent transmission mode, the instruction message status is not recorded. However, a callback can be set to observe the result of the operation.
    
    Parameters:
    
    notification - The instruction message
    
    Returns:
    
    InvocationFuture callback that observe the result.
  - queryRecentContacts
```
InvocationFuture<java.util.List<RecentContact>> queryRecentContacts()
```
    Query the recent contact list
    
    Returns:
    
    InvocationFuture
  - queryRecentContactsBlock
```
java.util.List<RecentContact> queryRecentContactsBlock()
```
    Query the recent contact list (sync)
  - queryRecentContacts
```
InvocationFuture<java.util.List<RecentContact>> queryRecentContacts(int limit)
```
    Query the recent contact list. The limit parameter can be specified to prevent the number of contacts from slow loading due to a great number of sessions.
    
    Parameters:
    
    limit - The upper limit of the local sessions. Up to 100 sessions are allowed. If the number of sessions exceeds 100, 100 will be applied.
    
    Returns:
    
    InvocationFuture
  - queryRecentContacts
```
InvocationFuture<java.util.List<RecentContact>> queryRecentContacts(RecentContact anchor,
                                                                    QueryDirectionEnum direction,
                                                                    int limit)
```
    Query the recent contact list sorted in descending or ascending order with a limit of displayed contacts.
    
    Parameters:
    
    anchor - The anchor used to query the recent contacts list. Pass in null for the first time; If the direction is set to QUERY_NEW, the query starts from a time of 0; If the direction is set to QUERY_OLD, the query starts from the current system time. To go to the next page, pass in the value of RecentContact of the previous page.
    
    direction - Query direction QUERY_OLD: query data before the anchor and display the result in descending order. QUERY_NEW: query data after the anchor and display the result in ascending order.
    
    limit - The limit of local sessions A maximum of 100 sessions are allowed. If the number of sessions exceeds 100, 100 applies.
    
    Returns:
    
    InvocationFuture
  - queryRecentContactsBlock
```
java.util.List<RecentContact> queryRecentContactsBlock(int limit)
```
    Query the recent contact list (sync). The limit parameter can be specified to prevent the number of contacts from slow loading due to a great number of sessions.
    
    Parameters:
    
    limit - The upper limit of the local sessions. Up to 100 sessions are allowed. If the number of sessions exceeds 100, 100 will be applied.
  - queryRecentContactsBlock
```
java.util.List<RecentContact> queryRecentContactsBlock(RecentContact anchor,
                                                       QueryDirectionEnum direction,
                                                       int limit)
```
    Query the recent contact list (sync) sorted in descending or ascending order with a limit of displayed contacts.
    
    Parameters:
    
    anchor - The anchor used to query the recent contacts list. Pass in null for the first time; If the direction is set to QUERY_NEW, the query starts from a time of 0; If the direction is set to QUERY_OLD, the query starts from the current system time. To go to the next page, pass in the value of RecentContact of the previous page.
    
    direction - Query direction QUERY_OLD: query data before queryTime and display the result in descending order. QUERY_NEW: query data after queryTime and display the result in ascending order.
    
    limit - The limit of local sessions A maximum of 100 sessions are allowed. If the number of sessions exceeds 100, 100 applies.
    
    Returns:
    
    The recent contact list
  - queryRecentContacts
```
InvocationFuture<java.util.List<RecentContact>> queryRecentContacts(MsgTypeEnum filterMsgType)
```
    Query the recent contact list. The most recent contact is not a filtered type. For example, To filter MsgTypeEnum.notification, specify with this type. Note: the method returns all unread messages.
    
    Parameters:
    
    filterMsgType - The filted types
    
    Returns:
    
    InvocationFuture
  - queryRecentContactsBlock
```
java.util.List<RecentContact> queryRecentContactsBlock(MsgTypeEnum filterMsgType)
```
    Query the recent contact list (sync). The most recent contact is not a filtered type. It takes a while to call the method. The async version is recommended. Note: the method returns all unread messages.
    
    Parameters:
    
    filterMsgType - The filted types
  - queryRecentContacts
```
InvocationFuture<java.util.List<RecentContact>> queryRecentContacts(java.util.Set<MsgTypeEnum> filterMsgTypeSet)
```
    Query the recent contact list. The most recent contact is not a filtered type medium. For example, To filter MsgTypeEnum.notification, specify with this type. Note: the method returns all unread messages.
    
    Parameters:
    
    filterMsgTypeSet - The filtered type of messages
    
    Returns:
    
    InvocationFuture
  - queryRecentContactsBlock
```
java.util.List<RecentContact> queryRecentContactsBlock(java.util.Set<MsgTypeEnum> filterMsgTypeSet)
```
    Query the recent contact list (sync). The most recent contact is not a filtered type medium. It takes a while to call the method. The async version is recommended. Note: the method returns all unread messages.
    
    Parameters:
    
    filterMsgTypeSet - The filtered type of messages
  - updateRecent
```
void updateRecent(RecentContact recent)
```
    Update the property of a recent contact
    To receive notifications from MsgServiceObserve.observeRecentContact(Observer, boolean), use updateRecentAndNotify(RecentContact)
    Properties that can be set: tag and extension
    
    Parameters:
    
    recent - The recent contact to be updated
  - updateRecentAndNotify
```
void updateRecentAndNotify(RecentContact recent)
```
    Update the property of a recent contact and trigger a notification sent by MsgServiceObserve.observeRecentContact(Observer, boolean).
    If you want to update a recent contact and do not want to receive the notification, call updateRecent(RecentContact) .
    Properties that can be set: tag and extension.
    
    Parameters:
    
    recent - The recent contact to be updated.
  - updateRecentByMessage
```
void updateRecentByMessage(IMMessage message,
                           boolean needNotify)
```
    Update a recent contact by sending a message.
    If the session exists, the existing unread messages and the tag property remain unchanged
    If the message is sent earlier than existing session, no update will be applied.
    
    Parameters:
    
    message - The message
    
    needNotify - Specify whether to trigger MsgServiceObserve.observeRecentContact(Observer, boolean).
  - updateRoamMsgHasMoreTag
```
void updateRoamMsgHasMoreTag(IMMessage newTag)
```
    Update the tag of more roaming messages
    
    Parameters:
    
    newTag - The session ID, session type, service ID, and message sent time are required.
  - deleteRecentContact
```
void deleteRecentContact(RecentContact recent)
```
    Delete a recent contact session from a local storage and roaming data.
    The method call does not trigger the observer to send a notification.
    
    Parameters:
    
    recent - The recent contact session
  - deleteRecentContact2
```
void deleteRecentContact2(java.lang.String account,
                          SessionTypeEnum sessionType)
```
    Delete a recent contact record from the local storage and roaming data.
    The method call will trigger MsgServiceObserve.observeRecentContactDeleted(Observer, boolean) to send a notification.
    
    Parameters:
    
    account -
    
    sessionType -
  - deleteRoamingRecentContact
```
InvocationFuture<java.lang.Void> deleteRoamingRecentContact(java.lang.String contactId,
                                                            SessionTypeEnum sessionTypeEnum)
```
    Delete the roaming messages of a specified recent contact. The local messages are not deleted. If the account is logged in to other devices, the session data before the current time will not roam.
    
    Parameters:
    
    contactId - Contact ID (account or group ID)
    
    sessionTypeEnum - Session type
    
    Returns:
    
    InvocationFuture Callback used to observe the result of the delete operation.
  - deleteRecentContact
```
InvocationFuture<java.lang.Void> deleteRecentContact(java.lang.String account,
                                                     SessionTypeEnum sessionType,
                                                     DeleteTypeEnum deleteType,
                                                     boolean sendAck)
```
    Delete a recent contact record
    The method call will trigger MsgServiceObserve.observeRecentContactDeleted(Observer, boolean) to send a notification.
    
    Parameters:
    
    account - the specified account
    
    sessionType - Session type. SessionTypeEnum.P2P and SessionTypeEnum.Team. Roaming messages will be deleted.
    
    deleteType - Specify to delete local messages or roaming messages. A value of null will take DeleteTypeEnum.REMAIN
    
    sendAck - Specify whether to tag the session as read for other devices.
  - deleteRoamMsgHasMoreTag
```
void deleteRoamMsgHasMoreTag(java.lang.String sessionId,
                             SessionTypeEnum sessionType)
```
    Delete the tag for more roaming messages
    
    Parameters:
    
    sessionId - Session ID
    
    sessionType - Session type
  - transVoiceToText
```
AbortableFuture<java.lang.String> transVoiceToText(java.lang.String voiceUrl,
                                                   java.lang.String path,
                                                   long duration)
```
    Convert voice to text
    
    Parameters:
    
    voiceUrl - Voice url. Optional If no URL exist, the SDK automatically upload the voice to NOS buckets.
    
    path - Voice path to get the sampling rate of the voice. Make sure the audio is downloaded to the local storage.
    
    duration - The duration of an audio file.
    
    Returns:
    
    AbortableFuture tracing calls Callbacks can be set. The interface can abort the download operation.
  - transVoiceToTextAtScene
```
AbortableFuture<java.lang.String> transVoiceToTextAtScene(java.lang.String voiceUrl,
                                                          java.lang.String path,
                                                          long duration,
                                                          java.lang.String sceneKey)
```
    Convert voice to text and specify a file for upload
    
    Parameters:
    
    voiceUrl - Voice url. Optional If no URL exist, the SDK automatically upload the voice to NOS buckets.
    
    path - Voice path to get the sampling rate of the voice. Make sure the audio is downloaded to the local storage.
    
    duration - The duration of an audio file.
    
    sceneKey - The NOS sceneKey for uploads. Default value: NimNosSceneKeyConstant#NIM_DEFAULT_IM. For information about how to configure NOS token scene, seeNosTokenSceneConfig.
    
    Returns:
    
    AbortableFuture tracing calls Callbacks can be set. The interface can abort the download operation.
  - transVoiceToTextEnableForce
```
AbortableFuture<java.lang.String> transVoiceToTextEnableForce(java.lang.String voiceUrl,
                                                              java.lang.String path,
                                                              long duration,
                                                              java.lang.String sceneKey,
                                                              boolean enableForceUploadFile)
```
    Convert voice to text and specify a file for upload. The method also allows users to specify whether to forcibly upload the file.
    
    Parameters:
    
    voiceUrl - Voice URL Optional If no URL exist, the SDK automatically upload the voice to NOS buckets.
    
    path - Voice path to get the sampling rate of the voice. Make sure the audio is downloaded to the local storage.
    
    duration - The duration of an audio file.
    
    sceneKey - The NOS sceneKey for uploads. Default value: NimNosSceneKeyConstant#NIM_DEFAULT_IM. For information about how to configure NOS token scene, seeNosTokenSceneConfig.
    
    enableForceUploadFile - The option to specify whether to forcibly resume uploads. The default value is false.
    
    Returns:
    
    AbortableFuture tracing calls Callbacks can be set. The interface can abort the download operation.
  - searchRoamingMsg
```
InvocationFuture<java.util.ArrayList<IMMessage>> searchRoamingMsg(java.lang.String otherAccid,
                                                                  long fromTime,
                                                                  long endTime,
                                                                  java.lang.String keyword,
                                                                  int limit,
                                                                  boolean reverse)
```
    Search chat records using keywords
    
    Parameters:
    
    otherAccid - peer account
    
    fromTime - The start time in milliseconds
    
    endTime - The end time in milliseconds
    
    keyword - Keywords
    
    limit - The limit of messages returned from a query. A maximum of 100 messages are returned.
    
    reverse - Optional. If the parameter is not specified, false is used by default. A value of true implements a reverse search that starts from the earliest to date and display the result in descending order. The default value is false, which indicates that the search starts from the current date to the earliest time and displays the result in ascending order
  - registerIMMessageFilter
```
void registerIMMessageFilter(IMMessageFilter filter)
```
    Register the message filter
    
    Parameters:
    
    filter - Notification filter in the upper layer. The parameter allows users to filter messages not to store messages in the database. A value of null can unregister the message filter.
  - registerShouldShowNotificationWhenRevokeFilter
```
void registerShouldShowNotificationWhenRevokeFilter(ShowNotificationWhenRevokeFilter filter)
```
    Register the filter to show notifications when a message is recalled.
  - revokeMessage
```
InvocationFuture<java.lang.Void> revokeMessage(IMMessage message)
```
    Recall a messages. No third party push notifications are enabled by default including the iOS platform. For more information, see revokeMessageEx(IMMessage, String, Map)
    
    Parameters:
    
    message - The message to be recalled.
    
    Returns:
    
    InvocationFuture callback that observe the result.
  - revokeMessageEx
```
InvocationFuture<java.lang.Void> revokeMessageEx(IMMessage message,
                                                 java.lang.String customApnsText,
                                                 java.util.Map<java.lang.String,java.lang.Object> pushPayload)
```
    Recall a message and set third party push notifications, including the iOS platform. To disable the in-app message alert, see NIMClient.toggleRevokeMessageNotification(boolean on)
    
    Parameters:
    
    message - The message to be recalled.
    
    customApnsText - Custom push text. If the parameter is not specified, no push notifications will be sent.
    
    pushPayload - Custom push payload in JSON format with a maximum of 2048 characters.
    
    Returns:
    
    InvocationFuture callback that observe the result.
  - revokeMessage
```
InvocationFuture<java.lang.Void> revokeMessage(IMMessage message,
                                               java.lang.String customApnsText,
                                               java.util.Map<java.lang.String,java.lang.Object> pushPayload,
                                               boolean shouldNotifyBeCount)
```
    Recall a message and set third-party push notifications including the iOS platform and changes of the unread count. To disable the in-app message alert, see NIMClient.toggleRevokeMessageNotification(boolean on)
    
    Parameters:
    
    message - The message to be recalled.
    
    customApnsText - Custom push text. If the parameter is not specified, no push notifications will be sent.
    
    pushPayload - Custom push payload in JSON format with a maximum of 2048 characters.
    
    shouldNotifyBeCount - Specify whether to update the unread count when a message is recalled.
    
    Returns:
    
    InvocationFuture callback that observe the result.
  - 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)
```
    Recall a message and set third-party push notifications including the iOS platform and changes of the unread count. To disable the in-app message alert, see NIMClient.toggleRevokeMessageNotification(boolean on)
    
    Parameters:
    
    message - The message to be recalled.
    
    customApnsText - Custom push text. If the parameter is not specified, no push notifications will be sent.
    
    pushPayload - Custom push payload in JSON format with a maximum of 2048 characters.
    
    shouldNotifyBeCount - Specify whether to update the unread count when a message is recalled.
    
    postscript - Additional message
    
    Returns:
    
    InvocationFuture callback that observe the result.
  - 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,
                                               java.lang.String attach)
```
    Recall a message and set third-party push notifications including the iOS platform and changes of the unread count. To disable the in-app message alert, see NIMClient.toggleRevokeMessageNotification(boolean on)
    
    Parameters:
    
    message - The message to be recalled.
    
    customApnsText - Custom push text. If the parameter is not specified, no push notifications will be sent.
    
    pushPayload - Custom push payload in JSON format with a maximum of 2048 characters.
    
    shouldNotifyBeCount - Specify whether to update the unread count when a message is recalled.
    
    postscript - Additional message
    
    attach - extension field
    
    Returns:
    
    InvocationFuture callback that observe the result.
  - importRecentSessions
```
InvocationFuture<java.lang.Void> importRecentSessions(java.util.List<<any>> sessions)
```
    Import multiple recent sessions with contactId and sessionType fields
    
    Parameters:
    
    sessions -
    
    Returns:
  - checkLocalAntiSpam
```
LocalAntiSpamResult checkLocalAntiSpam(java.lang.String content,
                                       java.lang.String replacement)
```
    Check local spam trigger words
    
    Parameters:
    
    content - The text for check
    
    replacement - Replacement for hits
    
    Returns:
    
    LocalAntiSpamResult The result
  - createEmptyRecentContact
```
RecentContact createEmptyRecentContact(java.lang.String contactId,
                                       SessionTypeEnum sessionType,
                                       long tag,
                                       long time,
                                       boolean saveToDB)
```
    Create an empty session with a specified contact
    
    Parameters:
    
    contactId - Contact ID, peer account or group ID
    
    sessionType - Session type
    
    tag - Session tag. For example, Pinned tag implemented in UIKit: RECENT_TAG_STICKY. You can use a custom tag or pass in 0 if not required.
    
    time - The time of a session in milliseconds
    
    saveToDB - Specify whether to store the session in the database. Note:
    1. If an identical session exists (contactId and sessionType are the same), the session will not be saved to the database.
    2. If the session does not exist and needSaveToDB is set to true, MsgServiceObserve.observeRecentContact(Observer, boolean) will be triggered.
    
    Returns:
    
    InvocationFuture
  createEmptyRecentContact
  
  RecentContact createEmptyRecentContact(java.lang.String contactId, SessionTypeEnum sessionType, long tag, long time, boolean saveToDB, boolean withLastMsg)
  
  Create an empty session with a specified contact
  
  Parameters:
  
  contactId - Contact ID, peer account or group ID
  
  sessionType - Session type
  
  tag - Session tag. For example, Pinned tag implemented in UIKit: RECENT_TAG_STICKY. You can use a custom tag or pass in 0 if not required.
  
  time - The time of a session in milliseconds
  
  saveToDB - Specify whether to store the session in the database. Note:
  1. If an identical session exists (contactId and sessionType are the same), the session will not be saved to the database.
  2. If the session does not exist and needSaveToDB is set to true, MsgServiceObserve.observeRecentContact(Observer, boolean) will be triggered.
  
  withLastMsg - Specify whether to include the most recent message.
  
  Returns:
  
  InvocationFuture
  
  queryRecentContact
  
  RecentContact queryRecentContact(java.lang.String contactId, SessionTypeEnum sessionType)
  
  Query session records in the database by contactId and sessionType.
  
  Parameters:
  
  contactId - Contact ID, peer account or group ID
  
  sessionType - Session type
  
  Returns:
  
  RecentContact. If no result is obtained, return null.
  
  cancelUploadAttachment
  
  InvocationFuture<java.lang.Void> cancelUploadAttachment(IMMessage imMessage)
  
  Cancel uploading message attachment, such as image, video, and file. If the attachment is already uploaded, the operation fails.
  If the attachment upload is cancelled, Delivery of the message with which the attachment is attached will fail. The message state becomes MsgStatusEnum.fail and the attachment @link AttachStatusEnum#cancel}
  Note: the operation is not supported in chat rooms
  
  Parameters:
  
  imMessage - The message whose attachment upload is cancelled.
  
  Returns:
  
  InvocationFuture
  
  exportAllMessage
  
  AbortableFuture<java.lang.Void> exportAllMessage(IMsgExportProcessor exportProcessor, boolean safeMode)
  
  Export all messages stored in the local database and upload the messages to the server. The operation is used to migrate history messages. If the messages to be uploaded has records on the cloud, this interface is not recommended.
  For information about how to import messages, see importAllMessage(IMsgImportProcessor, boolean safeMode)
  The following message types are supported: text. Image, audio, video, file, and custom messages
  
  Procedure to export messages:
  Step 1. Convert messages to a file
  Step 2. Compress the file. Developers can define the process.
  Step 3. Encrypt the file. Developers can define the process.
  Step 4. Upload the file
  
  Error code:
  No data exists in the database: MigrationConstant.EXPORT_ERR_DB_EMPTY
  Failed to format the local messages: MigrationConstant.EXPORT_ERR_LOCAL_FORMAT
  Failed to compress the file. Developers can define the process. For more information, see MigrationConstant.EXPORT_ERR_USER_CUSTOM_ZIP
  Failed to encrypt messages.Developers can define the process. For more information, see MigrationConstant.EXPORT_ERR_USER_CUSTOM_ENCRYPT
  Failed to upload the file: MigrationConstant.EXPORT_ERR_UPLOAD_FILE
  No messages are exported because all messages are filtered.: MigrationConstant.EXPORT_ERR_EMPTY_AFTER_FILTER
  
  Parameters:
  
  exportProcessor - The Export processer. This parameter is required.
  
  safeMode - Enable or disable the safe mode.. In the safe mode, the file will be deleted after export, including user defined files.
  
  Returns:
  
  AbortableFuture
  
  importAllMessage
  
  AbortableFuture<java.lang.Void> importAllMessage(IMsgImportProcessor iMsgImportProcessor, boolean safeMode)
  
  Import exported messages. The method is used to migrate history messages from client to client. For information about how to export messages, see exportAllMessage(IMsgExportProcessor, boolean safeMode)
  
  Procedure to import messages:
  Step 1. Send a request to download the backup file.
  Step 2. Decrypt the downloaded file. Developers can define the process.
  Step3. Decompress the downloaded file. Developers can define the process.
  Step4. Parse the file.
  
  Error code:
  No backup is stored on the server: MigrationConstant.IMPORT_ERR_NO_BACKUP
  An empty backup is returned: MigrationConstant.IMPORT_ERR_RECORD_EMPTY
  Download failed: MigrationConstant.IMPORT_ERR_DOWN_FILE
  Failed to decrypt the backup file (developer-defined process): MigrationConstant.IMPORT_ERR_CUSTOM_DECRYPT
  Failed to decompress the backup file (developer-defined process): MigrationConstant.IMPORT_ERR_CUSTOM_UNZIP
  Invalid file format: MigrationConstant.IMPORT_ERR_FILE_FORMAT
  Part of messages are imported: MigrationConstant.IMPORT_ERR_PART_SUCCESS
  
  Parameters:
  
  iMsgImportProcessor - The import processer. The parameter is required.
  
  safeMode - Enable or disable the safe mode.. In the safe mode, the file will be deleted after import, including user defined files.
  
  Returns:
  
  AbortableFuture
  
  clearServerHistory
  
  void clearServerHistory(java.lang.String sessionId, boolean deleteRoam)
  
  Clear history P2P messages
  
  Parameters:
  
  sessionId - Session ID
  
  deleteRoam - Specify whether to delete roaming messages.
  
  clearServerHistory
  
  void clearServerHistory(java.lang.String sessionId, SessionTypeEnum sessionType)
  
  Clear history P2P messages. Roaming messages are deleted by default.
  
  Parameters:
  
  sessionId - Session ID
  
  sessionType - Session type
  
  clearServerHistory
  
  void clearServerHistory(java.lang.String sessionId, SessionTypeEnum sessionType, boolean deleteRoam)
  
  Deprecated. Roaming messages for P2P chats can be retained on the server. To retain roaming messages, use clearServerHistory(String, boolean) To delete roaming messages, use clearServerHistory(String, SessionTypeEnum)
  
  Clear history P2P messages
  
  Parameters:
  
  sessionId - Session ID
  
  sessionType - Session type
  
  deleteRoam - Specify whether to delete roaming messages.
  
  clearServerHistory
  
  void clearServerHistory(java.lang.String sessionId, SessionTypeEnum sessionType, boolean sync, java.lang.String ext)
  
  Clear history messages.
  
  Parameters:
  
  sessionId - Session ID
  
  sessionType - Session type
  
  sync - Enable or disable sync states with other devices
  
  ext - Extension field
  
  deleteRangeHistory
  
  void deleteRangeHistory(java.lang.String account, SessionTypeEnum sessionType, long startTime, long endTime)
  
  Delete local history messages with in a time range between startTime and entTime. The two end points are not included.
  
  Parameters:
  
  account - Account under which messages are deleted
  
  sessionType - Session type
  
  startTime - Start time
  
  endTime - End time
  
  queryMySessionList
  
  InvocationFuture<RecentSessionList> queryMySessionList(long minTimestamp, java.lang.Long maxTimestamp, java.lang.Integer needLastMsg, java.lang.Integer limit, java.lang.Integer hasMore)
  
  Deprecated.
  
  Get a list of sessions by increment. Increment and pagination will be displayed.
  
  Parameters:
  
  minTimestamp - The minimum timestamp as the increment used as request parameter to get the session list. A value of 0 indicates all sessions are retrieved.
  
  maxTimestamp - The maximum timestamp pagination
  
  needLastMsg - Specify whether to get lastMsg. 0 or 1. The default value is 1.
  
  limit - The limit of retrieved sessions. A maximum of 100 sessions are supported. The default value is 100.
  
  hasMore - Reserved
  
  Returns:
  
  InvocationFuture
  
  See Also:
  
  queryMySessionList(QueryMySessionOption)
  
  queryMySessionList
  
  InvocationFuture<RecentSessionList> queryMySessionList(QueryMySessionOption option)
  
  Get a list of session by increment. Increment and pagination will be displayed.
  
  Parameters:
  
  option - Options for configuration
  
  Returns:
  
  InvocationFuture
  
  queryMySession
  
  InvocationFuture<RecentSession> queryMySession(java.lang.String sessionId)
  
  Get a session
  
  Parameters:
  
  sessionIdArr - P2P, team or superTeam. Format: p2p|accid, team|tid, or super_team|tid
  
  Returns:
  
  InvocationFuture
  
  See Also:
  
  com.netease.nimlib.biz.constant.ITalkService.SessionTag
  
  updateMySession
  
  InvocationFuture<java.lang.Void> updateMySession(java.lang.String sessionId, java.lang.String ext)
  
  Update the extension field of a session. If the session does not exist, the session will be created. lasMsg does not exist at the moment.
  
  Parameters:
  
  sessionIdArr - P2P, team or superTeam. Format: p2p|accid, team|tid, or super_team|tid
  
  ext - extension field. Visible for the current user.
  
  Returns:
  
  InvocationFuture
  
  See Also:
  
  com.netease.nimlib.biz.constant.ITalkService.SessionTag
  
  deleteMySession
  
  InvocationFuture<java.lang.Void> deleteMySession(java.lang.String[] sessionIdArr)
  
  Delete a session
  
  Parameters:
  
  sessionIdArr - P2P, team or superTeam. Format: p2p|accid, team|tid, or super_team|tid.
  
  Returns:
  
  InvocationFuture
  
  See Also:
  
  com.netease.nimlib.biz.constant.ITalkService.SessionTag
  
  queryThreadTalkHistory
  
  InvocationFuture<ThreadTalkHistory> queryThreadTalkHistory(IMMessage anchor, long fromTime, long toTime, int limit, QueryDirectionEnum direction, boolean persist)
  
  Query history thread chats on the cloud. The session types of P2P, group, and supergroup are supported.
  
  Parameters:
  
  anchor - The search anchor. The search object is the messages in a thread.
  
  fromTime - The start time
  
  toTime - The end time
  
  limit - The limit of messages
  
  direction - Search direction
  
  persist - Specify whether to persist the result
  
  Returns:
  
  InvocationFuture
  
  queryReplyCountInThreadTalkBlock
  
  int queryReplyCountInThreadTalkBlock(IMMessage msg)
  
  Get the reply count of a thread chat. The thread message is not counted.
  
  Parameters:
  
  msg - A message in a thread
  
  Returns:
  
  The number of replies
  
  addQuickComment
  
  InvocationFuture<java.lang.Void> addQuickComment(IMMessage msg, long replyType, java.lang.String ext)
  
  Add a quick comment.
  
  Parameters:
  
  msg - the message object to be replied
  
  replyType - Reply type
  
  ext - Extension field that can hold up to 8 characters
  
  Returns:
  
  InvocationFuture
  
  addQuickComment
  
  InvocationFuture<java.lang.Long> addQuickComment(IMMessage msg, long replyType, java.lang.String ext, boolean needPush, boolean needBadge, java.lang.String pushTitle, java.lang.String pushContent, java.util.Map<java.lang.String,java.lang.Object> pushPayload)
  
  Add a quick comment.
  
  Parameters:
  
  msg - the message object to be replied
  
  replyType - Reply type
  
  ext - Extension field that can hold up to 8 characters
  
  needPush - Enable or disable push
  
  needBadge - Hide or show the message badge
  
  pushTitle - The title of a push notification
  
  pushContent - The content of a push notification
  
  pushPayload - Custom push property in JSON format only
  
  Returns:
  
  InvocationFuture
  
  removeQuickComment
  
  InvocationFuture<java.lang.Void> removeQuickComment(IMMessage msg, long replyType, java.lang.String ext)
  
  Remove a quick comment
  
  Parameters:
  
  msg - the message object to be replied
  
  replyType - Reply type
  
  ext - Extension field that can hold up to 8 characters
  
  Returns:
  
  InvocationFuture
  
  removeQuickComment
  
  InvocationFuture<java.lang.Long> removeQuickComment(IMMessage msg, long replyType, java.lang.String ext, boolean needPush, boolean needBadge, java.lang.String pushTitle, java.lang.String pushContent, java.util.Map<java.lang.String,java.lang.Object> pushPayload)
  
  Remove a quick comment
  
  Parameters:
  
  msg - the message object to be replied
  
  replyType - Reply type
  
  ext - Extension field that can hold up to 8 characters
  
  needPush - Enable or disable push
  
  needBadge - Hide or show the message badge
  
  pushTitle - The title of a push notification
  
  pushContent - The content of a push notification
  
  pushPayload - Custom push property in JSON format only
  
  Returns:
  
  InvocationFuture
  
  queryQuickComment
  
  InvocationFuture<java.util.List<QuickCommentOptionWrapper>> queryQuickComment(java.util.List<IMMessage> msgList)
  
  Get a quick comment
  
  Parameters:
  
  msgList - A list of messages for quick comments. Up to 20 messages are supported.
  
  Returns:
  
  InvocationFuture
  
  addCollect
  
  InvocationFuture<CollectInfo> addCollect(int type, java.lang.String date, java.lang.String ext, java.lang.String uniqueId)
  
  Add a bookmark
  
  Parameters:
  
  type - Bookmark type
  
  date - Time when the bookmark is collected
  
  ext - extension field
  
  uniqueId - The unique ID
  
  Returns:
  
  InvocationFuture
  
  removeCollect
  
  InvocationFuture<java.lang.Integer> removeCollect(java.util.List<<any>> collectInfo)
  
  Remove multiple bookmarks
  
  Parameters:
  
  collectInfo - Info of bookmarks to be removed. Each pair consists of a bookmark ID and the creation time.
  
  Returns:
  
  InvocationFuture
  
  See Also:
  
  CollectInfo
  
  updateCollect
  
  InvocationFuture<CollectInfo> updateCollect(CollectInfo info, java.lang.String ext)
  
  Update the extension field of the bookmark
  
  Parameters:
  
  info - The bookmarks to be updated
  
  ext - The extension field
  
  Returns:
  
  InvocationFuture
  
  updateCollect
  
  InvocationFuture<CollectInfo> updateCollect(long infoId, long createTime, java.lang.String ext)
  
  Update the extension field of the bookmark
  
  Parameters:
  
  infoId - The ID of a bookmark to be updated
  
  createTime - The creation time of a bookmark to be updated
  
  ext - The extension field
  
  Returns:
  
  InvocationFuture
  
  queryCollect
  
  InvocationFuture<CollectInfoPage> queryCollect(int limit)
  
  Query bookmarks
  
  Parameters:
  
  limit - The limit of messages returned from a query. A maximum of 100 messages are returned.
  
  Returns:
  
  InvocationFuture
  
  queryCollect
  
  InvocationFuture<CollectInfoPage> queryCollect(CollectInfo anchor, long toTime, int limit, QueryDirectionEnum direction)
  
  Query bookmarks on the server page
  
  Parameters:
  
  anchor - The last bookmark in the query excluded in the query result.
  
  toTime - The end time in milliseconds
  
  limit - The limit of messages returned from a query. A maximum of 100 messages are returned.
  
  direction - Query direction
  
  Returns:
  
  InvocationFuture
  
  queryCollect
  
  InvocationFuture<CollectInfoPage> queryCollect(CollectInfo anchor, long toTime, int limit, QueryDirectionEnum direction, int type, boolean persist)
  
  Query bookmarks on the service page
  
  Parameters:
  
  anchor - The last bookmark in the query excluded in the query result.
  
  toTime - The end time in milliseconds
  
  limit - The limit of messages returned from a query. A maximum of 100 messages are returned.
  
  direction - Query direction
  
  type - Bookmark type
  
  persist - Specify whether to persist the result
  
  Returns:
  
  InvocationFuture
  
  addMsgPin
  
  InvocationFuture<java.lang.Long> addMsgPin(IMMessage msg, java.lang.String ext)
  
  Add a PIN tag to a message
  
  Parameters:
  
  msg - PIN message
  
  ext - extension field
  
  Returns:
  
  InvocationFuture
  
  updateMsgPin
  
  InvocationFuture<java.lang.Long> updateMsgPin(IMMessage msg, java.lang.String ext)
  
  Update a PIN message
  
  Parameters:
  
  msg - PIN message
  
  ext - extension field
  
  Returns:
  
  InvocationFuture
  
  removeMsgPin
  
  InvocationFuture<java.lang.Long> removeMsgPin(IMMessage msg, java.lang.String ext)
  
  Remove the PIN tag of a message
  
  Parameters:
  
  msg - PIN message
  
  ext - extension field
  
  Returns:
  
  InvocationFuture
  
  syncMsgPin
  
  InvocationFuture<MsgPinSyncResponseOptionWrapper> syncMsgPin(SessionTypeEnum sessionType, java.lang.String sessionId, long timestamp)
  
  Sync PIN messages in a session
  
  Parameters:
  
  sessionType - Session type
  
  sessionId - Session ID
  
  timestamp - A timestamp. Sync PIN messages after the timestamp.
  
  Returns:
  
  InvocationFuture
  
  queryMsgPinBlock
  
  java.util.List<MsgPinDbOption> queryMsgPinBlock(java.lang.String sessionId, SessionTypeEnum sessionType)
  
  Get a list of PIN messages
  
  Parameters:
  
  sessionId - Session ID
  
  sessionType - Session type
  
  Returns:
  
  List of PIN messages
  
  addStickTopSession
  
  InvocationFuture<StickTopSessionInfo> addStickTopSession(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String ext)
  
  Add a pinned session
  
  Parameters:
  
  sessionId - Session ID
  
  sessionType - Session type
  
  ext - The extension field. A maximum of 512 characters are allowed.
  
  Returns:
  
  InvocationFuture
  
  removeStickTopSession
  
  InvocationFuture<java.lang.Void> removeStickTopSession(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String ext)
  
  Delete a pinned session
  
  Parameters:
  
  sessionId - Session ID
  
  sessionType - Session type
  
  ext - The extension field. A maximum of 512 characters are allowed.
  
  Returns:
  
  InvocationFuture
  
  updateStickTopSession
  
  InvocationFuture<StickTopSessionInfo> updateStickTopSession(java.lang.String sessionId, SessionTypeEnum sessionType, java.lang.String ext)
  
  Update the extension field of a pinned session
  
  Parameters:
  
  sessionId - Session ID
  
  sessionType - Session type
  
  ext - The extension field. A maximum of 512 characters are allowed.
  
  Returns:
  
  InvocationFuture
  
  queryStickTopSessionBlock
  
  java.util.List<StickTopSessionInfo> queryStickTopSessionBlock()
  
  Get the pinned sessions
  
  Returns:
  
  the pinned sessions
  
  isStickTopSession
  
  boolean isStickTopSession(java.lang.String sessionId, SessionTypeEnum sessionType)
  
  Check if the session is pinned. If the parameter is invalid or the session does not exist, a value of false is returned.
  
  Parameters:
  
  sessionId - Session ID. A value of "” or null returns false.
  
  sessionType - Session type. A value of null returns false
  
  Returns:
  
  The result
  
  migrateMessages
  
  void migrateMessages(java.lang.String from, java.lang.String to, boolean changeFrom)
  
  Migrate message data Migrate history message data of accounts in the from field to the message data of accounts in the to field. Message records and recent contacts are also migrated.
  The existing recent contacts will not be updated.
  
  Parameters:
  
  from - Account from which the message data is migrated
  
  to - Account to which the message data is migrated.
  
  changeFrom - Specify whether to change the fromAccount parameter of IMMessage in the source data. If the value is set to true, fromAccount is changed from the value of from to a value of to

Interface MsgService

Field Summary

Method Summary

Field Detail

MSG_CHATTING_ACCOUNT_ALL

MSG_CHATTING_ACCOUNT_NONE

Method Detail

sendMessage

replyMessage

sendFile

insertLocalMessage

saveMessageToLocal

saveMessageToLocalEx

downloadAttachment

queryMessageListByUuidBlock

queryMessageListByUuid

queryMessageListByServerIdBlock

queryMessageListByType

queryMessageListByType

queryMessageListBySubtypeBlock

queryMessageListBySubtype

queryMessageList

queryMessageListEx

queryMessageListExBlock

queryMessageListExTime

queryMessageListByTypes

queryRoamMsgHasMoreTime

queryRoamMsgHasMoreTimeBlock

queryRoamMsgHasMoreTagServerId

queryRoamMsgHasMoreTagServerIdBlock

pullHistoryById

queryLastMessage

pullMessageHistory

pullMessageHistory

pullMessageHistoryEx

pullMessageHistoryExType

pullMessageHistoryExType

pullMessageHistoryExType

pullMessageHistoryExType

pullMessageHistoryExType

pullMessageHistory

pullMessageHistoryOrderByTime

searchMessageHistory

searchMessageHistory

searchAllMessageHistory

searchMessage

searchAllMessage

searchAllSession

searchAllSessionBlock

searchSession

searchSessionBlock

deleteChattingHistory

deleteChattingHistory

deleteChattingHistory

clearChattingHistory

clearChattingHistory

clearMsgDatabase

deleteMsgSelf

deleteMsgSelf

everBeenDeleted

setChattingAccount

getTotalUnreadCount

getTotalUnreadCount

queryUnreadMessageList

queryUnreadMessageListBlock

clearUnreadCount

clearUnreadCount

clearAllUnreadCount

sendMessageReceipt

updateIMMessageStatus

updateIMMessage

registerCustomAttachmentParser

sendCustomNotification

queryRecentContacts

queryRecentContactsBlock

queryRecentContacts

queryRecentContacts

queryRecentContactsBlock

queryRecentContactsBlock

queryRecentContacts