QChatSubscribeChannelParam.java

浏览该文件的文档.

package com.netease.nimlib.sdk.qchat.param;

import android.util.Log;

import androidx.annotation.NonNull;

import com.netease.nimlib.BuildConfig;
import com.netease.nimlib.log.model.LogDesensitizationConfigHelper;
import com.netease.nimlib.sdk.qchat.enums.QChatSubscribeOperateType;
import com.netease.nimlib.sdk.qchat.enums.QChatSubscribeType;
import com.netease.nimlib.sdk.qchat.model.QChatChannelIdInfo;

import java.util.ArrayList;
import java.util.List;

/**
 * "订阅频道"接口入参
 */
public class QChatSubscribeChannelParam {

    private static final String TAG = "SubscribeChannelParam";
    /**
     * 请求参数，订阅类型，见QChatSubType
     */
    @NonNull
    private final QChatSubscribeType type;
    /**
     * 请求参数，操作类型，见QChatSubOperateType
     */
    @NonNull
    private final QChatSubscribeOperateType operateType;
    /**
     * 请求参数，操作的对象：channelInfo列表
     */
    @NonNull
    private final List<QChatChannelIdInfo> channelIdInfos;

    /**
     *
     * @param type 订阅类型
     * @param operateType 操作类型
     * @param channelIdInfos 操作的对象, channelInfo列表
     */
    public QChatSubscribeChannelParam(@NonNull QChatSubscribeType type, @NonNull QChatSubscribeOperateType operateType, @NonNull List<QChatChannelIdInfo> channelIdInfos) {
        if (!QChatSubscribeType.isIllegalChannelSubType(type.getValue())) {
            String error = String.format("QChatSubType(%s) is Illegal", type);
            if (BuildConfig.DEBUG) {
                throw new IllegalArgumentException(error);
            } else if (LogDesensitizationConfigHelper.printToLogcat()) {
                Log.e(TAG, error);
            }
        }

        this.type = type;
        this.operateType = operateType;
        this.channelIdInfos = new ArrayList<>(channelIdInfos);
    }

    /**
     * 获取订阅类型
     */
    @NonNull
    public QChatSubscribeType getType() {
        return type;
    }

    /**
     * 获取操作类型
     */
    @NonNull
    public QChatSubscribeOperateType getOperateType() {
        return operateType;
    }

    /**
     * 获取操作的对象：channelInfo列表
     */
    @NonNull
    public List<QChatChannelIdInfo> getChannelIdInfos() {
        return channelIdInfos;
    }
}