MsgService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.msg;

import android.util.Pair;

import com.netease.nimlib.NimNosSceneKeyConstant;
import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.notifier.support26.annotation.NonNull;
import com.netease.nimlib.sdk.AbortableFuture;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.NosTokenSceneConfig;
import com.netease.nimlib.sdk.Observer;
import com.netease.nimlib.sdk.migration.model.MigrationConstant;
import com.netease.nimlib.sdk.migration.processor.IMsgExportProcessor;
import com.netease.nimlib.sdk.migration.processor.IMsgImportProcessor;
import com.netease.nimlib.sdk.msg.attachment.FileAttachment;
import com.netease.nimlib.sdk.msg.attachment.MsgAttachmentParser;
import com.netease.nimlib.sdk.msg.constant.AttachStatusEnum;
import com.netease.nimlib.sdk.msg.constant.DeleteTypeEnum;
import com.netease.nimlib.sdk.msg.constant.MsgStatusEnum;
import com.netease.nimlib.sdk.msg.constant.MsgTypeEnum;
import com.netease.nimlib.sdk.msg.constant.SessionTypeEnum;
import com.netease.nimlib.sdk.msg.model.CollectInfo;
import com.netease.nimlib.sdk.msg.model.CollectInfoPage;
import com.netease.nimlib.sdk.msg.model.CustomNotification;
import com.netease.nimlib.sdk.msg.model.GetMessagesDynamicallyParam;
import com.netease.nimlib.sdk.msg.model.GetMessagesDynamicallyResult;
import com.netease.nimlib.sdk.msg.model.IMMessage;
import com.netease.nimlib.sdk.msg.model.LocalAntiSpamResult;
import com.netease.nimlib.sdk.msg.model.MessageKey;
import com.netease.nimlib.sdk.msg.model.MsgFullKeywordSearchConfig;
import com.netease.nimlib.sdk.msg.model.MsgPinDbOption;
import com.netease.nimlib.sdk.msg.model.MsgPinSyncResponseOptionWrapper;
import com.netease.nimlib.sdk.msg.model.MsgSearchOption;
import com.netease.nimlib.sdk.msg.model.MsgTimingFullKeywordSearchConfig;
import com.netease.nimlib.sdk.msg.model.NIMMessage;
import com.netease.nimlib.sdk.msg.model.QueryDirectionEnum;
import com.netease.nimlib.sdk.msg.model.QueryMySessionOption;
import com.netease.nimlib.sdk.msg.model.QueryThreadTalkHistoryOption;
import com.netease.nimlib.sdk.msg.model.QuickCommentOptionWrapper;
import com.netease.nimlib.sdk.msg.model.RecentContact;
import com.netease.nimlib.sdk.msg.model.RecentSession;
import com.netease.nimlib.sdk.msg.model.RecentSessionList;
import com.netease.nimlib.sdk.msg.model.SessionAckInfo;
import com.netease.nimlib.sdk.msg.model.ShowNotificationWhenRevokeFilter;
import com.netease.nimlib.sdk.msg.model.StickTopSessionInfo;
import com.netease.nimlib.sdk.msg.model.ThreadTalkHistory;
import com.netease.nimlib.sdk.search.model.MsgIndexRecord;
import com.netease.nimlib.sdk.team.model.IMMessageFilter;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;

@NIMService("消息服务")
public interface MsgService {

    String MSG_CHATTING_ACCOUNT_ALL = "all";

    String MSG_CHATTING_ACCOUNT_NONE = null;

    InvocationFuture<Void> sendMessage(IMMessage msg, boolean resend);

    InvocationFuture<Void> replyMessage(IMMessage msg, IMMessage replyMsg, boolean resend);


    AbortableFuture<FileAttachment> sendFile(FileAttachment attachment);

    InvocationFuture<Void> insertLocalMessage(IMMessage msg, String fromAccount);

    InvocationFuture<Void> saveMessageToLocal(IMMessage msg, boolean notify);

    InvocationFuture<Void> saveMessageToLocalEx(IMMessage msg, boolean notify, long time);

    AbortableFuture<Void> downloadAttachment(IMMessage msg, boolean thumb);

    List<IMMessage> queryMessageListByUuidBlock(List<String> uuids);

    InvocationFuture<List<IMMessage>> queryMessageListByUuid(List<String> uuids);

    List<IMMessage> queryMessageListByServerIdBlock(List<String> serverIds);

    InvocationFuture<List<IMMessage>> queryMessageListByType(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit);

    InvocationFuture<List<IMMessage>> queryMessageListByType(MsgTypeEnum msgTypeEnum, Long maxTime,
                                                             int limit);

    List<IMMessage> queryMessageListBySubtypeBlock(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit, int subtype);

    InvocationFuture<List<IMMessage>> queryMessageListBySubtype(MsgTypeEnum msgTypeEnum, IMMessage anchor, int limit, int subtype);

