V2NIMTeamClearJoinActionInfoOption.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.team.option;

import com.netease.nimlib.report.utils.NtpTimeUtil;
import com.netease.nimlib.sdk.v2.team.enums.V2NIMTeamJoinActionTeamType;

/**
 * 清除加入群操作信息的选项类
 */
public class V2NIMTeamClearJoinActionInfoOption {

    /**
     * 时间戳，默认当前时间戳，会删除这个时间之前的所有记录
     */
    private long                        timestamp;
    /**
     * 群类型，默认全部
     */
    private V2NIMTeamJoinActionTeamType type;

    /**
     * 默认构造函数
     * 初始化时间戳为当前时间，群类型为全部
     */
    public V2NIMTeamClearJoinActionInfoOption() {
        this.timestamp = NtpTimeUtil.getServerNow();
        this.type = V2NIMTeamJoinActionTeamType.V2NIM_TEAM_JOIN_ACTION_TEAM_TYPE_ALL;
    }

    /**
     * 带参数的构造函数
     * @param timestamp 时间戳
     * @param type 群类型
     */
    public V2NIMTeamClearJoinActionInfoOption(long timestamp, V2NIMTeamJoinActionTeamType type) {
        setTimestamp(timestamp);
        setType(type);
    }

    /**
     * 获取时间戳
     * @return 时间戳
     */
    public long getTimestamp() {
        return timestamp;
    }

    /**
     * 设置时间戳
     * 如果设置的时间戳小于等于0，则使用当前时间戳
     * @param timestamp 要设置的时间戳
     */
    public void setTimestamp(long timestamp) {
        this.timestamp = timestamp;
        if (this.timestamp <= 0) {
            this.timestamp = NtpTimeUtil.getServerNow();
        }
    }

    /**
     * 获取群类型
     * @return 群类型
     */
    public V2NIMTeamJoinActionTeamType getType() {
        return type;
    }

    /**
     * 设置群类型
     * 如果设置的群类型为null，则使用默认值（全部）
     * @param type 要设置的群类型
     */
    public void setType(V2NIMTeamJoinActionTeamType type) {
        this.type = type;
        if (this.type == null) {
            this.type = V2NIMTeamJoinActionTeamType.V2NIM_TEAM_JOIN_ACTION_TEAM_TYPE_ALL;
        }
    }

    /**
     * 重写toString方法
     * @return 返回对象的字符串表示
     */
    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("V2NIMTeamClearJoinActionInfoOption{");
        sb.append("timestamp=").append(timestamp);
        sb.append(", type=").append(type);
        sb.append('}');
        return sb.toString();
    }
}