QChatUpdateServerParam.java

浏览该文件的文档.

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

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;

import com.netease.nimlib.sdk.qchat.enums.QChatApplyJoinMode;
import com.netease.nimlib.sdk.qchat.enums.QChatInviteMode;

/**
 * "修改服务器信息"接口入参
 */
public class QChatUpdateServerParam extends QChatAntiSpamConfigParam{

    /**
     * 将要修改的服务器Id，必填
     */
    @NonNull
    private final Long            serverId;
    /**
     * 名称
     */
    private String     name;
    /**
     * 图标
     */
    private String icon;
    /**
     * 自定义扩展
     */
    private       String          custom;
    /**
     * 邀请模式：0-邀请需要同意(默认),1-邀请不需要同意
     */
    private QChatInviteMode    inviteMode;
    /**
     * 申请模式：0-申请不需要同意(默认)，1-申请需要同意
     */
    private QChatApplyJoinMode applyMode;

    /**
     * 服务器搜索类型，客户自定义：比如服务器行业类型等,大于0的正整数
     */
    @Nullable
    private Integer searchType;

    /**
     * 服务器是否允许被搜索，1可以被搜索，0不可被搜索，默认允许
     */
    @Nullable
    private Boolean searchEnable;

    /**
     *
     * @param serverId 将要修改的服务器Id，通过该Id可以确定将要被修改的服务器
     *                 通过setter方法修改字段内容，至少有一个字段需要被修改
     */
    public QChatUpdateServerParam(long serverId) {
        this.serverId = serverId;
    }

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

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

    /**
     * 设置服务器名称
     * @param name
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * 获取服务器图标url
     * @return
     */
    public String getIcon() {
        return icon;
    }

    /**
     * 设置服务器图标url
     * @param icon
     */
    public void setIcon(String icon) {
        this.icon = icon;
    }

    /**
     * 设置服务器自定义扩展
     * @return
     */
    public String getCustom() {
        return custom;
    }

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

    /**
     * 获取邀请加入服务器模式
     * @return
     */
    public QChatInviteMode getInviteMode() {
        return inviteMode;
    }

    /**
     * 设置邀请加入服务器模式
     * @param inviteMode
     */
    public void setInviteMode(QChatInviteMode inviteMode) {
        this.inviteMode = inviteMode;
    }

    /**
     * 获取申请加入服务器模式
     * @return
     */
    public QChatApplyJoinMode getApplyMode() {
        return applyMode;
    }

    /**
     * 设置申请加入服务器模式
     * @param applyMode
     */
    public void setApplyMode(QChatApplyJoinMode applyMode) {
        this.applyMode = applyMode;
    }

    /**
     * 获取服务器搜索类型
     */
    @Nullable
    public Integer getSearchType() {
        return searchType;
    }

    /**
     * 设置服务器搜索类型
     * @param searchType 客户自定义：比如服务器行业类型等,大于0的正整数，null表示不修改
     */
    public void setSearchType(@Nullable Integer searchType) {
        this.searchType = searchType;
    }

    /**
     * 获取服务器是否允许被搜索
     */
    @Nullable
    public Boolean getSearchEnable() {
        return searchEnable;
    }

    /**
     * 设置服务器是否允许被搜索
     * @param searchEnable null表示不修改
     */
    public void setSearchEnable(@Nullable Boolean searchEnable) {
        this.searchEnable = searchEnable;
    }
}