    InvocationFuture<List<IMMessage>> queryMessageList(String account, SessionTypeEnum sessionType, long offset,
                                                       int limit);

    InvocationFuture<List<IMMessage>> queryMessageListEx(IMMessage anchor, QueryDirectionEnum direction, int limit,
                                                         boolean asc);

    List<IMMessage> queryMessageListExBlock(IMMessage anchor, QueryDirectionEnum direction, int limit,
                                            boolean asc);

    InvocationFuture<List<IMMessage>> queryMessageListExTime(IMMessage anchor, long toTime,
                                                             QueryDirectionEnum direction, int limit);

    @Deprecated
    InvocationFuture<List<IMMessage>> queryMessageListByTypes(List<MsgTypeEnum> types, IMMessage anchor, long toTime,
                                                              QueryDirectionEnum direction, int limit, boolean asc);

    InvocationFuture<List<IMMessage>> queryMessageListByTypesV2(List<MsgTypeEnum> types, IMMessage anchor, long toTime,
                                                                QueryDirectionEnum direction, int limit, boolean asc);

    InvocationFuture<Long> queryRoamMsgHasMoreTime(String sessionId, SessionTypeEnum sessionType);

    long queryRoamMsgHasMoreTimeBlock(String sessionId, SessionTypeEnum sessionType);

    InvocationFuture<Long> queryRoamMsgHasMoreTagServerId(String sessionId, SessionTypeEnum sessionType);


    long queryRoamMsgHasMoreTagServerIdBlock(String sessionId, SessionTypeEnum sessionType);

    InvocationFuture<List<IMMessage>> pullHistoryById(List<MessageKey> msgKeyList, boolean persist);

    IMMessage queryLastMessage(String account, SessionTypeEnum sessionType);

    InvocationFuture<List<IMMessage>> pullMessageHistory(IMMessage anchor, int limit, boolean persist);


    InvocationFuture<List<IMMessage>> pullMessageHistory(IMMessage anchor, int limit, boolean persist, boolean persistClear);

    InvocationFuture<List<IMMessage>> pullMessageHistoryEx(IMMessage anchor, long toTime, int limit,
                                                           QueryDirectionEnum direction, boolean persist);

    InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
                                                               QueryDirectionEnum direction, MsgTypeEnum[] msgTypes);

    InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
                                                               QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist);

    InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
                                                               QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist,
                                                               boolean persistClear);

    InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
                                                               QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist,
                                                               boolean persistClear, IMMessageFilter customFilter);

    InvocationFuture<List<IMMessage>> pullMessageHistoryExType(IMMessage anchor, long toTime, int limit,
                                                               QueryDirectionEnum direction, MsgTypeEnum[] msgTypes, boolean persist,
                                                               boolean persistClear, IMMessageFilter customFilter, boolean updateUnread);

    InvocationFuture<List<IMMessage>> pullMessageHistory(MsgFullKeywordSearchConfig config);

    InvocationFuture<List<IMMessage>> pullMessageHistoryOrderByTime(
            MsgTimingFullKeywordSearchConfig config);

    InvocationFuture<GetMessagesDynamicallyResult> getMessagesDynamically(GetMessagesDynamicallyParam param);

    InvocationFuture<List<IMMessage>> searchMessageHistory(String keyword, List<String> fromAccounts, IMMessage anchor,
                                                           int limit);


    InvocationFuture<List<IMMessage>> searchMessageHistory(String keyword, List<String> fromAccounts,
                                                           IMMessage anchor, QueryDirectionEnum direction, int limit);

    InvocationFuture<List<IMMessage>> searchAllMessageHistory(String keyword, List<String> fromAccounts, long time,
                                                              int limit);

    InvocationFuture<List<IMMessage>> searchMessage(SessionTypeEnum sessionType, String sessionId, MsgSearchOption option);

    InvocationFuture<List<IMMessage>> searchAllMessage(MsgSearchOption option);




    InvocationFuture<List<MsgIndexRecord>> searchAllSession(String query, int limit);

    List<MsgIndexRecord> searchAllSessionBlock(String query, int limit);

    InvocationFuture<List<MsgIndexRecord>> searchSession(String query, SessionTypeEnum sessionType, String sessionId);

    List<MsgIndexRecord> searchSessionBlock(String query, SessionTypeEnum sessionType, String sessionId);

    void deleteChattingHistory(IMMessage message);

    void deleteChattingHistory(IMMessage message, boolean ignore);

    void deleteChattingHistory(List<IMMessage> msgList, boolean ignore);

    void clearChattingHistory(String account, SessionTypeEnum sessionType);

    void clearChattingHistory(String account, SessionTypeEnum sessionType, boolean ignore);

    InvocationFuture<Void> clearMsgDatabase(boolean clearRecent);

    InvocationFuture<Long> deleteMsgSelf(IMMessage msg, String ext);

    InvocationFuture<Long> deleteMsgSelf(List<IMMessage> msgList, String ext);

    boolean everBeenDeleted(IMMessage message);

    void setChattingAccount(String account, SessionTypeEnum sessionType);

    int getTotalUnreadCount();

    int getTotalUnreadCount(boolean notify);

    int getUnreadCountBySessionType(SessionTypeEnum sessionType);

    InvocationFuture<List<IMMessage>> queryUnreadMessageList(String sessionId,SessionTypeEnum sessionType);
    List<IMMessage> queryUnreadMessageListBlock(String sessionId,SessionTypeEnum sessionType);

    InvocationFuture<Void> clearUnreadCount(String account, SessionTypeEnum sessionType);

    InvocationFuture<List<SessionAckInfo>> clearUnreadCount(List<Pair<String, SessionTypeEnum>> sessionKeyList);

    InvocationFuture<List<SessionAckInfo>> clearUnreadCount(SessionTypeEnum sessionType);


    void clearAllUnreadCount();

    InvocationFuture<Void> sendMessageReceipt(String sessionId, IMMessage message);

    void updateIMMessageStatus(IMMessage message);

    void updateIMMessage(IMMessage message);

    void registerCustomAttachmentParser(MsgAttachmentParser customParser);

    InvocationFuture<Void> sendCustomNotification(CustomNotification notification);

    InvocationFuture<List<RecentContact>> queryRecentContacts();

    List<RecentContact> queryRecentContactsBlock();

    InvocationFuture<List<RecentContact>> queryRecentContacts(int limit);


    InvocationFuture<List<RecentContact>> queryRecentContacts(RecentContact anchor,QueryDirectionEnum direction,int limit);

    List<RecentContact> queryRecentContactsBlock(int limit);

    List<RecentContact> queryRecentContactsBlock(RecentContact anchor,QueryDirectionEnum direction,int limit);


    InvocationFuture<List<RecentContact>> queryRecentContacts(MsgTypeEnum filterMsgType);

    List<RecentContact> queryRecentContactsBlock(MsgTypeEnum filterMsgType);


    InvocationFuture<List<RecentContact>> queryRecentContacts(Set<MsgTypeEnum> filterMsgTypeSet);

    List<RecentContact> queryRecentContactsBlock(Set<MsgTypeEnum> filterMsgTypeSet);

    void updateRecent(RecentContact recent);


    void updateRecentAndNotify(RecentContact recent);


    void updateRecentByMessage(IMMessage message, boolean needNotify);


    void updateRoamMsgHasMoreTag(IMMessage newTag);

    void deleteRecentContact(RecentContact recent);

    void deleteRecentContact2(String account, SessionTypeEnum sessionType);

    InvocationFuture<Void> deleteRoamingRecentContact(String contactId, SessionTypeEnum sessionTypeEnum);

    InvocationFuture<Void> deleteRecentContact(String account, SessionTypeEnum sessionType, DeleteTypeEnum deleteType, boolean sendAck);

    void deleteRoamMsgHasMoreTag(String sessionId, SessionTypeEnum sessionType);

    AbortableFuture<String> transVoiceToText(String voiceUrl, String path, long duration);

    AbortableFuture<String> transVoiceToTextAtScene(String voiceUrl, String path, long duration, String sceneKey);


    AbortableFuture<String> transVoiceToTextEnableForce(String voiceUrl, String path, long duration, String sceneKey,
                                                        boolean enableForceUploadFile);

    InvocationFuture<ArrayList<IMMessage>> searchRoamingMsg(String otherAccid, long fromTime, long endTime, String keyword, int limit, boolean reverse);

    void registerIMMessageFilter(IMMessageFilter filter);

    void registerShouldShowNotificationWhenRevokeFilter(ShowNotificationWhenRevokeFilter filter);

    InvocationFuture<Void> revokeMessage(IMMessage message);


    InvocationFuture<Void> revokeMessageEx(IMMessage message, String customApnsText, Map<String, Object> pushPayload);


    InvocationFuture<Void> revokeMessage(IMMessage message, String customApnsText,
                                         Map<String, Object> pushPayload, boolean shouldNotifyBeCount);

    InvocationFuture<Void> revokeMessage(IMMessage message, String customApnsText,
                                         Map<String, Object> pushPayload, boolean shouldNotifyBeCount,
                                         String postscript);

    InvocationFuture<Void> revokeMessage(IMMessage message, String customApnsText,
                                         Map<String, Object> pushPayload, boolean shouldNotifyBeCount,
                                         String postscript, String attach);

    InvocationFuture<Void> importRecentSessions(List<Pair<String, SessionTypeEnum>> sessions);


    LocalAntiSpamResult checkLocalAntiSpam(String content, String replacement);

    RecentContact createEmptyRecentContact(String contactId, SessionTypeEnum sessionType, long tag, long time,
                                           boolean saveToDB);

    RecentContact createEmptyRecentContact(String contactId, SessionTypeEnum sessionType, long tag, long time,
                                           boolean saveToDB, boolean withLastMsg);


    RecentContact queryRecentContact(String contactId, SessionTypeEnum sessionType);


    InvocationFuture<Void> cancelUploadAttachment(IMMessage imMessage);


    AbortableFuture<Void> exportAllMessage(IMsgExportProcessor exportProcessor, boolean safeMode);


    AbortableFuture<Void> importAllMessage(IMsgImportProcessor iMsgImportProcessor, boolean safeMode);

    void clearServerHistory(String sessionId, boolean deleteRoam);


    void clearServerHistory(String sessionId, SessionTypeEnum sessionType);

    void clearServerHistory(String sessionId, SessionTypeEnum sessionType, boolean deleteRoam);

    void clearServerHistory(String sessionId, SessionTypeEnum sessionType, boolean sync, String ext);


    void deleteRangeHistory(String account, SessionTypeEnum sessionType, long startTime, long endTime);

    InvocationFuture<RecentSessionList> queryMySessionList(long minTimestamp, Long maxTimestamp, Integer needLastMsg, Integer limit, Integer hasMore);

    InvocationFuture<RecentSessionList> queryMySessionList(QueryMySessionOption option);

    InvocationFuture<RecentSession> queryMySession(@NonNull String sessionId);

    InvocationFuture<Void> updateMySession(@NonNull String sessionId, @NonNull String ext);

    InvocationFuture<Void> deleteMySession(@NonNull String[] sessionIdArr);

    InvocationFuture<ThreadTalkHistory> queryThreadTalkHistory(IMMessage anchor, long fromTime, long toTime,
                                                               int limit, QueryDirectionEnum direction, boolean persist);

    InvocationFuture<ThreadTalkHistory> queryThreadTalkHistory(MessageKey threadMessageKey, QueryThreadTalkHistoryOption option);

    int queryReplyCountInThreadTalkBlock(IMMessage msg);

    InvocationFuture<Void> addQuickComment(IMMessage msg, long replyType, String ext);

    InvocationFuture<Long> addQuickComment(IMMessage msg, long replyType, String ext, boolean needPush,
                                           boolean needBadge, String pushTitle, String pushContent,
                                           Map<String, Object> pushPayload);

    InvocationFuture<Void> removeQuickComment(IMMessage msg, long replyType, String ext);

    InvocationFuture<Long> removeQuickComment(IMMessage msg, long replyType, String ext, boolean needPush,
                                              boolean needBadge, String pushTitle, String pushContent,
                                              Map<String, Object> pushPayload);
    InvocationFuture<List<QuickCommentOptionWrapper>> queryQuickComment(List<IMMessage> msgList);

    InvocationFuture<CollectInfo> addCollect(int type, String date, String ext, String uniqueId);

    InvocationFuture<Integer> removeCollect(List<Pair<Long, Long>> collectInfo);

    InvocationFuture<CollectInfo> updateCollect(CollectInfo info, String ext);

    InvocationFuture<CollectInfo> updateCollect(long infoId, long createTime, String ext);

    InvocationFuture<CollectInfoPage> queryCollect(int limit);

    InvocationFuture<CollectInfoPage> queryCollect(CollectInfo anchor, long toTime, int limit, QueryDirectionEnum direction);

    InvocationFuture<CollectInfoPage> queryCollect(CollectInfo anchor, long toTime, int limit, QueryDirectionEnum direction, int type, boolean persist);

    InvocationFuture<Long> addMsgPin(IMMessage msg, String ext);

    InvocationFuture<Long> updateMsgPin(IMMessage msg, String ext);

    InvocationFuture<Long> removeMsgPin(IMMessage msg, String ext);

    InvocationFuture<MsgPinSyncResponseOptionWrapper> syncMsgPin(SessionTypeEnum sessionType, String sessionId, long timestamp);

    List<MsgPinDbOption> queryMsgPinBlock(String sessionId, SessionTypeEnum sessionType);

    InvocationFuture<StickTopSessionInfo> addStickTopSession(String sessionId, SessionTypeEnum sessionType, String ext);

    InvocationFuture<Void> removeStickTopSession(String sessionId, SessionTypeEnum sessionType, String ext);

    InvocationFuture<StickTopSessionInfo> updateStickTopSession(String sessionId, SessionTypeEnum sessionType, String ext);

    List<StickTopSessionInfo> queryStickTopSessionBlock();


    boolean isStickTopSession(String sessionId, SessionTypeEnum sessionType);

    void migrateMessages(String from, String to, boolean changeFrom);
}