QChatMessageService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat;

import androidx.annotation.NonNull;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.AbortableFuture;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.qchat.model.QChatMessageCache;
import com.netease.nimlib.sdk.qchat.param.QChatAddQuickCommentParam;
import com.netease.nimlib.sdk.qchat.param.QChatAreMentionedMeMessagesParam;
import com.netease.nimlib.sdk.qchat.param.QChatDeleteMessageParam;
import com.netease.nimlib.sdk.qchat.param.QChatDownloadAttachmentParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetCommentatorsParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetLastMessageOfChannelsParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetMentionedMeMessagesParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetMessageHistoryByIdsParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetMessageHistoryParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetMessageThreadInfosParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetQuickCommentsParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetReferMessagesParam;
import com.netease.nimlib.sdk.qchat.param.QChatGetThreadMessagesParam;
import com.netease.nimlib.sdk.qchat.param.QChatMarkMessageReadParam;
import com.netease.nimlib.sdk.qchat.param.QChatMarkSystemNotificationsReadParam;
import com.netease.nimlib.sdk.qchat.param.QChatRemoveQuickCommentParam;
import com.netease.nimlib.sdk.qchat.param.QChatReplyMessageParam;
import com.netease.nimlib.sdk.qchat.param.QChatResendMessageParam;
import com.netease.nimlib.sdk.qchat.param.QChatResendSystemNotificationParam;
import com.netease.nimlib.sdk.qchat.param.QChatRevokeMessageParam;
import com.netease.nimlib.sdk.qchat.param.QChatSearchMsgByPageParam;
import com.netease.nimlib.sdk.qchat.param.QChatSendMessageParam;
import com.netease.nimlib.sdk.qchat.param.QChatSendSystemNotificationParam;
import com.netease.nimlib.sdk.qchat.param.QChatSendTypingEventParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateMessageParam;
import com.netease.nimlib.sdk.qchat.param.QChatUpdateSystemNotificationParam;
import com.netease.nimlib.sdk.qchat.result.QChatAreMentionedMeMessagesResult;
import com.netease.nimlib.sdk.qchat.result.QChatDeleteMessageResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetCommentatorsResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetLastMessageOfChannelsResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetMentionedMeMessagesResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetMessageHistoryResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetMessageThreadInfosResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetQuickCommentsResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetReferMessagesResult;
import com.netease.nimlib.sdk.qchat.result.QChatGetThreadMessagesResult;
import com.netease.nimlib.sdk.qchat.result.QChatRevokeMessageResult;
import com.netease.nimlib.sdk.qchat.result.QChatSearchMsgByPageResult;
import com.netease.nimlib.sdk.qchat.result.QChatSendMessageResult;
import com.netease.nimlib.sdk.qchat.result.QChatSendSystemNotificationResult;
import com.netease.nimlib.sdk.qchat.result.QChatSendTypingEventResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateMessageResult;
import com.netease.nimlib.sdk.qchat.result.QChatUpdateSystemNotificationResult;

import java.util.List;

@NIMService("圈组消息服务")
public interface QChatMessageService {

    /**
     * 发送消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回发送成功的消息
     */
    InvocationFuture<QChatSendMessageResult> sendMessage(@NonNull QChatSendMessageParam param);

    /**
     * 回复消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回发送成功的消息
     */
    InvocationFuture<QChatSendMessageResult> replyMessage(@NonNull QChatReplyMessageParam param);

    /**
     * 重发消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回发送成功的消息
     */
    InvocationFuture<QChatSendMessageResult> resendMessage(@NonNull QChatResendMessageParam param);

    /**
     * 默认情况下（SDKOPtions#preloadAttach为true），SDK收到多媒体消息后，图片和视频会自动下载缩略图，音频会自动下载文件。如果下载原图或者原视频等，可调用该接口下载附件
     *
     * @param param
     * @return AbortableFuture 调用跟踪。可设置回调函数，可中止下载操作
     */
    AbortableFuture<Void> downloadAttachment(QChatDownloadAttachmentParam param);

    /**
     * 查询历史消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的历史消息
     */
    InvocationFuture<QChatGetMessageHistoryResult> getMessageHistory(@NonNull QChatGetMessageHistoryParam param);

    /**
     * 更新消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回更新成功的消息
     */
    InvocationFuture<QChatUpdateMessageResult> updateMessage(@NonNull QChatUpdateMessageParam param);

    /**
     * 撤回消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回撤回成功的消息
     */
    InvocationFuture<QChatRevokeMessageResult> revokeMessage(@NonNull QChatRevokeMessageParam param);

    /**
     * 删除消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回删除成功的消息
     */
    InvocationFuture<QChatDeleteMessageResult> deleteMessage(@NonNull QChatDeleteMessageParam param);

    /**
     * 标记消息已读，该接口存在频控，300ms内只能调用1次
     *
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> markMessageRead(@NonNull QChatMarkMessageReadParam param);

    /**
     * 发送系统通知
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回发送成功的自定义系统通知
     */
    InvocationFuture<QChatSendSystemNotificationResult> sendSystemNotification(@NonNull QChatSendSystemNotificationParam param);

    /**
     * 重发系统通知
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回发送成功的自定义系统通知
     */
    InvocationFuture<QChatSendSystemNotificationResult> resendSystemNotification(@NonNull QChatResendSystemNotificationParam param);

