ChatRoomMember.java

浏览该文件的文档.

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

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

/**
 * 聊天室成员信息
 */
public class ChatRoomMember implements Serializable,Parcelable {
    private String roomId;      // 聊天室id
    private String account;     // 成员账号
    private MemberType type;    // 成员类型：主要分为游客和非游客，非游客又分成受限用户、普通用户、创建者、管理员;
    private int memberLevel;    // 成员级别：大于等于0表示用户开发者可以自定义的级别

    /// 进入聊天室时提交
    private String nick;        // 聊天室内的昵称字段，预留字段，可从NimUserInfo中取，也可以由用户进聊天室时提交。
    private String avatar;      // 聊天室内的头像，预留字段，可从NimUserInfo中取avatar，可以由用户进聊天室时提交。
    private Map<String, Object> extension;   // 开发者扩展字段，长度限制4k，可以由用户进聊天室时提交。
    private String extensionStr;   // 开发者扩展字段，长度限制4k，可以由用户进聊天室时提交。

    // 仅成员在线时有效
    private boolean isOnline;   // 成员是否处于在线状态，仅特殊成员才可能离线，对游客/匿名用户而言只能是在线。
    private boolean inBlackList;// 是否在黑名单中
    private boolean isMuted;    // 是禁言用户
    private boolean isValid;    // 记录有效标记为
    private long enterTime;     // 进入聊天室的时间点,对于离线成员该字段为空
    private long updateTime;    // 固定成员的记录更新时间,用于固定成员列表的排列查询
    private boolean isTempMuted;    // 是否临时禁言
    private long tempMuteDuration;  // 临时禁言的解除时长,单位秒
    private String tags;            // 用户标签
    private String notifyTargetTags;// 通知目标标签

    public ChatRoomMember() {
    }

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

    /**
     * 获取成员帐号
     * @return 成员account
     */
    public String getAccount() {
        return account;
    }

    /**
     * 获取成员类型
     * 成员类型：主要分为游客和非游客。
     * 非游客又分成受限用户、普通用户、创建者、管理员;
     * @return 成员类型
     */
    public MemberType getMemberType() {
        return type;
    }

    /**
     * 获取成员级别
     * 大于等于0表示用户开发者可以自定义的级别
     * @return 成员级别
     */
    public int getMemberLevel() {
        return memberLevel;
    }

    /**
     * 获取昵称
     * 可从NimUserInfo中取，也可以由用户进聊天室时提交。
     * @return 昵称
     */
    public String getNick() {
        return nick;
    }

    /**
     * 获取头像
     * 可从NimUserInfo中取avatar，可以由用户进聊天室时提交。
     * @return 头像
     */
    public String getAvatar() {
        return avatar;
    }

    /**
     * 获取扩展字段
     * 长度限制4k，可以由用户进聊天室时提交。
     * @return 返回扩展字段
     */
    public Map<String, Object> getExtension() {
        return extension;
    }

    /**
     * 获取进入聊天室时间
     * 对于离线成员该字段为空
     * @return 进入聊天室时间
     */
    public long getEnterTime() {
        return enterTime;
    }

    /**
     * 判断用户是否处于在线状态
     * 仅特殊成员才可能离线，对游客/匿名用户而言只能是在线。
     * @return  是否在线
     */
    public boolean isOnline() {
        return isOnline;
    }

    /**
     * 判断用户是否在黑名单中
     * @return 是否在黑名单中
     */
    public boolean isInBlackList() {
        return inBlackList;
    }

    /**
     * 判断用户是否被禁言
     * @return 是否被禁言
     */
    public boolean isMuted() {
        return isMuted;
    }

    /**
     * 判断是否有效
     * @return 是否有效
     */
    public boolean isValid() {
        return isValid;
    }

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

    /**
     * 设置用户帐号
     * @param account 用户帐号
     */
    public void setAccount(String account) {
        this.account = account;
    }

    /**
     * 设置成员类型
     * @param type 成员类型
     */
    public void setMemberType(MemberType type) {
        this.type = type;
    }

    /**
     * 设置成员等级
     * @param memberLevel 成员等级
     */
    public void setMemberLevel(int memberLevel) {
        this.memberLevel = memberLevel;
    }

    /**
     * 设置成员昵称
     * @param nick 昵称
     */
    public void setNick(String nick) {
        this.nick = nick;
    }

    /**
     * 设置成员头像
     * @param avatar 头像
     */
    public void setAvatar(String avatar) {
        this.avatar = avatar;
    }

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

