QChatCreateChannelParam.java

浏览该文件的文档.

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

import androidx.annotation.NonNull;
import com.netease.nimlib.BuildConfig;
import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.qchat.enums.QChatChannelMode;
import com.netease.nimlib.sdk.qchat.enums.QChatChannelSyncMode;
import com.netease.nimlib.sdk.qchat.enums.QChatChannelType;
import com.netease.nimlib.sdk.qchat.enums.QChatVisitorMode;

/**
 * "创建Channel"接口入参
 */
public class QChatCreateChannelParam extends QChatAntiSpamConfigParam{

    private static final String TAG = "QChatCreateChannelParam";
    /**
     * 服务器id，必填
     */
    @NonNull
    private final Long serverId;
    /**
     * 名称，必填
     */
    @NonNull
    private final String name;
    /**
     * 频道类型，必填
     */
    @NonNull
    private final Integer type;
    /**
     * 主题
     */
    private String topic;
    /**
     * 自定义扩展
     */
    private String custom;

    /**
     * 查看模式
     */
    private QChatChannelMode viewMode;

    /**
     * 频道分组id
     */
    private Long categoryId;
    /**
     * 频道同步模式
     */
    private QChatChannelSyncMode    syncMode;

    /**
     * 游客可见模式
     */
    private QChatVisitorMode visitorMode;

    /**
     *
     * @param serverId 服务器id
     * @param name 名称
     * @param type 频道类型，类型QChatChannelType，如果设置大于CustomChannel(100)，请使用参数为int的重载方法
     */
    @SuppressWarnings("java:S2259")
    public QChatCreateChannelParam(long serverId, @NonNull String name, @NonNull QChatChannelType type) {
        if (type == null) {
            String error = String.format("QChatCreateChannelParam QChatChannelType is %s", type);
            if (BuildConfig.DEBUG) {
                throw new IllegalArgumentException(error);
            } else {
                NimLog.e(TAG, error);
            }
        }

        this.serverId = serverId;
        this.name = name;
        this.type = type.getValue();
    }

    /**
     *
     * @param serverId 服务器id
     * @param name 名称
     * @param customType 频道类型，类型int，可以设置大于CustomChannel(100)的自定义类型
     */
    private QChatCreateChannelParam(long serverId, @NonNull String name, int customType) {
        this.serverId = serverId;
        this.name = name;
        this.type = customType;
    }

    /**
     * 设置主题
     * @param topic
     */
    public void setTopic(String topic) {
        this.topic = topic;
    }

    /**
     * 设置自定义扩展
     * @param custom
     */
    public void setCustom(String custom) {
        this.custom = custom;
    }

    /**
     * 获取服务器ID
     * @return
     */
    @NonNull
    public Long getServerId() {
        return serverId;
    }

    /**
     * 获取名称
     * @return
     */
    @NonNull
    public String getName() {
        return name;
    }

    /**
     * 获取主题
     * @return
     */
    public String getTopic() {
        return topic;
    }

    /**
     * 获取自定义扩展
     * @return
     */
    public String getCustom() {
        return custom;
    }

    /**
     * 获取频道类型
     * @return
     */
    @NonNull
    public Integer getType() {
        return type;
    }

    /**
     * 获取频道查看模式
     * @return
     */
    public QChatChannelMode getViewMode() {
        return viewMode;
    }

    /**
     * 设置频道查看模式
     * @param viewMode
     */
    public void setViewMode(QChatChannelMode viewMode) {
        this.viewMode = viewMode;
    }

    /**
     * 获取频道分组Id
     * @return
     */
    public Long getCategoryId() {
        return categoryId;
    }

    /**
     * 设置频道分组Id
     * @param categoryId
     */
    public void setCategoryId(Long categoryId) {
        this.categoryId = categoryId;
    }

    /**
     * 获取同步模式
     * @return
     */
    public QChatChannelSyncMode getSyncMode() {
        return syncMode;
    }

    /**
     * 设置同步模式
     * @param syncMode
     */
    public void setSyncMode(QChatChannelSyncMode syncMode) {
        this.syncMode = syncMode;
    }

    /**
     * 获取游客可见模式
     * @return
     */
    public QChatVisitorMode getVisitorMode() {
        return visitorMode;
    }

    /**
     * 设置游客可见模式
     * @param visitorMode
     */
    public void setVisitorMode(QChatVisitorMode visitorMode) {
        this.visitorMode = visitorMode;
    }

}