QChatServer.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.qchat.enums.QChatApplyJoinMode;
import com.netease.nimlib.sdk.qchat.enums.QChatInviteMode;
import java.io.Serializable;

/**
 * 服务器信息
 */
public interface QChatServer extends Serializable {

    /**
     * 获取服务器id
     * @return
     */
    long getServerId();

    /**
     * 获取名称
     * @return
     */
    String getName();

    /**
     * 获取图标
     * @return
     */
    String getIcon();

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

    /**
     * 获取所有者
     * @return
     */
    String getOwner();

    /**
     * 获取成员数
     * @return
     */
    int getMemberNumber();

    /**
     * 获取邀请模式：0-邀请需要同意(默认),1-邀请不需要同意
     * @return
     */
    QChatInviteMode getInviteMode();

    /**
     * 获取申请模式：0-申请不需要同意(默认)，1-申请需要同意
     * @return
     */
    QChatApplyJoinMode getApplyMode();

    /**
     * 获取有效标志：false-无效，true-有效
     * @return
     */
    boolean isValid();

    /**
     * 获取创建时间
     * @return
     */
    long getCreateTime();

    /**
     * 获取更新时间
     * @return
     */
    long getUpdateTime();

    /**
     * 设置名称
     * @param name 名称
     */
    void setName(String name);

    /**
     * 设置图标
     * @param icon 图标
     */
    void setIcon(String icon);

    /**
     * 设置自定义扩展
     * @param custom 自定义扩展
     */
    void setCustom(String custom);

    /**
     * 设置邀请模式
     * @param inviteMode 邀请模式：0-邀请需要同意(默认),1-邀请不需要同意
     */
    void setInviteMode(QChatInviteMode inviteMode);

    /**
     * 设置申请模式
     * @param applyMode 申请模式：0-申请不需要同意(默认)，1-申请需要同意
     */
    void setApplyMode(QChatApplyJoinMode applyMode);

    /**
     * 设置有效标志
     * @param valid 有效标志：false-无效，true-有效
     */
    void setValid(boolean valid);

    /**
     * 获取频道数
     * @return
     */
    int getChannelNum();

    /**
     * 获取频道类别数
     * @return
     */
    int getChannelCategoryNum();

    /**
     * 获取服务器搜索类型
     */
    Integer getSearchType();

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

    /**
     * 获取服务器是否允许被搜索
     */
    boolean getSearchEnable();

    /**
     * 设置服务器是否允许被搜索
     */
    void setSearchEnable(boolean searchEnable);

    /**
     * 获取自定义排序权重值
     * @return
     */
    Long getReorderWeight();
}