QChatChannelMuteParam.java

浏览该文件的文档.

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

import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.qchat.enums.QChatMuteNotifyScope;
import com.netease.nimlib.sdk.qchat.enums.QChatMuteOperateType;
import java.util.List;

/**
 * "禁言频道成员"接口参数
 */
public class QChatChannelMuteParam {

    private static final String TAG = "QChatChannelMuteParam";

    /**
     * 服务器id
     */
    private long serverId;

    /**
     * 频道id
     */
    private long channelId;

    /**
     * 操作类型。可填写禁言和解禁填写自动解禁或者其他值报参数错误
     */
    private QChatMuteOperateType operateType;

    /**
     * 禁言成员列表
     */
    private List<String> muteAccountIds;

    /**
     * 禁言持续时长 单位：秒。大于0合法
     */
    private long duration;

    /**
     * 附言
     */
    private String postscript;

    /**
     * 通知类型。包括只通知被禁言者和全部通知
     */
    private QChatMuteNotifyScope notifyType;

    private QChatChannelMuteParam() {
        this.serverId = 0;
        this.channelId = 0;
        this.operateType = null;
        this.muteAccountIds = null;
        this.duration = 0;
    }

    /**
     *
     * @param serverId 服务器id
     * @param channelId 频道id
     * @param operateType 操作类型
     * @param muteAccountIds 禁言成员列表
     * @param duration 禁言持续时长 单位：秒
     */
    public QChatChannelMuteParam(long serverId, long channelId, QChatMuteOperateType operateType, List<String> muteAccountIds, long duration) {
        this.serverId = serverId;
        this.channelId = channelId;
        this.operateType = operateType;
        this.muteAccountIds = muteAccountIds;
        this.duration = duration;
    }

    /**
     *
     * @param serverId 服务器id
     * @param channelId 频道id
     * @param operateType 操作类型
     * @param muteAccountIds 禁言成员列表
     * @param duration 禁言持续时长 单位：秒
     * @param postscript 附言
     * @param notifyType 通知类型
     */
    public QChatChannelMuteParam(long serverId, long channelId, QChatMuteOperateType operateType, List<String> muteAccountIds, long duration, String postscript, QChatMuteNotifyScope notifyType) {
        this.serverId = serverId;
        this.channelId = channelId;
        this.operateType = operateType;
        this.muteAccountIds = muteAccountIds;
        this.duration = duration;
        this.postscript = postscript;
        this.notifyType = notifyType;
    }

    /**
     * 获取服务器id
     *
     * @return 服务器id
     */
    public long getServerId() {
        return serverId;
    }

    /**
     * 设置服务器id
     *
     * @param serverId 服务器id
     */
    public void setServerId(long serverId) {
        this.serverId = serverId;
    }

    /**
     * 获取频道id
     *
     * @return 频道id
     */
    public long getChannelId() {
        return channelId;
    }

    /**
     * 设置频道id
     *
     * @param channelId 频道id
     */
    public void setChannelId(long channelId) {
        this.channelId = channelId;
    }

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

    /**
     * 设置操作类型
     *
     * @param operateType 操作类型
     */
    public void setOperateType(QChatMuteOperateType operateType) {
        this.operateType = operateType;
    }

    /**
     * 获取禁言成员列表
     *
     * @return 禁言成员列表
     */
    public List<String> getMuteAccountIds() {
        return muteAccountIds;
    }

    /**
     * 设置禁言成员列表
     *
     * @param muteAccountIds 禁言成员列表
     */
    public void setMuteAccountIds(List<String> muteAccountIds) {
        this.muteAccountIds = muteAccountIds;
    }

    /**
     * 获取禁言持续时长
     *
     * @return 禁言持续时长
     */
    public long getDuration() {
        return duration;
    }

    /**
     * 设置禁言持续时长
     *
     * @param duration 禁言持续时长
     */
    public void setDuration(long duration) {
        this.duration = duration;
    }

    /**
     * 获取附言
     *
     * @return 附言
     */
    public String getPostscript() {
        return postscript;
    }

    /**
     * 设置附言
     *
     * @param postscript 附言
     */
    public void setPostscript(String postscript) {
        this.postscript = postscript;
    }

    /**
     * 获取通知类型
     *
     * @return 通知类型
     */
    public QChatMuteNotifyScope getNotifyType() {
        return notifyType;
    }

    /**
     * 设置通知类型
     *
     * @param notifyType 通知类型
     */
    public void setNotifyType(QChatMuteNotifyScope notifyType) {
        this.notifyType = notifyType;
    }

    /**
     * 判断参数是否合法
     * @return 参数是否合法
     */
    public boolean isValid() {
        if(serverId <=0) {
            NimLog.e(TAG, "serverId is invalid");
            return false;
        }
        if(channelId <= 0) {
            NimLog.e(TAG, "channelId is invalid");
            return false;
        }
        if(operateType == null) {
            NimLog.e(TAG, "operateType is invalid");
            return false;
        }
        if(muteAccountIds == null || muteAccountIds.isEmpty()) {
            NimLog.e(TAG, "muteAccountIds is invalid");
            return false;
        }
        if(duration <= 0) {
            NimLog.e(TAG, "duration is invalid");
            return false;
        }
        return true;
    }
}