V2NIMChatroomUpdateParams.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.chatroom.params;

import java.io.Serializable;

/**
 * 聊天室信息更新参数
 */
public class V2NIMChatroomUpdateParams implements Serializable {
    /**
     * 聊天室名称
     * 为空表示不更新
     * 不能为空串"", 返回参数错误
     */
    private String roomName;
    /**
     * 聊天室公告
     * 为空表示不更新
     */
    private String announcement;
    /**
     * 聊天室直播地址
     */
    private String liveUrl;
    /**
     * 聊天室扩展字段
     * 为空表示不更新
     * 长度限制： 4096字节
     */
    private String serverExtension;
    /**
     * 是否需要通知
     * 默认为true
     */
    private Boolean notificationEnabled;
    /**
     * 本次操作生成的通知中的扩展字段
     */
    private String notificationExtension;

    public V2NIMChatroomUpdateParams() {
    }

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

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

    /**
     * 获取聊天室直播地址
     * @return 聊天室直播地址
     */
    public String getLiveUrl() {
        return liveUrl;
    }

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

    /**
     * 是否需要通知
     * @return true表示需要通知，false表示不需要通知
     */
    public boolean isNotificationEnabled() {
        if(notificationEnabled == null) {
            return true;
        }
        else {
            return notificationEnabled;
        }
    }

    /**
     * 获取本次操作生成的通知中的扩展字段
     * @return 本次操作生成的通知中的扩展字段
     */
    public String getNotificationExtension() {
        return notificationExtension;
    }

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

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

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

    /**
     * 设置聊天室扩展字段
     * @param serverExtension 聊天室扩展字段
     */
    public void setServerExtension(String serverExtension) {
        this.serverExtension = serverExtension;
    }

    /**
     * 设置是否需要通知
     * @param notificationEnabled 是否需要通知
     */
    public void setNotificationEnabled(boolean notificationEnabled) {
        this.notificationEnabled = notificationEnabled;
    }

    /**
     * 设置本次操作生成的通知中的扩展字段
     * @param notificationExtension 本次操作生成的通知中的扩展字段
     */
    public void setNotificationExtension(String notificationExtension) {
        this.notificationExtension = notificationExtension;
    }

    public boolean isValid() {
        if(roomName != null && roomName.isEmpty()){
            return false;
        }
        if(roomName != null){
            return true;
        }
        if(announcement != null){
            return true;
        }
        if(liveUrl != null){
            return true;
        }
        if(serverExtension != null){
            return true;
        }
        return false;
    }
}