floo::BMXRosterItem#
联系人
#include <bmx_roster_item.h>
Inherits from BMXBaseObject
Public Types#
| Name | |
|---|---|
| enum class | RosterRelation { Friend, Deleted, Stranger, Blocked} 好友关系 |
| enum class | AddFriendAuthMode { Open, NeedApproval, AnswerQuestion, RejectAll} roster 被申请加好友时的验证方式 |
Public Functions#
| Name | |
|---|---|
| virtual | ~BMXRosterItem() 析构函数 |
| virtual int64_t | rosterId() =0 好友Id |
| virtual const std::string & | username() =0 好友名 |
| virtual const std::string & | nickname() =0 好友昵称 |
| virtual std::string | avatarRatelUrl() =0 好友头像Ratel服务器地址 |
| virtual std::string | avatarUrl() =0 好友头像服务器地址 |
| virtual std::string | avatarPath() =0 好友头像本地存储路径 |
| virtual std::string | avatarThumbnailUrl() =0 好友头像缩略图服务器地址 |
| virtual std::string | avatarThumbnailPath() =0 好友头像缩略图本地存储路径 |
| virtual const JSON & | publicInfo() =0 扩展信息，用户设置的好友可以看到的信息，比如地址，个性签名等 |
| virtual const JSON & | alias() =0 用户对好友添加的备注等信息 |
| virtual const JSON & | ext() =0 用户的服务器扩展信息 |
| virtual const JSON & | localExt() =0 用户的本地扩展信息 |
| virtual RosterRelation | relation() =0 联系人关系 |
| virtual bool | isMuteNotification() =0 是否提醒用户消息 |
| virtual AddFriendAuthMode | addFriendAuthMode() =0 roster的好友添加验证方式。 |
| virtual const std::string & | authQuestion() =0 roster的好友验证问题。 |
Protected Functions#
| Name | |
|---|---|
| BMXRosterItem() |
Public Types Documentation#
enum RosterRelation#
| Enumerator | Value | Description |
|---|---|---|
| Friend | 好友 | |
| Deleted | 被删除 | |
| Stranger | 陌生人 | |
| Blocked | 被加入黑名单 |
好友关系
enum AddFriendAuthMode#
| Enumerator | Value | Description |
|---|---|---|
| Open | 无需验证，任何人可以加为好友 | |
| NeedApproval | 需要同意方可加为好友 | |
| AnswerQuestion | 需要回答问题正确方可加为好友 | |
| RejectAll | 拒绝所有加好友申请 |
roster 被申请加好友时的验证方式
Public Functions Documentation#
function ~BMXRosterItem#
inline virtual ~BMXRosterItem()析构函数
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="~BMXRosterItem" %}{% endlanying_code_snippet %}function rosterId#
virtual int64_t rosterId() =0好友Id
Return: int64_t
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="rosterId" %}{% endlanying_code_snippet %}function username#
virtual const std::string & username() =0好友名
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",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="BMXRosterItem",function="nickname" %}{% endlanying_code_snippet %}function avatarRatelUrl#
virtual std::string avatarRatelUrl() =0好友头像Ratel服务器地址
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="avatarRatelUrl" %}{% endlanying_code_snippet %}function avatarUrl#
virtual std::string avatarUrl() =0好友头像服务器地址
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="avatarUrl" %}{% endlanying_code_snippet %}function avatarPath#
virtual std::string avatarPath() =0好友头像本地存储路径
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="avatarPath" %}{% endlanying_code_snippet %}function avatarThumbnailUrl#
virtual std::string avatarThumbnailUrl() =0好友头像缩略图服务器地址
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="avatarThumbnailUrl" %}{% endlanying_code_snippet %}function avatarThumbnailPath#
virtual std::string avatarThumbnailPath() =0好友头像缩略图本地存储路径
Return: std::string
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="avatarThumbnailPath" %}{% endlanying_code_snippet %}function publicInfo#
virtual const JSON & publicInfo() =0扩展信息，用户设置的好友可以看到的信息，比如地址，个性签名等
Return: JSON(std::string)
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="publicInfo" %}{% endlanying_code_snippet %}function alias#
virtual const JSON & alias() =0用户对好友添加的备注等信息
Return: JSON(std::string)
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="alias" %}{% endlanying_code_snippet %}function ext#
virtual const JSON & ext() =0用户的服务器扩展信息
Return: JSON(std::string)
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="ext" %}{% endlanying_code_snippet %}function localExt#
virtual const JSON & localExt() =0用户的本地扩展信息
Return: JSON(std::string)
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="localExt" %}{% endlanying_code_snippet %}function relation#
virtual RosterRelation relation() =0联系人关系
Return: RosterRelation
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="relation" %}{% endlanying_code_snippet %}function isMuteNotification#
virtual bool isMuteNotification() =0是否提醒用户消息
Return: bool
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="isMuteNotification" %}{% endlanying_code_snippet %}function addFriendAuthMode#
virtual AddFriendAuthMode addFriendAuthMode() =0roster的好友添加验证方式。
Return: AddFriendAuthMode
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="addFriendAuthMode" %}{% endlanying_code_snippet %}function authQuestion#
virtual const std::string & authQuestion() =0roster的好友验证问题。
Return: std::string
Protected Functions Documentation#
Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="authQuestion" %}{% endlanying_code_snippet %}function BMXRosterItem#
inline BMXRosterItem()Example:
{% lanying_code_snippet repo="lanying-im-embedded",class="BMXRosterItem",function="BMXRosterItem" %}{% endlanying_code_snippet %}Updated on 2022-01-26 at 17:20:40 +0800