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