    /**
     * 更新系统通知,除了更新自定义系统通知外，还允许更新邀请服务器成员、拒绝邀请、申请加入服务器、拒绝申请这几种内置系统通知
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调中返回更新成功的系统通知
     */
    InvocationFuture<QChatUpdateSystemNotificationResult> updateSystemNotification(@NonNull QChatUpdateSystemNotificationParam param);

    /**
     * 标记系统通知已读
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。
     */
    InvocationFuture<Void> markSystemNotificationsRead(@NonNull QChatMarkSystemNotificationsReadParam param);

    /**
     * 清除消息通知栏
     */
    void clearMsgNotify();

    /**
     * 根据消息id查询历史消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的历史消息
     */
    InvocationFuture<QChatGetMessageHistoryResult> getMessageHistoryByIds(@NonNull QChatGetMessageHistoryByIdsParam param);

    /**
     * 根据消息查询被引用的消息详情
     * @param param
     * @return
     */
    InvocationFuture<QChatGetReferMessagesResult> getReferMessages(@NonNull QChatGetReferMessagesParam param);
    /**
     * 查询thread聊天的历史
     * @param param
     * @return
     */
    InvocationFuture<QChatGetThreadMessagesResult> getThreadMessages(@NonNull QChatGetThreadMessagesParam param);

    /**
     * 批量查询thread聊天信息
     * @param param
     * @return
     */
    InvocationFuture<QChatGetMessageThreadInfosResult> getMessageThreadInfos(@NonNull QChatGetMessageThreadInfosParam param);

    /**
     * 添加一条快捷评论
     * @param param
     * @return
     */
    InvocationFuture<Void> addQuickComment(@NonNull QChatAddQuickCommentParam param);

    /**
     * 删除一条快捷评论
     * @param param
     * @return
     */
    InvocationFuture<Void> removeQuickComment(@NonNull QChatRemoveQuickCommentParam param);

    /**
     * 批量查询快捷评论
     * @param param
     * @return
     */
    InvocationFuture<QChatGetQuickCommentsResult> getQuickComments(@NonNull QChatGetQuickCommentsParam param);

    /**
     * 查询快捷评论消息的评论者列表
     *
     * @param param 查询参数，详见{@link QChatGetCommentatorsParam}
     * @return 评论者列表查询结果，详见{@link QChatGetCommentatorsResult}
     */
    InvocationFuture<QChatGetCommentatorsResult> getCommentators(@NonNull QChatGetCommentatorsParam param);

    /**
     * 指定通道查询消息缓存
     *
     * @param qchatChannelId 圈组通道名
     * @return 缓存消息
     */
    InvocationFuture<List<QChatMessageCache>> getMessageCache(long qchatServerId, long qchatChannelId);

    /**
     * 指定通道查询消息缓存（同步接口）
     *
     * @param qchatChannelId 圈组通道名
     * @return 缓存消息
     */
    List<QChatMessageCache> getMessageCacheBlock(long qchatServerId, long qchatChannelId);

    /**
     * 清空消息缓存
     */
    void clearMessageCache();

    /**
     * 发送消息正在输入事件
     * 接收方需要调用订阅指定频道事件订阅正在输入事件后后才能就可以收到指定频道的正在输入事件
     * @param param
     * @return
     */
    InvocationFuture<QChatSendTypingEventResult> sendTypingEvent(QChatSendTypingEventParam param);


    /**
     * 查询频道的最后一条消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的历史消息
     */
    InvocationFuture<QChatGetLastMessageOfChannelsResult> getLastMessageOfChannels(@NonNull QChatGetLastMessageOfChannelsParam param);

    /**
     * 检索消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的消息列表
     */
    InvocationFuture<QChatSearchMsgByPageResult> searchMsgByPage(@NonNull QChatSearchMsgByPageParam param);

    /**
     * 分页查询指定频道@我的消息
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回查询到的消息列表
     */
    InvocationFuture<QChatGetMentionedMeMessagesResult> getMentionedMeMessages(@NonNull QChatGetMentionedMeMessagesParam param);

    /**
     * 批量查询消息是否@当前用户
     * @param param
     * @return InvocationFuture 可设置回调函数，监听操作结果。回调返回消息是否@当前用户结果
     */
    InvocationFuture<QChatAreMentionedMeMessagesResult> areMentionedMeMessages(@NonNull QChatAreMentionedMeMessagesParam param);

    /**
     * 增加一条数据，如果该频道下已经存在数据，则被新数据覆盖。
     *
     * @param serverId 服务器Id
     * @param channelId 频道Id
     * @param value 最大长度为10000
     *
     * @return boolean
     *  true：成功添加或者替换
     *  false：其它
     */
    boolean insertOrReplaceTextCache(long serverId, long channelId, @NonNull String value);

    /**
     * 删除数据。
     *  serverId > 0 && channelId > 0：删除指定频道的数据
     *  serverId > 0 && channelId == 0：删除指定服务器下所有频道的数据
     *  serverId == 0 && channelId > 0：返回失败
     *  serverId == 0 && channelId == 0：清空数据
     *
     * @param serverId 服务器Id
     * @param channelId 频道Id
     *
     * @return boolean
     *  true：完成执行删除操作
     *  false：其它
     */
    boolean deleteTextCache(long serverId, long channelId);


    /**
     * 批量查询消息是否@当前用户
     *
     * @param serverId 服务器Id
     * @param channelId 频道Id
     *
     * @return String
     */
    String getTextCache(long serverId, long channelId);
}