@22g/netease-im-web-sdk/lib/sdk/NIM/User.d.ts

typescript netease-im-web-sdk

/**
 * 用户性别
 * - [相关文档](https://dev.yunxin.163.com/docs/interface/即时通讯Web端/NIMSDK-Web/User.html#.gender)
 */
export const enum NIMUserGender {
  /** 未知 */
  unknown = 'unknown',
  /** 男 */
  male = 'male',
  /** 女 */
  famale = 'female',
}



/**
 * 云信用户卡片
 * - [相关文档](https://dev.yunxin.163.com/docs/interface/即时通讯Web端/NIMSDK-Web/User.html)
 */
export interface NIMUser {
  /** 云信账号 */
  account: string;
  /** 昵称 */
  nick: string;
  /** 头像 */
  avatar: string;
  /** 签名 */
  sign: string;
  /** 性别 */
  gender: NIMUserGender;
  /** 邮箱 */
  email: string;
  /** 生日 */
  birth: string;
  /** 电话号码 */
  tel: string;
  /**
   * 扩展字段
   * - 推荐使用JSON格式构建, 非JSON格式的话, Web端会正常接收, 但是会被其它端丢弃
   */
  custom: string;
  /** 创建时间(ms) */
  createTime: number;
  /** 更新时间(ms) */
  updateTime: number;
}