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:

function userId

virtual int64_t userId() =0

User ID (unique)

Return: int64_t

Example:

BMXMessagePtr msg = BMXMessage::createMessage(profile->userId(), toId, (BMXMessage::MessageType)type, toId, params[2]);

function category

virtual UserCategory category() =0

User policy

Return: UserCategory

Example:

function username

virtual const std::string & username() =0

Username (unique)

Return: std::string

Example:

function nickname

virtual const std::string & nickname() =0

User nickname

Return: std::string

Example:

function avatarRatelUrl

virtual std::string avatarRatelUrl() =0

User ratel server avatar url

Return: std::string

Example:

function avatarUrl

virtual std::string avatarUrl() =0

User avatar url

Return: std::string

Example:

function avatarPath

virtual std::string avatarPath() =0

Local storage path of user avatar

Return: std::string

Example:

function avatarThumbnailPath

virtual std::string avatarThumbnailPath() =0

Local storage path of user avatar thumbnail

Return: std::string

Example:

function mobilePhone

virtual const std::string & mobilePhone() =0

User mobile phone

Return: std::string

Example:

function email

virtual const std::string & email() =0

User email

Return: std::string

Example:

function publicInfo

virtual const JSON & publicInfo() =0

User public extension information, visible to friends

Return: JSON(std::string)

Example:

function privateInfo

virtual const JSON & privateInfo() =0

User private extension information, not visible to friends

Return: JSON(std::string)

Example:

function addFriendAuthMode

virtual AddFriendAuthMode addFriendAuthMode() =0

How to validate when adding friend

Return: AddFriendAuthMode

Example:

function authQuestion

virtual const AuthQuestion & authQuestion() =0

Authentication questions when adding friend

Return: [AuthQuestion]

Example:

function messageSetting

virtual const MessageSetting & messageSetting() =0

User message settings

Return: [MessageSetting]

Example:

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:

function BMXUserProfile

inline BMXUserProfile()

Example:


Updated on 2022-01-26 at 17:20:40 +0800

© 2019-2024 MaximTop | Homepage | Site Map Last modified time: 2024-12-02 01:02:48

results matching ""

    No results matching ""