V2NIMChatroomService.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMMultiService;
import com.netease.nimlib.sdk.v2.V2NIMProgressCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.chatroom.config.V2NIMChatroomLocationConfig;
import com.netease.nimlib.sdk.v2.chatroom.model.V2NIMChatroomMember;
import com.netease.nimlib.sdk.v2.chatroom.model.V2NIMChatroomMessage;
import com.netease.nimlib.sdk.v2.chatroom.option.V2NIMChatroomMemberQueryOption;
import com.netease.nimlib.sdk.v2.chatroom.option.V2NIMChatroomMessageListOption;
import com.netease.nimlib.sdk.v2.chatroom.option.V2NIMChatroomTagMemberOption;
import com.netease.nimlib.sdk.v2.chatroom.option.V2NIMChatroomTagMessageOption;
import com.netease.nimlib.sdk.v2.chatroom.params.V2NIMChatroomMemberRoleUpdateParams;
import com.netease.nimlib.sdk.v2.chatroom.params.V2NIMChatroomSelfMemberUpdateParams;
import com.netease.nimlib.sdk.v2.chatroom.params.V2NIMChatroomTagTempChatBannedParams;
import com.netease.nimlib.sdk.v2.chatroom.params.V2NIMChatroomTagsUpdateParams;
import com.netease.nimlib.sdk.v2.chatroom.params.V2NIMChatroomUpdateParams;
import com.netease.nimlib.sdk.v2.chatroom.params.V2NIMSendChatroomMessageParams;
import com.netease.nimlib.sdk.v2.chatroom.result.V2NIMChatroomMemberListResult;
import com.netease.nimlib.sdk.v2.chatroom.result.V2NIMSendChatroomMessageResult;
import com.netease.nimlib.sdk.v2.common.V2NIMAntispamConfig;
import com.netease.nimlib.sdk.v2.message.V2NIMMessageCustomAttachmentParser;
import java.util.List;

/**
 * 聊天室服务接口
 */
public interface V2NIMChatroomService extends V2NIMMultiService {

    /**
     * 发送聊天室消息
     * @param message 需要发送的消息体
     * @param params 发送消息相关配置参数
     * @param success 发送成功回调
     * @param failure 发送失败回调
     * @param progress 发送进度回调
     */
    void sendMessage(V2NIMChatroomMessage message, V2NIMSendChatroomMessageParams params, V2NIMSuccessCallback<V2NIMSendChatroomMessageResult> success,
            V2NIMFailureCallback failure,
            V2NIMProgressCallback progress);

