EMUserInfo.h 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. //
  2. // EMUserInfo.h
  3. // libHyphenateSDK.a
  4. //
  5. // Created by lixiaoming on 2021/3/17.
  6. // Copyright © 2021 easemob.com. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. /**
  10. * \~chinese
  11. * 用户属性枚举类型。
  12. *
  13. *
  14. * \~english
  15. * The user information type.
  16. */
  17. typedef NS_ENUM(NSInteger, EMUserInfoType) {
  18. EMUserInfoTypeNickName = 0, /** \~chinese 用户昵称。 *\~english The user nickname. */
  19. EMUserInfoTypeAvatarURL, /** \~chinese 用户头像地址。 *\~english The user avatar address.*/
  20. EMUserInfoTypePhone, /** \~chinese 用户联系方式。 *\~english The user contact. */
  21. EMUserInfoTypeMail, /** \~chinese 用户邮箱地址。 *\~english The user email address. */
  22. EMUserInfoTypeGender, /** \~chinese 用户性别。 *\~english The user gender. */
  23. EMUserInfoTypeSign, /** \~chinese 用户签名。 *\~english The user signature. */
  24. EMUserInfoTypeBirth, /** \~chinese 用户生日。 *\~english The user birthday. */
  25. EMUserInfoTypeExt = 100, /** \~chinese 扩展字段。 *\~english The extension field. */
  26. };
  27. /**
  28. * \~chinese
  29. * 用户属性信息。
  30. *
  31. * \~english
  32. * The userInfo class.
  33. */
  34. @interface EMUserInfo : NSObject<NSCopying>
  35. /**
  36. * \~chinese 用户 ID。
  37. *
  38. * \~english The user ID.
  39. */
  40. @property (nonatomic,copy) NSString * _Nullable userId;
  41. /**
  42. * \~chinese 用户昵称。
  43. *
  44. * \~english The user's nickname.
  45. */
  46. @property (nonatomic,copy) NSString * _Nullable nickname;
  47. /**
  48. * \~chinese 用户头像地址。
  49. *
  50. * \~english The user's avatar file uri.
  51. */
  52. @property (nonatomic,copy) NSString * _Nullable avatarUrl;
  53. /**
  54. * \~chinese 用户邮箱地址。
  55. *
  56. * \~english The user's mail address.
  57. */
  58. @property (nonatomic,copy) NSString * _Nullable mail;
  59. /**
  60. * \~chinese 用户联系方式。
  61. *
  62. * \~english The user's phone number.
  63. */
  64. @property (nonatomic,copy) NSString * _Nullable phone;
  65. /**
  66. * \~chinese 用户性别,0 为未设置。SDK 没有取值限制,你可以自己定义取值,例如指定 1:男;2:女。
  67. *
  68. * \~english The user's gender. If you didn't set, the default value is 0. For example you can set 1 for male and 2 for female.
  69. */
  70. @property (nonatomic) NSInteger gender;
  71. /**
  72. * \~chinese 用户签名。
  73. *
  74. * \~english The user's personal status.
  75. */
  76. @property (nonatomic,copy) NSString* _Nullable sign;
  77. /**
  78. * \~chinese 用户生日。
  79. *
  80. * \~english The user's birth date.
  81. */
  82. @property (nonatomic,copy) NSString* _Nullable birth;
  83. /**
  84. * \~chinese 扩展字段。
  85. *
  86. * \~english The extention information.
  87. */
  88. @property (nonatomic,copy) NSString * _Nullable ext;
  89. #pragma mark - EM_DEPRECATED_IOS 3.8.8
  90. /**
  91. * \~chinese 用户昵称。
  92. *
  93. * \~english The user's nickname.
  94. */
  95. @property (nonatomic,copy) NSString *nickName
  96. __deprecated_msg("Use nickname instead");
  97. @end