QChatCreateServerParam.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 QChatCreateServerParam extends QChatAntiSpamConfigParam{

    /**
     * 名称，必填
     */
    @NonNull
    private final String              name;
    /**
     * 图标
     */
    private String icon;
    /**
     * 自定义扩展UserIdentifyTag
     */
    private String custom;
    /**
     * 邀请模式：AGREE_NEED(0)-邀请需要同意(默认),AGREE_NEED_NOT(1)-邀请不需要同意
     */
    @NonNull
    private QChatInviteMode inviteMode = QChatInviteMode.AGREE_NEED;
    /**
     * 申请模式：0-申请不需要同意(默认)，1-申请需要同意
     */
    @NonNull
    private       QChatApplyJoinMode  applyJoinMode = QChatApplyJoinMode.AGREE_NEED_NOT;

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

    /**
     * 服务器是否允许被搜索，1可以被搜索，0不可被搜索，默认允许
     */
    private boolean searchEnable = true;

    /**
     *
     * @param name 服务器名称
     */
    public QChatCreateServerParam(@NonNull String name) {
        this.name = name;
    }

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

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

    /**
     * 设置邀请模式
     * 邀请模式：AGREE_NEED(0)-邀请需要同意(默认),AGREE_NEED_NOT(1)-邀请不需要同意
     * @param inviteMode
     */
    public void setInviteMode(@NonNull QChatInviteMode inviteMode) {
        this.inviteMode = inviteMode;
    }

    /**
     * 设置申请模式
     * @param applyJoinMode
     */
    public void setApplyJoinMode(@NonNull QChatApplyJoinMode applyJoinMode) {
        this.applyJoinMode = applyJoinMode;
    }

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

    /**
     * 设置服务器是否允许被搜索
     */
    public void setSearchEnable(boolean searchEnable) {
        this.searchEnable = searchEnable;
    }

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

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

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

    /**
     * 获取邀请模式
     * @discuss 邀请模式：AGREE_NEED(0)-邀请需要同意(默认),AGREE_NEED_NOT(1)-邀请不需要同意
     * @return
     */
    @NonNull
    public QChatInviteMode getInviteMode() {
        return inviteMode;
    }

    /**
     * 获取申请模式
     * @return
     */
    @NonNull
    public QChatApplyJoinMode getApplyJoinMode() {
        return applyJoinMode;
    }

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

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