V2NIMUserStatus.java

浏览该文件的文档.

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

import com.netease.nimlib.log.NimLog;
import com.netease.nimlib.sdk.v2.auth.enums.V2NIMLoginClientType;

/**
 * 用户状态
 */
public class V2NIMUserStatus {

    /**
     * 用户账号ID
     */
    private final String accountId;

    /**
     * 包括以下状态，在线状态参见：枚举名：V2NIMUserStatusType 未知：0 登录：1 登出：2 断开连接： 3 自定义设置值： 10000以上，不包括一万， 一万以内为预定义值
     */
    private final Integer statusType;

    /**
     * 用户发布状态对应的终端
     */
    private final V2NIMLoginClientType clientType;

    /**
     * 用户发布状态的发布时间，服务器时间
     */
    private final Long publishTime;

    /**
     * 每次发布时，会生成一个唯一id， 发布自定义事件时会生成该参数，如果id相同，表示同一个事件
     */
    private String uniqueId;

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

    /**
     * 获取预留状态中的配置信息，由服务端填入 JsonArray格式
     */
    private String serverExtension;

    private V2NIMUserStatus() {
    this.accountId = null;
    this.statusType = null;
    this.clientType = null;
    this.publishTime = null;
    this.uniqueId = null;
    this.extension = null;
    this.serverExtension = null;
  }

    /**
   * 构造函数
   *
   * @param accountId 用户账号ID
   * @param statusType 状态类型
   * @param clientType 用户发布状态对应的终端
   * @param publishTime 用户发布状态的发布时间
   */
    public V2NIMUserStatus(String accountId, int statusType, V2NIMLoginClientType clientType, long publishTime){
        this(accountId, statusType, clientType, publishTime, null, null, null);
    }

    /**
   * 构造函数
   *
   * @param accountId 用户账号ID
   * @param statusType 状态类型
   * @param clientType 用户发布状态对应的终端
   * @param publishTime 用户发布状态的发布时间
   * @param uniqueId 唯一ID
   * @param extension 扩展字段
   * @param serverExtension 服务端扩展字段
   */
    public V2NIMUserStatus(String accountId, int statusType, V2NIMLoginClientType clientType, long publishTime, String uniqueId, String extension, String serverExtension) {
        this.accountId = accountId;
    this.statusType = statusType;
    this.clientType = clientType;
    this.publishTime = publishTime;
    this.uniqueId = uniqueId;
    this.extension = extension;
    this.serverExtension = serverExtension;
    }

    /**
     * 获取用户账号ID
     *
     * @return 用户账号ID
     */
    public String getAccountId() {
        return accountId;
    }

    /**
     * 获取状态类型
     *
     * @return 状态类型
     */
    public int getStatusType() {
        if (statusType == null) {
            return 0;
        }
        return statusType;
    }

    /**
     * 获取用户发布状态对应的终端
     *
     * @return 用户发布状态对应的终端
     */
    public V2NIMLoginClientType getClientType() {
        return clientType;
    }

    /**
     * 获取用户发布状态的发布时间
     *
     * @return 用户发布状态的发布时间
     */
    public long getPublishTime() {
        if (publishTime == null) {
            return 0L;
        }
        return publishTime;
    }

    /**
     * 获取唯一ID
     * @return 唯一ID
     */
    public String getUniqueId() {
        return uniqueId;
    }

    /**
     * 设置唯一ID
     * @param uniqueId 唯一ID
     */
    public void setUniqueId(String uniqueId) {
        this.uniqueId = uniqueId;
    }

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

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

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

    /**
     * 设置服务端扩展字段
     * @param serverExtension 服务端扩展字段
     */
    public void setServerExtension(String serverExtension) {
        this.serverExtension = serverExtension;
    }

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("V2NIMUserStatus{");
        if(NimLog.isDebuggable()){
            sb.append("accountId='").append(accountId).append('\'');
            sb.append(", statusType=").append(statusType);
            sb.append(", clientType=").append(clientType);
            sb.append(", publishTime=").append(publishTime);
            sb.append(", uniqueId='").append(uniqueId).append('\'');
            sb.append(", extension='").append(extension).append('\'');
            sb.append(", serverExtension='").append(serverExtension).append('\'');
        }else{
            sb.append("accountId='").append(accountId).append('\'');
            sb.append(", statusType=").append(statusType);
            sb.append(", clientType=").append(clientType);
            sb.append(", publishTime=").append(publishTime);
        }
        sb.append('}');
        return sb.toString();
    }

    /**
     * V2NIMUserStatus构造器
     */
    public static final class Builder {
    private final String accountId;
    private final int statusType;
    private final V2NIMLoginClientType clientType;
    private final long publishTime;
    private String uniqueId;
    private String extension;
    private String serverExtension;

        /**
         *
         * @param accountId 用户账号ID
         * @param statusType 状态类型
         * @param clientType 用户发布状态对应的终端
         * @param publishTime 用户发布状态的发布时间
         */
    public Builder(String accountId, int statusType, V2NIMLoginClientType clientType, long publishTime) {
            this.accountId = accountId;
      this.statusType = statusType;
      this.clientType = clientType;
      this.publishTime = publishTime;
    }

    public Builder uniqueId(String uniqueId) {
      this.uniqueId = uniqueId;
      return this;
    }

    public Builder extension(String extension) {
      this.extension = extension;
      return this;
    }

    public Builder serverExtension(String serverExtension) {
      this.serverExtension = serverExtension;
      return this;
    }

    public V2NIMUserStatus build() {
      return new V2NIMUserStatus(accountId, statusType, clientType, publishTime, uniqueId, extension, serverExtension);
    }
  }
}