NIM Cocos2d-x SDK  2.2.0
Public Types | Static Public Member Functions | List of all members
nim::User Class Reference

NIM SDK提供的用户相关接口 More...

#include <nim_cpp_user.h>

Public Types

typedef std::function< void(const SpecialRelationshipChangeEvent &)> SpecialRelationshipChangedCallback
 
typedef std::function< void(NIMResCode res_code, const std::string &accid, bool set_opt)> SetRelationCallback
 
typedef SetRelationCallback SetBlackCallback
 
typedef SetRelationCallback SetMuteCallback
 
typedef std::function< void(NIMResCode res_code, const std::list< MuteListInfo > &)> GetMuteListCallback
 
typedef std::function< void(NIMResCode res_code, const std::list< BlackListInfo > &)> GetBlackListCallback
 
typedef std::function< void(const std::list< UserNameCard > &)> UserNameCardChangedCallback
 
typedef std::function< void(const std::list< UserNameCard > &)> GetUserNameCardCallback
 
typedef std::function< void(NIMResCode res_code)> UpdateMyUserNameCardCallback
 

Static Public Member Functions

static void RegSpecialRelationshipChangedCb (const SpecialRelationshipChangedCallback &cb, const std::string &json_extension="")
 
static bool SetBlack (const std::string &accid, bool set_black, const SetBlackCallback &cb, const std::string &json_extension="")
 
static bool SetMute (const std::string &accid, bool set_mute, const SetMuteCallback &cb, const std::string &json_extension="")
 
static void GetMutelist (const GetMuteListCallback &cb, const std::string &json_extension="")
 
static void GetBlacklist (const GetBlackListCallback &cb, const std::string &json_extension="")
 
static void RegUserNameCardChangedCb (const UserNameCardChangedCallback &cb, const std::string &json_extension="")
 
static bool GetUserNameCard (const std::list< std::string > &accids, const GetUserNameCardCallback &cb, const std::string &json_extension="")
 
static bool GetUserNameCardOnline (const std::list< std::string > &accids, const GetUserNameCardCallback &cb, const std::string &json_extension="")
 
static bool UpdateMyUserNameCard (const UserNameCard &namecard, const UpdateMyUserNameCardCallback &cb, const std::string &json_extension="")
 
static bool ParseBlackListInfoChange (const SpecialRelationshipChangeEvent &change_event, BlackListInfo &info)
 
static bool ParseMuteListInfoChange (const SpecialRelationshipChangeEvent &change_event, MuteListInfo &info)
 
static bool ParseSyncSpecialRelationshipChange (const SpecialRelationshipChangeEvent &change_event, std::list< BlackListInfo > &black_list, std::list< MuteListInfo > &mute_list)
 
static void UnregUserCb ()
 
static void UpdatePushToken (const std::string &cer_name, const std::string &token, int type)
 

Detailed Description

NIM SDK提供的用户相关接口

Copyright
(c) 2015-2017, NetEase Inc. All rights reserved
Author
towik, Oleg
Date
2015/8/17

Member Typedef Documentation

◆ GetBlackListCallback

typedef std::function<void(NIMResCode res_code, const std::list<BlackListInfo>&)> nim::User::GetBlackListCallback

设置黑名单列表回调模板

◆ GetMuteListCallback

typedef std::function<void(NIMResCode res_code, const std::list<MuteListInfo>&)> nim::User::GetMuteListCallback

获取静音列表回调模板

◆ GetUserNameCardCallback

typedef std::function<void(const std::list<UserNameCard>&)> nim::User::GetUserNameCardCallback

获取用户名片回调模板

◆ SetBlackCallback

typedef SetRelationCallback nim::User::SetBlackCallback

设置黑名单回调模板

◆ SetMuteCallback

typedef SetRelationCallback nim::User::SetMuteCallback

设置静音列表回调模板

◆ SetRelationCallback

typedef std::function<void(NIMResCode res_code, const std::string& accid, bool set_opt)> nim::User::SetRelationCallback

设置黑名单\静音列表回调模板

◆ SpecialRelationshipChangedCallback

typedef std::function<void(const SpecialRelationshipChangeEvent&)> nim::User::SpecialRelationshipChangedCallback

黑名单\静音列表变更事件通知回调模板

◆ UpdateMyUserNameCardCallback

typedef std::function<void(NIMResCode res_code)> nim::User::UpdateMyUserNameCardCallback

更新自己的名片回调模板

◆ UserNameCardChangedCallback

typedef std::function<void(const std::list<UserNameCard>&)> nim::User::UserNameCardChangedCallback

用户名片变更通知回调模板

Member Function Documentation

◆ GetBlacklist()

static void nim::User::GetBlacklist ( const GetBlackListCallback &  cb,
const std::string &  json_extension = "" 
)
static

获得黑名单名单

Parameters
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb
Returns
void 无返回值

◆ GetMutelist()

static void nim::User::GetMutelist ( const GetMuteListCallback &  cb,
const std::string &  json_extension = "" 
)
static

获得静音名单列表

Parameters
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功

◆ GetUserNameCard()

static bool nim::User::GetUserNameCard ( const std::list< std::string > &  accids,
const GetUserNameCardCallback &  cb,
const std::string &  json_extension = "" 
)
static

获取本地的指定帐号的用户名片

Parameters
[in]accids
[in]cb操作结果回调
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
void 无返回值
Note
错误码 200:成功 414:参数错误 20000:还未初始化或初始化未正常完成 20001:还未登陆或登录未完成

◆ GetUserNameCardOnline()

static bool nim::User::GetUserNameCardOnline ( const std::list< std::string > &  accids,
const GetUserNameCardCallback &  cb,
const std::string &  json_extension = "" 
)
static

在线查询指定帐号的用户名片

Parameters
[in]accids
[in]cb操作结果回调
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 414:参数错误 419:超限 20000:还未初始化或初始化未正常完成 20001:还未登陆或登录未完成

◆ ParseBlackListInfoChange()

static bool nim::User::ParseBlackListInfoChange ( const SpecialRelationshipChangeEvent &  change_event,
BlackListInfo &  info 
)
static

解析黑名单变更通知

Parameters
[in]change_event特殊关系变更通知
[out]info解析结果
Returns
bool 解析是否成功

◆ ParseMuteListInfoChange()

static bool nim::User::ParseMuteListInfoChange ( const SpecialRelationshipChangeEvent &  change_event,
MuteListInfo &  info 
)
static

解析静音名单变更通知

Parameters
[in]change_event特殊关系变更通知
[out]info解析结果
Returns
bool 解析是否成功

◆ ParseSyncSpecialRelationshipChange()

static bool nim::User::ParseSyncSpecialRelationshipChange ( const SpecialRelationshipChangeEvent &  change_event,
std::list< BlackListInfo > &  black_list,
std::list< MuteListInfo > &  mute_list 
)
static

解析多端同步特殊关系通知

Parameters
[in]change_event特殊关系变更通知
[out]black_list黑名单列表
[out]mute_list静音列表
Returns
bool 解析是否成功

◆ RegSpecialRelationshipChangedCb()

static void nim::User::RegSpecialRelationshipChangedCb ( const SpecialRelationshipChangedCallback &  cb,
const std::string &  json_extension = "" 
)
static

(全局回调)统一注册用户属性变更通知回调函数（多端同步黑名单、静音名单变更）

Parameters
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb
Returns
void 无返回值

◆ RegUserNameCardChangedCb()

static void nim::User::RegUserNameCardChangedCb ( const UserNameCardChangedCallback &  cb,
const std::string &  json_extension = "" 
)
static

(全局回调)统一注册用户名片变更通知回调函数

Parameters
[in]cb操作结果回调
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
void 无返回值

◆ SetBlack()

static bool nim::User::SetBlack ( const std::string &  accid,
bool  set_black,
const SetBlackCallback &  cb,
const std::string &  json_extension = "" 
)
static

设置、取消设置黑名单

Parameters
[in]accid好友id
[in]set_black取消或设置
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 419:黑名单数量超过上限

◆ SetMute()

static bool nim::User::SetMute ( const std::string &  accid,
bool  set_mute,
const SetMuteCallback &  cb,
const std::string &  json_extension = "" 
)
static

设置、取消设置静音名单

Parameters
[in]accid好友id
[in]set_mute取消或设置
[in]json_extensionjson扩展参数（备用，目前不需要）
[in]cb
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 419:静音列表数量超过上限

◆ UnregUserCb()

void nim::User::UnregUserCb ( )
static

反注册User提供的所有回调

Returns
void 无返回值

◆ UpdateMyUserNameCard()

static bool nim::User::UpdateMyUserNameCard ( const UserNameCard &  namecard,
const UpdateMyUserNameCardCallback &  cb,
const std::string &  json_extension = "" 
)
static

更新自己的用户名片

Parameters
[in]namecard用户名片内容
[in]cb操作结果回调
[in]json_extensionjson扩展参数（备用，目前不需要）
Returns
bool 检查参数如果不符合要求则返回失败
Note
错误码 200:成功 400:非法参数

◆ UpdatePushToken()

static void nim::User::UpdatePushToken ( const std::string &  cer_name,
const std::string &  token,
int  type 
)
static
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.14