NIM PC Cross Platform SDK
nim::FriendProfile Struct Reference

云信好友 More...

#include <nim_friend_helper.h>

Public Member Functions

 FriendProfile ()
 
 FriendProfile (const std::string &accid)
 
void SetAccId (const std::string &accid)
 
std::string GetAccId () const
 
void SetRelationship (NIMFriendFlag flag)
 
NIMFriendFlag GetRelationship () const
 
void SetPassiveRelationship (NIMFriendFlag flag)
 
NIMFriendFlag GetPassiveRelationship () const
 
void SetSource (NIMFriendSource src)
 
NIMFriendSource GetSource () const
 
void SetAlias (const std::string &alias)
 
std::string GetAlias () const
 
void SetBits (int64_t bits)
 
int64_t GetBits () const
 
void SetEx (const nim_cpp_wrapper_util::Json::Value &ex)
 
nim_cpp_wrapper_util::Json::Value GetEx () const
 
void SetServerEx (const std::string &srv_ex)
 
std::string GetServerEx () const
 
void SetCreateTimetag (int64_t timetag)
 
int64_t GetCreateTimetag () const
 
void SetUpdateTimetag (int64_t timetag)
 
int64_t GetUpdateTimetag () const
 
bool ExistValue (FriendProfileKey key) const
 好友信息数据标记Key对应的数据是否有效(存在,非初始值状态) More...
 
std::string ToJsonString () const
 组装Json Value字符串 More...
 
void Update (const FriendProfile &profile)
 更新好友数据 More...
 

Public Attributes

std::string accid_
 用户账号
 
NIMFriendFlag relationship_
 主动的好友关系
 
NIMFriendFlag passive_relationship_
 被动的好友关系
 
NIMFriendSource source_
 好友来源
 
std::string alias_
 好友别名
 
int64_t bits_
 扩展数据
 
nim_cpp_wrapper_util::Json::Value expand_
 扩展数据
 
unsigned int value_available_flag_
 好友数据有效性,结合好友Key使用
 
std::string server_expand_
 扩展数据
 
int64_t create_timetag_
 好友创建时间戳(毫秒)
 
int64_t update_timetag_
 好友更新时间戳(毫秒)
 

Detailed Description

云信好友

Constructor & Destructor Documentation

◆ FriendProfile() [1/2]

nim::FriendProfile::FriendProfile ( )
inline

构造函数

◆ FriendProfile() [2/2]

nim::FriendProfile::FriendProfile ( const std::string &  accid)
inline

构造函数,推荐使用

Member Function Documentation

◆ ExistValue()

bool nim::FriendProfile::ExistValue ( FriendProfileKey  value_key) const
inline

好友信息数据标记Key对应的数据是否有效(存在,非初始值状态)

Parameters
[in]value_key好友信息数据标记Key
Returns
bool 有效性

◆ GetAccId()

std::string nim::FriendProfile::GetAccId ( ) const
inline

获取用户ID

◆ GetAlias()

std::string nim::FriendProfile::GetAlias ( ) const
inline

获取别称

◆ GetBits()

int64_t nim::FriendProfile::GetBits ( ) const
inline

获取扩展信息(int64)

◆ GetCreateTimetag()

int64_t nim::FriendProfile::GetCreateTimetag ( ) const
inline

获取档案创建时间(毫秒)

◆ GetEx()

nim_cpp_wrapper_util::Json::Value nim::FriendProfile::GetEx ( ) const
inline

获取扩展信息(json value)

◆ GetPassiveRelationship()

NIMFriendFlag nim::FriendProfile::GetPassiveRelationship ( ) const
inline

获取被动的好友关系

◆ GetRelationship()

NIMFriendFlag nim::FriendProfile::GetRelationship ( ) const
inline

获取主动的好友关系

◆ GetServerEx()

std::string nim::FriendProfile::GetServerEx ( ) const
inline

获取扩展信息(string)

◆ GetSource()

NIMFriendSource nim::FriendProfile::GetSource ( ) const
inline

获取好友来源

◆ GetUpdateTimetag()

int64_t nim::FriendProfile::GetUpdateTimetag ( ) const
inline

获取档案更新时间(毫秒)

◆ SetAccId()

void nim::FriendProfile::SetAccId ( const std::string &  accid)
inline

设置用户ID

◆ SetAlias()

void nim::FriendProfile::SetAlias ( const std::string &  alias)
inline

设置别称

◆ SetBits()

void nim::FriendProfile::SetBits ( int64_t  bits)
inline

设置扩展信息(int64)

◆ SetCreateTimetag()

void nim::FriendProfile::SetCreateTimetag ( int64_t  timetag)
inline

设置档案创建时间(毫秒)

◆ SetEx()

void nim::FriendProfile::SetEx ( const nim_cpp_wrapper_util::Json::Value ex)
inline

设置扩展信息(json value)

◆ SetPassiveRelationship()

void nim::FriendProfile::SetPassiveRelationship ( NIMFriendFlag  flag)
inline

设置被动的好友关系

◆ SetRelationship()

void nim::FriendProfile::SetRelationship ( NIMFriendFlag  flag)
inline

设置主动的好友关系

◆ SetServerEx()

void nim::FriendProfile::SetServerEx ( const std::string &  srv_ex)
inline

设置扩展信息(string)

◆ SetSource()

void nim::FriendProfile::SetSource ( NIMFriendSource  src)
inline

设置好友来源

◆ SetUpdateTimetag()

void nim::FriendProfile::SetUpdateTimetag ( int64_t  timetag)
inline

设置档案更新时间(毫秒)

◆ ToJsonString()

std::string nim::FriendProfile::ToJsonString ( ) const
inline

组装Json Value字符串

Returns
string Json Value字符串

◆ Update()

void nim::FriendProfile::Update ( const FriendProfile profile)
inline

更新好友数据

Parameters
[in]profile好友数据
Returns
void

The documentation for this struct was generated from the following file: