V2NIMTopicService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.topic;

import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMProgressCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.message.V2NIMMessage;
import com.netease.nimlib.sdk.v2.message.params.V2NIMSendMessageParams;
import com.netease.nimlib.sdk.v2.message.result.V2NIMSendMessageResult;
import com.netease.nimlib.sdk.v2.topic.option.V2NIMTopicListOption;
import com.netease.nimlib.sdk.v2.topic.option.V2NIMTopicMessageListOption;
import com.netease.nimlib.sdk.v2.topic.params.V2NIMRemoveTopicsParams;
import com.netease.nimlib.sdk.v2.topic.params.V2NIMSendTopicMessageParams;
import com.netease.nimlib.sdk.v2.topic.params.V2NIMUpdateTopicParams;
import com.netease.nimlib.sdk.v2.topic.result.V2NIMTopicListResult;
import com.netease.nimlib.sdk.v2.topic.result.V2NIMTopicMessageListResult;

/**
 * Topic 服务。
 *
 * <p>提供 Topic 管理、Topic 消息发送以及 Topic 消息查询能力。</p>
 */
public interface V2NIMTopicService {
    /**
     * 批量移除 Topic。
     *
     * @param params 删除参数；当前仅支持批量删除同一会话下的 Topic
     * @param success 删除成功回调
     * @param failure 删除失败回调
     */
    void removeTopics(V2NIMRemoveTopicsParams params, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 更新 Topic。
     *
     * @param params 更新参数
     * @param success 更新成功回调，返回更新后的 Topic
     * @param failure 更新失败回调
     */
    void updateTopic(V2NIMUpdateTopicParams params, V2NIMSuccessCallback<V2NIMTopic> success, V2NIMFailureCallback failure);

    /**
     * 发送 Topic 消息。topic 为空时先创建 Topic 再发送。
     *
     * <p>创建 Topic 并发送成功后，如需获取新建 Topic 的完整信息，可基于返回结果中的消息调用
     * {@link #getTopicByRefer(V2NIMTopicRefer, V2NIMSuccessCallback, V2NIMFailureCallback)}。</p>
     *
     * @param message 待发送消息
     * @param conversationId 目标会话 ID
     * @param topic 目标 Topic；传空时先创建 Topic
     * @param params Topic 消息发送参数
     * @param success 发送成功回调，返回发送结果
     * @param failure 发送失败回调
     * @param progress 发送进度回调
     */
    void sendTopicMessage(V2NIMMessage message, String conversationId, V2NIMTopic topic, V2NIMSendTopicMessageParams params,
        V2NIMSuccessCallback<V2NIMSendMessageResult> success, V2NIMFailureCallback failure, V2NIMProgressCallback progress);

    /**
     * 回复一条 Topic 消息。
     *
     * @param message 待发送消息
     * @param replyMessage 被回复的 Topic 消息
     * @param topic 目标 Topic
     * @param params 消息发送参数
     * @param success 回复成功回调，返回发送结果
     * @param failure 回复失败回调
     * @param progress 发送进度回调
     */
    void replyTopicMessage(V2NIMMessage message, V2NIMMessage replyMessage, V2NIMTopic topic, V2NIMSendMessageParams params,
        V2NIMSuccessCallback<V2NIMSendMessageResult> success, V2NIMFailureCallback failure, V2NIMProgressCallback progress);

    /**
     * 通过 Topic 引用查询 Topic 信息。
     *
     * <p>SDK 优先使用引用信息查询本地数据库，未命中时再回退到服务端查询 Topic 详情。</p>
     *
     * @param topicRefer Topic 引用
     * @param success 查询成功回调，返回 Topic 信息
     * @param failure 查询失败回调
     */
    void getTopicByRefer(V2NIMTopicRefer topicRefer, V2NIMSuccessCallback<V2NIMTopic> success, V2NIMFailureCallback failure);

    /**
     * 分页查询 Topic 列表。
     *
     * @param option 查询参数
     * @param success 查询成功回调，返回 Topic 列表结果
     * @param failure 查询失败回调
     */
    void getTopicListByOption(V2NIMTopicListOption option, V2NIMSuccessCallback<V2NIMTopicListResult> success, V2NIMFailureCallback failure);

    /**
     * 查询 Topic 消息列表。
     *
     * @param option 查询参数
     * @param success 查询成功回调，返回 Topic 消息列表结果
     * @param failure 查询失败回调
     */
    void getTopicMessageList(V2NIMTopicMessageListOption option, V2NIMSuccessCallback<V2NIMTopicMessageListResult> success, V2NIMFailureCallback failure);

    /**
     * 注册 Topic 事件监听器。
     *
     * @param listener Topic 事件监听器
     */
    void addTopicListener(V2NIMTopicListener listener);

    /**
     * 移除 Topic 事件监听器。
     *
     * @param listener Topic 事件监听器
     */
    void removeTopicListener(V2NIMTopicListener listener);
}