ChatRoomInfo.java

浏览该文件的文档.

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

import android.os.Parcel;
import android.os.Parcelable;
import com.netease.nimlib.session.MsgHelper;
import java.io.Serializable;
import java.util.Map;

/**
 * 聊天室信息
 */
public class ChatRoomInfo implements Serializable, Parcelable {
    private String roomId;       // roomId
    private String name;         // 聊天室名称
    private String announcement; // 聊天室公告
    private String broadcastUrl; // 视频直播拉流地址
    private String creator;      // 聊天室创建者账号
    private int validFlag;       // 聊天室有效标记, 1:有效,0:无效
    private int onlineUserCount; // 当前在线用户数量
    private int mute;            // 聊天室禁言标记
    private Map<String, Object> extension;  // 第三方扩展字段, 长度4k
    private String extensionStr;          // 第三方扩展字段, 长度4k
    private int queueLevel; // 队列管理权限，如是否有权限提交他人key和信息到队列中。

    public ChatRoomInfo() {
    }

    /**
     * 获取聊天室id
     * @return 聊天室id
     */
    public String getRoomId() {
        return roomId;
    }

    /**
     * 获取聊天室名称
     * @return 聊天室名称
     */
    public String getName() {
        return name;
    }

    /**
     * 获取聊天室公告
     * @return 聊天室公告
     */
    public String getAnnouncement() {
        return announcement;
    }

    /**
     * 获取聊天室拉流地址
     * @return 聊天室拉流地址
     */
    public String getBroadcastUrl() {
        return broadcastUrl;
    }

    /**
     * 获取聊天室创建者帐号
     * @return 创建者帐号
     */
    public String getCreator() {
        return creator;
    }

    /**
     * 获取聊天室有效标记
     * @return 是否有效
     */
    public boolean isValid() {
        return validFlag == 1;
    }

    /**
     * 获取聊天室扩展字段
     * @return 扩展字段
     */
    public Map<String, Object> getExtension() {
        return extension;
    }

/**
     * 获取聊天室扩展字段
     * @return 扩展字段
     */
    public String getExtensionStr() {
        return extensionStr;
    }

    /**
     * 获取当前在线用户数量
     * @return 当前在线用户数量
     */
    public int getOnlineUserCount() {
        return onlineUserCount;
    }

    /**
     * 获取当前聊天室禁言状态
     * @return 当前聊天室禁言状态
     */
    public boolean isMute() {
        return mute == 0x01;
    }

    /**
     * 设置聊天室id
     * @param roomId 聊天室id
     */
    public void setRoomId(String roomId) {
        this.roomId = roomId;
    }

    /**
     * 设置聊天室名称
     * @param name 聊天室名称
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * 设置聊天室公告
     * @param announcement 聊天室公告
     */
    public void setAnnouncement(String announcement) {
        this.announcement = announcement;
    }

    /**
     * 设置聊天室直播拉流地址
     * @param broadcastUrl 直播拉流地址
     */
    public void setBroadcastUrl(String broadcastUrl) {
        this.broadcastUrl = broadcastUrl;
    }

    /**
     * 设置聊天室创建者
     * @param creator
     */
    public void setCreator(String creator) {
        this.creator = creator;
    }

    /**
     * 设置聊天室有效标记
     * @param validFlag 聊天室有效标记
     */
    public void setValidFlag(int validFlag) {
        this.validFlag = validFlag;
    }

    /**
     * 设置扩展字段
     * @param extension 扩展字段
     */
    public void setExtension(Map<String, Object> extension) {
        this.extension = extension;
    }

/**
     * 设置扩展字段
     * @param extension 扩展字段
     */
    public void setExtensionStr(String extensionStr) {
        this.extensionStr = extensionStr;
        this.extension = MsgHelper.getMapFromJsonString(extensionStr);
    }

    /**
     * 设置当前在线用户数量
     * @param onlineUserCount 在线用户数量
     */
    public void setOnlineUserCount(int onlineUserCount) {
        this.onlineUserCount = onlineUserCount;
    }

    /**
     * 设置当前聊天室禁言状态
     * @param mute 聊天室禁言状态
     */
    public void setMute(int mute) {
        this.mute = mute;
    }

    /**
     * 设置队列权限，如是否有权限提交他人key和信息到队列中
     * 0 表示所有人都有权限，1 表示只有主播/管理员有权限
     * @param queueLevel
     */
    public void setQueueLevel(int queueLevel) {
        this.queueLevel = queueLevel;
    }

    /**
     * 获取队列权限配置
     * @return
     */
    public int getQueueLevel() {
        return queueLevel;
    }

    /**
     * ********************************** 序列化 **********************************
     */
    protected ChatRoomInfo(Parcel in) {
        roomId = in.readString();
        name = in.readString();
        announcement = in.readString();
        broadcastUrl = in.readString();
        creator = in.readString();
        validFlag = in.readInt();
        onlineUserCount = in.readInt();
        setExtensionStr(in.readString());
        mute = in.readInt();
        queueLevel = in.readInt();
    }

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeString(roomId);
        dest.writeString(name);
        dest.writeString(announcement);
        dest.writeString(broadcastUrl);
        dest.writeString(creator);
        dest.writeInt(validFlag);
        dest.writeInt(onlineUserCount);
        dest.writeString(extensionStr);
        dest.writeInt(mute);
        dest.writeInt(queueLevel);
    }

    public static final Creator<ChatRoomInfo> CREATOR = new Creator<ChatRoomInfo>() {
        @Override
        public ChatRoomInfo createFromParcel(Parcel in) {
            return new ChatRoomInfo(in);
        }

        @Override
        public ChatRoomInfo[] newArray(int size) {
            return new ChatRoomInfo[size];
        }
    };
}