floo::BMXUserProfile#
用户Profile
#include <bmx_user_profile.h>
Inherits from BMXBaseObject
Public Types#
| Name | |
|---|---|
| enum class | AddFriendAuthMode { Open, NeedApproval, AnswerQuestion, RejectAll} 对方申请加好友时的验证方式 |
| enum class | UserCategory { Normal, Advanced} 用户类型 |
Public Functions#
| Name | |
|---|---|
| virtual | ~BMXUserProfile() 析构函数 |
| virtual int64_t | userId() =0 用户ID（唯一） |
| virtual UserCategory | category() =0 用户策略 |
| virtual const std::string & | username() =0 用户名（唯一） |
| virtual const std::string & | nickname() =0 用户昵称 |
| virtual std::string | avatarRatelUrl() =0 用户ratel服务器头像url |
| virtual std::string | avatarUrl() =0 用户头像url |
| virtual std::string | avatarPath() =0 用户头像本地存储路径 |
| virtual std::string | avatarThumbnailPath() =0 用户头像缩略图本地存储路径 |
| virtual const std::string & | mobilePhone() =0 用户手机 |
| virtual const std::string & | email() =0 用户邮箱 |
| virtual const JSON & | publicInfo() =0 用户公开扩展信息，好友可见 |
| virtual const JSON & | privateInfo() =0 用户私有扩展信息，好友不可见 |
| virtual AddFriendAuthMode | addFriendAuthMode() =0 加好友校验方式 |
| virtual const [AuthQuestion] & | authQuestion() =0 添加好友时的验证问题 |
| virtual const [MessageSetting] & | messageSetting() =0 用户消息设定 |
| virtual bool | isAutoAcceptGroupInvite() =0 收到群组邀请进群时是否自动同意进群 |
Protected Functions#
| Name | |
|---|---|
| BMXUserProfile() |
Public Types Documentation#
enum AddFriendAuthMode#
| Enumerator | Value | Description |
|---|---|---|
| Open | 无需验证，任何人可以加为好友 | |
| NeedApproval | 需要同意方可加为好友 | |
| AnswerQuestion | 需要回答问题正确方可加为好友 | |
| RejectAll | 拒绝所有加好友申请 |
对方申请加好友时的验证方式
enum UserCategory#
| Enumerator | Value | Description |
|---|---|---|
| Normal | 普通用户 | |
| Advanced | 高级用户 |
用户类型
Public Functions Documentation#
function ~BMXUserProfile#
inline virtual ~BMXUserProfile()析构函数
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="~BMXUserProfile" %}{% endlanying_code_snippet %}function userId#
virtual int64_t userId() =0用户ID（唯一）
Return: int64_t
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="userId" %}{% endlanying_code_snippet %}function category#
virtual UserCategory category() =0用户策略
Return: UserCategory
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="category" %}{% endlanying_code_snippet %}function username#
virtual const std::string & username() =0用户名（唯一）
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="username" %}{% endlanying_code_snippet %}function nickname#
virtual const std::string & nickname() =0用户昵称
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="nickname" %}{% endlanying_code_snippet %}function avatarRatelUrl#
virtual std::string avatarRatelUrl() =0用户ratel服务器头像url
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="avatarRatelUrl" %}{% endlanying_code_snippet %}function avatarUrl#
virtual std::string avatarUrl() =0用户头像url
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="avatarUrl" %}{% endlanying_code_snippet %}function avatarPath#
virtual std::string avatarPath() =0用户头像本地存储路径
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="avatarPath" %}{% endlanying_code_snippet %}function avatarThumbnailPath#
virtual std::string avatarThumbnailPath() =0用户头像缩略图本地存储路径
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="avatarThumbnailPath" %}{% endlanying_code_snippet %}function mobilePhone#
virtual const std::string & mobilePhone() =0用户手机
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="mobilePhone" %}{% endlanying_code_snippet %}function email#
virtual const std::string & email() =0用户邮箱
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="email" %}{% endlanying_code_snippet %}function publicInfo#
virtual const JSON & publicInfo() =0用户公开扩展信息，好友可见
Return: JSON(std::string)
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="publicInfo" %}{% endlanying_code_snippet %}function privateInfo#
virtual const JSON & privateInfo() =0用户私有扩展信息，好友不可见
Return: JSON(std::string)
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="privateInfo" %}{% endlanying_code_snippet %}function addFriendAuthMode#
virtual AddFriendAuthMode addFriendAuthMode() =0加好友校验方式
Return: AddFriendAuthMode
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="addFriendAuthMode" %}{% endlanying_code_snippet %}function authQuestion#
virtual const AuthQuestion & authQuestion() =0添加好友时的验证问题
Return: [AuthQuestion]
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="authQuestion" %}{% endlanying_code_snippet %}function messageSetting#
virtual const MessageSetting & messageSetting() =0用户消息设定
Return: [MessageSetting]
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="messageSetting" %}{% endlanying_code_snippet %}function isAutoAcceptGroupInvite#
virtual bool isAutoAcceptGroupInvite() =0收到群组邀请进群时是否自动同意进群
Return: bool
Protected Functions Documentation#
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="isAutoAcceptGroupInvite" %}{% endlanying_code_snippet %}function BMXUserProfile#
inline BMXUserProfile()Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="BMXUserProfile" %}{% endlanying_code_snippet %}Updated on 2022-01-26 at 17:20:40 +0800