V2NIMCustomUserStatusParams.java

浏览该文件的文档.

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

import com.netease.nimlib.log.NimLog;

/**
 * 自定义用户状态参数
 */
public class V2NIMCustomUserStatusParams {

    private static final String TAG = "V2NIMCustomUserStatusParams";
    /**
     * 自定义设置值： 10000以上，包括一万， 一万以内为预定义值
     * 小于1万，返回参数错误
     * 大于int上限，返回参数错误
     */
    private final Integer statusType;

    private static final int MIN_STATUS_TYPE = 10000;

    /**
     * 状态的有效期，单位秒，范围为 60s 到 7days，默认值为60s
     */
    private final Long duration;

    private static final long MIN_DURATION = 60L;
    private static final long MAX_DURATION = 604800L;

    /**
     * 用户发布状态时设置的扩展字段
     */
    private String extension;

    /**
     * 用户发布状态时是否只广播给在线的订阅者，默认值为TRUE
     */
    private boolean onlineOnly = true;

    /**
     * 用户发布状态时是否需要多端同步，默认值为FALSE
     */
    private boolean multiSync = false;

    private V2NIMCustomUserStatusParams() {
        this.statusType = null;
        this.duration = 60L;
    }

    public V2NIMCustomUserStatusParams(int statusType, long duration) {
        this.statusType = statusType;
        this.duration = duration;
    }

    /**
     * 获取statusType字段的值
     * @return statusType字段的值
     */
    public int getStatusType() {
        if (this.statusType == null) {
            return 0;
        }
        return this.statusType;
    }

    /**
     * 获取duration字段的值
     * @return duration字段的值
     */
    public long getDuration() {
        return this.duration;
    }


    /**
     * 获取extension字段的值
     * @return extension字段的值
     */
    public String getExtension() {
        return this.extension;
    }

    /**
     * 设置extension字段的值
     * @param extension 新的extension字段的值
     */
    public void setExtension(String extension) {
        this.extension = extension;
    }

    /**
     * 获取onlineOnly字段的值
     * @return onlineOnly字段的值
     */
    public boolean isOnlineOnly() {
        return this.onlineOnly;
    }

    /**
     * 设置onlineOnly字段的值
     * @param onlineOnly 新的onlineOnly字段的值
     */
    public void setOnlineOnly(boolean onlineOnly) {
        this.onlineOnly = onlineOnly;
    }

    /**
     * 获取multiSync字段的值
     * @return multiSync字段的值
     */
    public boolean isMultiSync() {
        return this.multiSync;
    }

    /**
     * 设置multiSync字段的值
     * @param multiSync 新的multiSync字段的值
     */
    public void setMultiSync(boolean multiSync) {
        this.multiSync = multiSync;
    }

    public boolean isValid(){
        if(statusType == null || statusType < MIN_STATUS_TYPE){
            NimLog.e(TAG, "statusType is invalid");
            return false;
        }
        if(duration == null || duration < MIN_DURATION || duration > MAX_DURATION){
            NimLog.e(TAG, "duration is invalid");
            return false;
        }
        return true;
    }

    public static class Builder {
        /**
         * 自定义设置值： 10000以上，包括一万， 一万以内为预定义值
         * 小于1万，返回参数错误
         * 大于int上限，返回参数错误
         */
        private int statusType;
        /**
         * 状态的有效期，单位秒，范围为 60s 到 7days，默认值为60s
         */
        private long duration;
        /**
         * 用户发布状态时设置的扩展字段
         */
        private String extension;
        /**
         * 用户发布状态时是否只广播给在线的订阅者，默认值为TRUE
         */
        private boolean onlineOnly = true;
        /**
         * 用户发布状态时是否需要多端同步，默认值为FALSE
         */
        private boolean multiSync = false;

        /**
         * 构造函数
         * @param statusType 自定义设置值
         * @param duration 状态的有效期
         */
        public Builder(int statusType, long duration) {
            this.statusType = statusType;
            this.duration = duration;
        }

        /**
         * 设置extension字段的值
         * @param extension 新的extension字段的值
         * @return Builder对象
         */
        public Builder extension(String extension) {
            this.extension = extension;
            return this;
        }

        /**
         * 设置onlineOnly字段的值
         * @param onlineOnly 新的onlineOnly字段的值
         * @return Builder对象
         */
        public Builder onlineOnly(boolean onlineOnly) {
            this.onlineOnly = onlineOnly;
            return this;
        }
        /**
         * 设置multiSync字段的值
         * @param multiSync 新的multiSync字段的值
         * @return Builder对象
         */
        public Builder multiSync(boolean multiSync) {
            this.multiSync = multiSync;
            return this;
        }
        /**
         * 构造V2NIMCustomUserStatusParams对象
         * @return V2NIMCustomUserStatusParams对象
         */
        public V2NIMCustomUserStatusParams build() {
            V2NIMCustomUserStatusParams params = new V2NIMCustomUserStatusParams(statusType, duration);
            params.setExtension(extension);
            params.setOnlineOnly(onlineOnly);
            params.setMultiSync(multiSync);
            return params;
        }
    }
}