V2NIMUpdateLocalMessageParams.java

浏览该文件的文档.

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

import com.netease.nimlib.sdk.v2.message.attachment.V2NIMMessageAttachment;
import com.netease.nimlib.sdk.v2.message.enums.V2NIMMessageSendingState;

/**
 * 本地消息更新参数类
 */
public class V2NIMUpdateLocalMessageParams {

    /**
     * 消息子类型，需要 >= 0
     */
    private Integer subType;

    /**
     * 消息内容
     */
    private String text;

    /**
     * 消息附属附件，附件类型需要和原始消息附件类型保持一致
     */
    private V2NIMMessageAttachment attachment;

    /**
     * 消息本地扩展字段
     */
    private String localExtension;
    /**
     *  消息发送状态
     *  仅支持成功和失败， 其它状态返回参数报错
     */
    private V2NIMMessageSendingState sendingState;

    public V2NIMUpdateLocalMessageParams() {
    }

    /**
     * 构造函数
     *
     * @param subType       消息子类型，需要 >= 0
     * @param text          消息内容
     * @param attachment    消息附属附件
     * @param localExtension 消息本地扩展字段
     * @param sendingState  消息发送状态,  仅支持成功和失败， 其它状态返回参数报错
     */
    public V2NIMUpdateLocalMessageParams(Integer subType, String text, V2NIMMessageAttachment attachment, String localExtension, V2NIMMessageSendingState sendingState) {
        this.subType = subType;
        this.text = text;
        this.attachment = attachment;
        this.localExtension = localExtension;
        this.sendingState = sendingState;
    }



    /**
     * 获取消息子类型
     *
     * @return 消息子类型，可能为 null
     */
    public Integer getSubType() {
        return subType;
    }

    /**
     * 设置消息子类型
     *
     * @param subType 消息子类型，必须 >= 0
     */
    public void setSubType(Integer subType) {
        this.subType = subType;
    }

    /**
     * 获取消息内容
     *
     * @return 消息文本内容，可能为 null
     */
    public String getText() {
        return text;
    }

    /**
     * 设置消息内容
     *
     * @param text 消息文本内容
     */
    public void setText(String text) {
        this.text = text;
    }

    /**
     * 获取消息附属附件
     *
     * @return 消息附件对象，可能为 null
     */
    public V2NIMMessageAttachment getAttachment() {
        return attachment;
    }

    /**
     * 设置消息附属附件
     *
     * @param attachment 消息附件对象
     */
    public void setAttachment(V2NIMMessageAttachment attachment) {
        this.attachment = attachment;
    }

    /**
     * 获取消息本地扩展字段
     *
     * @return 本地扩展信息，可能为 null
     */
    public String getLocalExtension() {
        return localExtension;
    }

    /**
     * 设置消息本地扩展字段
     *
     * @param localExtension 本地扩展字段
     */
    public void setLocalExtension(String localExtension) {
        this.localExtension = localExtension;
    }
    /**
     * 获取消息发送状态
     *
     * @return 消息发送状态
     */
    public V2NIMMessageSendingState getSendingState() {
        return sendingState;
    }

    /**
     * 设置消息发送状态, 仅支持成功和失败， 其它状态返回参数报错
     * @param sendingState  消息发送状态
     */
    public void setSendingState(V2NIMMessageSendingState sendingState) {
        this.sendingState = sendingState;
    }

    public boolean isValid() {
        if(subType != null && subType < 0){
            return false;
        }

        if(sendingState != null && sendingState != V2NIMMessageSendingState.V2NIM_MESSAGE_SENDING_STATE_SUCCEEDED && sendingState != V2NIMMessageSendingState.V2NIM_MESSAGE_SENDING_STATE_FAILED){
            return false;
        }

        if(subType != null){
            return true;
        }

        if(text != null){
            return true;
        }

        if(attachment != null){
            return true;
        }

        if(localExtension != null){
            return true;
        }

        if(sendingState != null){
            return true;
        }

        return false;
    }

    /**
     * Builder 模式构建器，用于链式创建 V2NIMUpdateLocalMessageParams 实例
     */
    public static class V2NIMUpdateLocalMessageParamsBuilder {
        private Integer subType;
        private String text;
        private V2NIMMessageAttachment attachment;
        private String localExtension;
        private V2NIMMessageSendingState sendingState;


        private V2NIMUpdateLocalMessageParamsBuilder() {}

        public static V2NIMUpdateLocalMessageParamsBuilder builder() {
            return new V2NIMUpdateLocalMessageParamsBuilder();
        }

        /**
         * 设置消息子类型
         *
         * @param subType 消息子类型，必须 >= 0
         * @return Builder 自身实例
         */
        public V2NIMUpdateLocalMessageParamsBuilder withSubType(Integer subType) {
            this.subType = subType;
            return this;
        }

        /**
         * 设置消息内容
         *
         * @param text 消息文本内容
         * @return Builder 自身实例
         */
        public V2NIMUpdateLocalMessageParamsBuilder withText(String text) {
            this.text = text;
            return this;
        }

        /**
         * 设置消息附件
         *
         * @param attachment 消息附件对象
         * @return Builder 自身实例
         */
        public V2NIMUpdateLocalMessageParamsBuilder withAttachment(V2NIMMessageAttachment attachment) {
            this.attachment = attachment;
            return this;
        }

        /**
         * 设置消息本地扩展字段
         *
         * @param localExtension 本地扩展字段
         * @return Builder 自身实例
         */
        public V2NIMUpdateLocalMessageParamsBuilder withLocalExtension(String localExtension) {
            this.localExtension = localExtension;
            return this;
        }

        public V2NIMUpdateLocalMessageParamsBuilder withSendingState(V2NIMMessageSendingState sendingState) {
            this.sendingState = sendingState;
            return this;
        }

        /**
         * 构建最终的 V2NIMUpdateLocalMessageParams 对象
         *
         * @return 构造完成的对象
         */
        public V2NIMUpdateLocalMessageParams build() {
            return new V2NIMUpdateLocalMessageParams(subType, text, attachment, localExtension, sendingState);
        }
    }
}