    public String getExtensionStr() {
        return extensionStr;
    }

    public void setExtensionStr(String extensionStr) {
        this.extensionStr = extensionStr;
        this.extension = MsgHelper.getMapFromJsonString(extensionStr);
    }

    /**
     * 设置在线状态
     * @param online 在线状态
     */
    public void setOnline(boolean online) {
        this.isOnline = online;
    }

    /**
     * 设置进入聊天室时间
     * @param enterTime 进入聊天室时间
     */
    public void setEnterTime(long enterTime) {
        this.enterTime = enterTime;
    }

    /**
     * 设置是否在黑名单中
     * @param inBlackList 是否设置为黑名单
     */
    public void setInBlackList(boolean inBlackList) {
        this.inBlackList = inBlackList;
    }

    /**
     * 设置是否禁言
     * @param muted 是否禁言
     */
    public void setMuted(boolean muted) {
        this.isMuted = muted;
    }

    /**
     * 设置是否有效
     * @param valid 是否有效
     */
    public void setValid(boolean valid) {
        this.isValid = valid;
    }

    /**
     * 获取固定成员的记录更新时间，用于固定成员列表的排列查询
     * @return 更新时间
     */
    public long getUpdateTime() {
        return updateTime;
    }

    /**
     * 设置固定成员的更新时间
     * @param updateTime 更新时间
     */
    public void setUpdateTime(long updateTime) {
        this.updateTime = updateTime;
    }


    /**
     * 判断用户是否被临时禁言
     * @return 是否被临时禁言
     */
    public boolean isTempMuted() {
        return isTempMuted;
    }

    /**
     * 设置是否临时禁言
     * @param tempMuted 是否临时禁言
     */
    public void setTempMuted(boolean tempMuted) {
        isTempMuted = tempMuted;
    }

    /**
     * 获取临时禁言解除时长，单位秒
     * @return 临时禁言的解除时长,单位秒
     */
    public long getTempMuteDuration() {
        return tempMuteDuration;
    }

    /**
     * 设置临时禁言解除时长。
     * 若需要设置临时禁言，请使用{@link com.netease.nimlib.sdk.chatroom.ChatRoomService#markChatRoomTempMute(boolean, long, MemberOption)}
     * @param tempMuteDuration 解除时长，单位秒
     */
    public void setTempMuteDuration(long tempMuteDuration) {
        this.tempMuteDuration = tempMuteDuration;
    }

    /**
     * 查询用户标签
     */
    public String getTags() {
        return tags;
    }

    /**
     * 设置用户标签
     */
    public void setTags(String tags) {
        this.tags = tags;
    }

    /**
     * 查询通知目标标签
     */
    public String getNotifyTargetTags() {
        return notifyTargetTags;
    }

    /**
     * 设置通知目标标签
     */
    public void setNotifyTargetTags(String notifyTargetTags) {
        this.notifyTargetTags = notifyTargetTags;
    }

    /**
     * ********************************** 序列化 **********************************
     */

    protected ChatRoomMember(Parcel in) {
        roomId = in.readString();
        account = in.readString();
        type = MemberType.typeOfValue(in.readInt());
        memberLevel = in.readInt();

        nick = in.readString();
        avatar = in.readString();
        setExtensionStr(in.readString());

        isOnline = in.readByte() == 0x01;
        inBlackList = in.readByte() == 0x01;
        isMuted = in.readByte() == 0x01;
        isValid = in.readByte() == 0x01;
        enterTime = in.readLong();
        updateTime = in.readLong();
        isTempMuted = in.readByte() == 0x01;
        tempMuteDuration = in.readLong();
    }

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

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeString(roomId);
        dest.writeString(account);
        dest.writeInt(type.getValue());
        dest.writeInt(memberLevel);

        dest.writeString(nick);
        dest.writeString(avatar);
        dest.writeString(getExtensionStr());

        dest.writeByte(isOnline ? (byte) 0x01 : 0x00);
        dest.writeByte(inBlackList ? (byte) 0x01 : 0x00);
        dest.writeByte(isMuted ? (byte) 0x01 : 0x00);
        dest.writeByte(isValid ? (byte) 0x01 : 0x00);
        dest.writeLong(enterTime);
        dest.writeLong(updateTime);
        dest.writeByte(isTempMuted ? (byte) 0x01 : 0x00);
        dest.writeLong(tempMuteDuration);
    }

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

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