V2NIMAddCollectionParams.java

浏览该文件的文档.

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

/**
 * 添加收藏参数
 */
public class V2NIMAddCollectionParams {

    /**
     * 收藏类型
     * 必须大于 0， 可以按该字段分类
     */
    private final int collectionType;
    /**
     * 收藏数据
     * 最大 20480 字节
     */
    private final String collectionData;
    /**
     * 扩展字段
     * 最大1024 字节
     */
    private final String serverExtension;
    /**
     * 去重唯一ID， 如果ID相同， 则不会新增收藏，只更新之前的收藏内容
     */
    private final String uniqueId;

    private V2NIMAddCollectionParams() {
        this(0, "", null,null);
    }

    private V2NIMAddCollectionParams(int collectionType, String collectionData, String serverExtension,String uniqueId) {
        this.collectionType = collectionType;
        this.collectionData = collectionData;
        this.serverExtension = serverExtension;
        this.uniqueId = uniqueId;
    }

    /**
     * 获取收藏类型
     * @return 收藏类型
     */
    public int getCollectionType() {
        return collectionType;
    }

    /**
     * 获取收藏数据
     * @return 收藏数据
     */
    public String getCollectionData() {
        return collectionData;
    }

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

    /**
     * 获取去重唯一ID
     * @return 去重唯一ID,如果ID相同， 则不会新增收藏，只更新之前的收藏内容
     */
    public String getUniqueId() {
        return uniqueId;
    }

    @Override
    public String toString() {
        return "V2NIMAddCollectionParams{" +
                "collectionType=" + collectionType +
                ", collectionData='" + collectionData + '\'' +
                ", serverExtension='" + serverExtension + '\'' +
                ", uniqueId='" + uniqueId + '\'' +
                '}';
    }

    /**
     * 添加收藏参数构造器
     */
    public static final class V2NIMAddCollectionParamsBuilder {
        private final int collectionType;
        private final String collectionData;
        private String serverExtension;
        private String uniqueId;

        private V2NIMAddCollectionParamsBuilder(int collectionType, String collectionData) {
            this.collectionType = collectionType;
            this.collectionData = collectionData;
        }

        /**
         * 创建添加收藏参数构造器
         * @param collectionType 收藏类型
         * @param collectionData 收藏数据
         * @return V2NIMAddCollectionParamsBuilder
         */
        public static V2NIMAddCollectionParamsBuilder builder(int collectionType, String collectionData) {
            return new V2NIMAddCollectionParamsBuilder(collectionType, collectionData);
        }

        /**
         * 设置扩展字段
         * @param serverExtension 扩展字段
         * @return V2NIMAddCollectionParamsBuilder
         */
        public V2NIMAddCollectionParamsBuilder withServerExtension(String serverExtension) {
            this.serverExtension = serverExtension;
            return this;
        }

        /**
         * 设置去重唯一ID
         * @param uniqueId 去重唯一ID
         * @return V2NIMAddCollectionParamsBuilder
         */
        public V2NIMAddCollectionParamsBuilder withUniqueId(String uniqueId) {
            this.uniqueId = uniqueId;
            return this;
        }

        /**
         * 构建添加收藏参数
         * @return V2NIMAddCollectionParams
         */
        public V2NIMAddCollectionParams build() {
            return new V2NIMAddCollectionParams(collectionType, collectionData, serverExtension,uniqueId);
        }
    }
}