floo::BMXUserProfile#

User Profile

#include <bmx_user_profile.h>

Inherits from BMXBaseObject

Public Types#

	Name
enum class	AddFriendAuthMode { Open, NeedApproval, AnswerQuestion, RejectAll} How to validate when adding friend
enum class	UserCategory { Normal, Advanced} User type

Public Functions#

	Name
virtual	~BMXUserProfile() Destructor
virtual int64_t	userId() =0 User ID (unique)
virtual UserCategory	category() =0 User policy
virtual const std::string &	username() =0 Username (unique)
virtual const std::string &	nickname() =0 User nickname
virtual std::string	avatarRatelUrl() =0 User ratel server avatar url
virtual std::string	avatarUrl() =0 User avatar url
virtual std::string	avatarPath() =0 Local storage path of user avatar
virtual std::string	avatarThumbnailPath() =0 Local storage path of user avatar thumbnail
virtual const std::string &	mobilePhone() =0 User mobile phone
virtual const std::string &	email() =0 User email
virtual const JSON &	publicInfo() =0 User public extension information, visible to friends
virtual const JSON &	privateInfo() =0 User private extension information, not visible to friends
virtual AddFriendAuthMode	addFriendAuthMode() =0 How to validate when adding friend
virtual const [AuthQuestion] &	authQuestion() =0 Authentication questions when adding friend
virtual const [MessageSetting] &	messageSetting() =0 User message settings
virtual bool	isAutoAcceptGroupInvite() =0 Whether to automatically agree to join group when a group invitation is received

Protected Functions#

	Name
	BMXUserProfile()

Public Types Documentation#

enum AddFriendAuthMode#

Enumerator	Value	Description
Open		No authentication required, anyone can be added as a friend
NeedApproval		Consent is required to be added as a friend
AnswerQuestion		Need to answer authentication question correctly to be added as a friend
RejectAll		Reject all adding friend requests

How to validate when adding friend

enum UserCategory#

Enumerator	Value	Description
Normal		Normal user
Advanced		Power user

User type

Public Functions Documentation#

function ~BMXUserProfile#

inline virtual ~BMXUserProfile()

Destructor

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="~BMXUserProfile" %}{% endlanying_code_snippet %}

function userId#

virtual int64_t userId() =0

Unique user 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

User policy

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

Username (unique)

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

User display name

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

User ratel server avatar 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

User avatar 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

Local storage path of user avatar

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

Local storage path of user avatar thumbnail

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

User mobile phone

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

User email

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

User public extension information, visible to friends

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

User private extension information, not visible to friends

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

How to validate when adding friend

Return: AddFriendAuthMode

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="addFriendAuthMode" %}{% endlanying_code_snippet %}

function authQuestion#

virtual const AuthQuestion & authQuestion() =0

Authentication questions when adding friend

Return: [AuthQuestion]

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="authQuestion" %}{% endlanying_code_snippet %}

function messageSetting#

virtual const MessageSetting & messageSetting() =0

User message settings

Return: [MessageSetting]

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXUserProfile",function="messageSetting" %}{% endlanying_code_snippet %}

function isAutoAcceptGroupInvite#

virtual bool isAutoAcceptGroupInvite() =0

Whether to automatically agree to join group when a group invitation is received

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