QChatChannel.java

浏览该文件的文档.

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

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;
import java.io.Serializable;

/**
 * 频道信息
 */
public interface QChatChannel extends Serializable {
    /**
     * 获取频道id
     * @return
     */
    long getChannelId();
    /**
     * 获取服务器id
     * @return
     */
    long getServerId();
    /**
     * 获取名称
     * @return
     */
    String getName();
    /**
     * 获取主题
     * @return
     */
    String getTopic();
    /**
     * 获取自定义扩展
     * @return
     */
    String getCustom();
    /**
     * 获取Channel类型
     * @return
     */
    QChatChannelType getType();

    /**
     * 是否有效
     * @return
     */
    boolean isValid();
    /**
     * 获取创建时间
     * @return
     */
    long getCreateTime();
    /**
     * 获取更新时间
     * @return
     */
    long getUpdateTime();

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

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

    /**
     * 设置主题
     * @param topic 主题
     */
    void setTopic(String topic);

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

    /**
     * 设置Channel类型
     * @param type QChatChannelType
     */
    void setType(QChatChannelType type);


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

    /**
     * 获取查看模式
     * @return 查看模式
     */
    QChatChannelMode getViewMode();

    /**
     * 设置查看模式
     * @param viewMode 查看模式
     */
    void setViewMode(QChatChannelMode viewMode);

    /**
     * 获取频道分组Id
     * @return
     */
    Long getCategoryId();
    /**
     * 获取同步模式
     * @return
     */
    QChatChannelSyncMode getSyncMode();

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

    /**
     * 获取游客
     * @return
     */
    QChatVisitorMode getVisitorMode();
}