com.avos.avoscloud.im.v2.conversation.AVIMConversationMemberInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of avoscloud-push Show documentation
AVOS Cloud Android SDK
The newest version!
package com.avos.avoscloud.im.v2.conversation;

import java.util.Map;
import java.util.HashMap;

/**
 * 聊天对话成员信息类
 * 支持保存对话内每一个成员的属性：
 * 1，权限（管理员 or 普通成员）
 * 2，昵称（尚未实现）
 * 3，加入对话时间（尚未实现）
 * 4，加入对话时的邀请人信息（尚未实现）
 *
 * Created by fengjunwen on 2017/12/14.
 */
public class AVIMConversationMemberInfo {
  public static String ATTR_OJBECTID = "infoId";
  public static String ATTR_CONVID = "conversationId";
  public static String ATTR_MEMBERID = "peerId";
  public static String ATTR_ROLE = "role";
  private static String ATTR_CREATEDAT = "createdAt";
  private static String ATTR_NICKNAME = "nickname";
  private static String ATTR_INVITER = "inviter";

  private String conversationId = null;
  private String memberId = null;
  private ConversationMemberRole role;
  private boolean isOwner = false;

  private String createdAt = null;
  private String objectId = null;
  private String inviter = null;
  private String nickname = null;

  /**
   * 构造函数
   * @param conversationId 对话 id
   * @param memberId       成员的 client id
   * @param role           角色
   */
  public AVIMConversationMemberInfo(String conversationId, String memberId, ConversationMemberRole role) {
    this(null, conversationId, memberId, role);
  }

  /**
   * 构造函数
   * @param objectId         记录的 objectId
   * @param conversationId   对话 id
   * @param memberId         成员的 client id
   * @param role             角色
   */
  public AVIMConversationMemberInfo(String objectId, String conversationId, String memberId, ConversationMemberRole role) {
    this.objectId = objectId;
    this.conversationId = conversationId;
    this.memberId = memberId;
    this.role = role;
  }

  public String toString() {
    return "convId:" + this.conversationId + ", memberId:" + this.memberId + ", role:" + this.role.toString();
  }

  /**
   * 获取对话 id
   * @return
   */
  public String getConversationId() {
    return conversationId;
  }

  /**
   * 获取成员的 client id
   * @return
   */
  public String getMemberId() {
    return this.memberId;
  }

  /**
   * 获取角色信息
   * @return
   */
  public ConversationMemberRole getRole() {
    return this.role;
  }

  /**
   * 设置角色
   * @param role
   */
  public void setRole(ConversationMemberRole role) {
    this.role = role;
  }

  /**
   * 获取成员加入时间（也就是该记录创建时间）
   * 注意：目前尚未实现
   * @return
   */
  public String getCreatedAt() {
    return createdAt;
  }

  /**
   * 设置记录创建时间
   * 注意：目前尚未实现
   * @param createdAt
   */
  public void setCreatedAt(String createdAt) {
    this.createdAt = createdAt;
  }

  /**
   * 获取该条记录的 objectId
   * @return
   */
  public String getObjectId() {
    return objectId;
  }

  /**
   * 获取邀请者名字
   * 注意：目前尚未实现
   * @return
   */
  public String getInviter() {
    return inviter;
  }

  /**
   * 设置邀请者名字
   * 注意：目前尚未实现
   * @param inviter
   */
  public void setInviter(String inviter) {
    this.inviter = inviter;
  }

  /**
   * 获取成员的昵称
   * 注意：目前尚未实现
   * @return
   */
  public String getNickname() {
    return nickname;
  }

  /**
   * 设置成员的昵称
   * 注意：目前尚未实现
   * @param nickname
   */
  public void setNickname(String nickname) {
    this.nickname = nickname;
  }

  public boolean isOwner() {
    return isOwner;
  }

  /**
   * 返回属性更新的 Map（内部使用）
   * @return
   */
  public Map getUpdateAttrs() {
    HashMap attrs = new HashMap<>();
    attrs.put(ATTR_MEMBERID, getMemberId());
    attrs.put(ATTR_ROLE, getRole().getName());
    attrs.put(ATTR_OJBECTID, getObjectId());
    return attrs;
  }

  /**
   * 根据服务端返回信息创建实例（内部使用）
   * @param data
   * @return
   */
  public static AVIMConversationMemberInfo createInstance(Map data) {
    if (null == data) {
      return null;
    }
    String conversationId = (String)data.get(ATTR_CONVID);
    String memberId = (String)data.get(ATTR_MEMBERID);
    String roleStr = (String)data.get(ATTR_ROLE);
    String objectId = (String)data.get(ATTR_OJBECTID);
    ConversationMemberRole role = ConversationMemberRole.fromString(roleStr);
    return new AVIMConversationMemberInfo(objectId, conversationId, memberId, role);
  }
}