floo::BMXRosterItem
Contact
#include <bmx_roster_item.h>
Inherits from BMXBaseObject
Public Types
| Name | |
|---|---|
| enum class | RosterRelation { Friend, Deleted, Stranger, Blocked} Friend relationship |
| enum class | AddFriendAuthMode { Open, NeedApproval, AnswerQuestion, RejectAll} How roster authenticated when requested to be a friend |
Public Functions
| Name | |
|---|---|
| virtual | ~BMXRosterItem() Destructor |
| virtual int64_t | rosterId() =0 Friend id |
| virtual const std::string & | username() =0 Friend name |
| virtual const std::string & | nickname() =0 Friend nickname |
| virtual std::string | avatarRatelUrl() =0 Ratel server address of friend avatar |
| virtual std::string | avatarUrl() =0 Friend avatar thumbnail server address |
| virtual std::string | avatarPath() =0 Local storage path of friend avatar |
| virtual std::string | avatarThumbnailUrl() =0 Server address of friend avatar thumbnail |
| virtual std::string | avatarThumbnailPath() =0 Local storage path of friend avatar thumbnail |
| virtual const JSON & | publicInfo() =0 Extension information which is visible to user's friends, such as address, personal state and more |
| virtual const JSON & | alias() =0 Comments added by user to adding friend |
| virtual const JSON & | ext() =0 User's server extension information |
| virtual const JSON & | localExt() =0 User's local extension information |
| virtual RosterRelation | relation() =0 Contact relationship |
| virtual bool | isMuteNotification() =0 Whether to alert user for message |
| virtual AddFriendAuthMode | addFriendAuthMode() =0 How roster to validate adding friend. |
| virtual const std::string & | authQuestion() =0 How roster to validate friend. |
Protected Functions
| Name | |
|---|---|
| BMXRosterItem() |
Public Types Documentation
enum RosterRelation
| Enumerator | Value | Description |
|---|---|---|
| Friend | Friend | |
| Deleted | Deleted | |
| Stranger | Stranger | |
| Blocked | Blacklisted |
Friend relationship
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 roster authenticated when requested to be a friend
Public Functions Documentation
function ~BMXRosterItem
inline virtual ~BMXRosterItem()
Destructor
Example:
function rosterId
virtual int64_t rosterId() =0
Friend id
Return: int64_t
Example:
function username
virtual const std::string & username() =0
Friend name
Return: std::string
Example:
function nickname
virtual const std::string & nickname() =0
Friend nickname
Return: std::string
Example:
function avatarRatelUrl
virtual std::string avatarRatelUrl() =0
Ratel server address of friend avatar
Return: std::string
Example:
function avatarUrl
virtual std::string avatarUrl() =0
Friend avatar thumbnail server address
Return: std::string
Example:
function avatarPath
virtual std::string avatarPath() =0
Local storage path of friend avatar
Return: std::string
Example:
function avatarThumbnailUrl
virtual std::string avatarThumbnailUrl() =0
Server address of friend avatar thumbnail
Return: std::string
Example:
function avatarThumbnailPath
virtual std::string avatarThumbnailPath() =0
Local storage path of friend avatar thumbnail
Return: std::string
Example:
function publicInfo
virtual const JSON & publicInfo() =0
Extension information which is visible to user's friends, such as address, personal state and more
Return: JSON(std::string)
Example:
function alias
virtual const JSON & alias() =0
Comments added by user to adding friend
Return: JSON(std::string)
Example:
function ext
virtual const JSON & ext() =0
User's server extension information
Return: JSON(std::string)
Example:
function localExt
virtual const JSON & localExt() =0
User's local extension information
Return: JSON(std::string)
Example:
function relation
virtual RosterRelation relation() =0
Contact relationship
Return: RosterRelation
Example:
function isMuteNotification
virtual bool isMuteNotification() =0
Whether to alert user for message
Return: bool
Example:
function addFriendAuthMode
virtual AddFriendAuthMode addFriendAuthMode() =0
How roster to validate adding friend.
Return: AddFriendAuthMode
Example:
function authQuestion
virtual const std::string & authQuestion() =0
How roster to validate friend.
Return: std::string
Protected Functions Documentation
Example:
function BMXRosterItem
inline BMXRosterItem()
Example:
Updated on 2022-01-26 at 17:20:40 +0800