    /**
     * 取消聊天室消息附件上传
     * @param message
     * @param success
     * @param failure
     */
    void cancelMessageAttachmentUpload(V2NIMChatroomMessage message,V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 分页获取聊天室成员列表
     * @param queryOption 查询选项
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getMemberListByOption(V2NIMChatroomMemberQueryOption queryOption, V2NIMSuccessCallback<V2NIMChatroomMemberListResult> success,
            V2NIMFailureCallback failure);

    /**
     * 查询历史消息
     * @param option 查询参数
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getMessageList(V2NIMChatroomMessageListOption option, V2NIMSuccessCallback<List<V2NIMChatroomMessage>> success,
            V2NIMFailureCallback failure);

    /**
     * 更新聊天室成员角色
     * @param accountId 被操作的账号ID
     * @param updateParams 更新参数
     * @param success 成功回调
     * @param failure 失败回调
     */
    void updateMemberRole(String accountId, V2NIMChatroomMemberRoleUpdateParams updateParams, V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 设置聊天室成员黑名单状态
     * @param accountId 被操作的账号ID
     * @param blocked 黑名单状态
     * @param notificationExtension 本次操作生成的通知中的扩展字段
     * @param success 成功回调
     * @param failure 失败回调
     */
    void setMemberBlockedStatus(String accountId, boolean blocked,String notificationExtension, V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 设置成员禁言状态
     * @param accountId 被操作的账号ID
     * @param chatBanned 禁言状态
     * @param notificationExtension 本次操作生成的通知中的扩展字段
     * @param success 成功回调
     * @param failure 失败回调
     */
    void setMemberChatBannedStatus(String accountId, boolean chatBanned,String notificationExtension, V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 设置成员临时禁言状态
     * @param accountId 被操作的账号ID
     * @param tempChatBannedDuration 设置临时禁言时长，单位：秒，单次最大：30天，取消则设置为：0
     * @param notificationEnabled 是否需要发送广播通知，true：通知，false：不通知
     * @param notificationExtension 本次操作生成的通知中的扩展字段
     * @param success 成功回调
     * @param failure 失败回调
     */
    void setMemberTempChatBanned(String accountId, long tempChatBannedDuration,boolean notificationEnabled,String notificationExtension, V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 更新聊天室信息
     * @param updateParams 更新参数
     * @param antispamConfig 反垃圾配置
     * @param success 成功回调
     * @param failure 失败回调
     */
    void updateChatroomInfo(V2NIMChatroomUpdateParams updateParams, V2NIMAntispamConfig antispamConfig,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 更新聊天室信息
     * @param updateParams 更新参数
     * @param antispamConfig 反垃圾配置
     * @param success 成功回调
     * @param failure 失败回调
     */
    void updateSelfMemberInfo(V2NIMChatroomSelfMemberUpdateParams updateParams, V2NIMAntispamConfig antispamConfig,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 根据账号列表查询成员信息
     * @param accountIds 账号列表，为空或者size==0， 或者size>200 ， 返回参数错误
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getMemberByIds(List<String> accountIds, V2NIMSuccessCallback<List<V2NIMChatroomMember>> success,
            V2NIMFailureCallback failure);

    /**
     * 踢出聊天室成员
     * @param accountId 被踢的成员ID
     * @param notificationExtension 本次操作生成的通知中的扩展字段
     * @param success 成功回调
     * @param failure 失败回调
     */
    void kickMember(String accountId, String notificationExtension, V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 设置聊天室标签临时禁言
     * 只有管理员或创建者可以操作
     * @param params 设置标签禁言的参数
     * @param success 成功回调
     * @param failure 失败回调
     */
    void setTempChatBannedByTag(V2NIMChatroomTagTempChatBannedParams params, V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 根据tag查询群成员列表
     * @param option 根据tag查询成员的参数
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getMemberListByTag(V2NIMChatroomTagMemberOption option, V2NIMSuccessCallback<V2NIMChatroomMemberListResult> success,
            V2NIMFailureCallback failure);

    /**
     * 查询某个标签下的成员人数
     * @param tag 标签
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getMemberCountByTag(String tag, V2NIMSuccessCallback<Long> success,
            V2NIMFailureCallback failure);

    /**
     * 更新坐标信息
     * @param locationConfig 坐标信息
     * @param success 成功回调
     * @param failure 失败回调
     */
    void updateChatroomLocationInfo(V2NIMChatroomLocationConfig locationConfig, V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 更新聊天室tag信息
     * @param updateParams 更新参数
     * @param success 成功回调
     * @param failure 失败回调
     */
    void updateChatroomTags(V2NIMChatroomTagsUpdateParams updateParams, V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 根据标签查询消息列表
     * @param messageOption 查询参数
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getMessageListByTag(V2NIMChatroomTagMessageOption messageOption, V2NIMSuccessCallback<List<V2NIMChatroomMessage>> success,
            V2NIMFailureCallback failure);

    /**
     * 注册自定义消息附件解析器，解析自定义消息类型为100的附件
     * 后注册的解析器优先于先注册的解析器
     * @param parser 自定义消息附件解析器
     */
    void registerCustomAttachmentParser(V2NIMMessageCustomAttachmentParser parser);

    /**
     * 取消注册自定义消息附件解析器
     * @param parser 自定义消息附件解析器
     */
    void unregisterCustomAttachmentParser(V2NIMMessageCustomAttachmentParser parser);



    /**
     * 添加聊天室监听
     * @param listener 聊天室监听
     */
    void addChatroomListener(V2NIMChatroomListener listener);

    /**
     * 移除聊天室监听
     * @param listener 聊天室监听
     */
    void removeChatroomListener(V2NIMChatroomListener listener);

}