nim_chatroom::ChatRoomEnterInfo结构体 参考

聊天室登录信息 更多...

#include <nim_chatroom_helper.h>

Public 成员函数
void	SetNick (const std::string &nick)
	设置进入聊天室后展示的昵称,选填
void	SetAvatar (const std::string &avatar)
	设置进入聊天室后展示的头像,选填
void	SetExt (const nim_cpp_wrapper_util::Json::Value &ext)
	设置聊天室可用的扩展字段,选填
void	SetNotifyExt (const nim_cpp_wrapper_util::Json::Value &notify_ext)
	设置进入聊天室通知开发者扩展字段,选填
void	SetLoginTag (const std::list< std::string > &login_tags)
	设置登录携带的 tag 列表，允许多个
void	SetNotifyTags (const std::string &expression)
	登录时携带的 notify tag 表达式
void	SetLocation (NIMChatRoomLocation location)
	登录聊天室时传递的位置信息
void	EnableLocation (bool enable)
	是否启用聊天室空间位置信息功能，启用后 SetLocation 功能才生效，否则 SDK 不解析 Location 信息
void	SetAuthType (int auth_type)
	设置鉴权方式
void	SetLoginExt (const std::string &login_ext)
	登录自定义字段
void	SetAntiSpamBusinessID (const std::string &anti_spam_business_id)
std::string	ToJsonString () const
	组装Json Value字符串

Public 属性
nim_cpp_wrapper_util::Json::Value	values_

详细描述

聊天室登录信息

成员函数说明

EnableLocation()

void nim_chatroom::ChatRoomEnterInfo::EnableLocation ( bool enable )

inline

是否启用聊天室空间位置信息功能，启用后 SetLocation 功能才生效，否则 SDK 不解析 Location 信息

参数

enable

true 为启用，false 为关闭，该功能默认关闭

返回

void

SetAntiSpamBusinessID()

void nim_chatroom::ChatRoomEnterInfo::SetAntiSpamBusinessID ( const std::string & anti_spam_business_id )

inline

SetAuthType()

nim_chatroom::ChatRoomEnterInfo::SetAuthType ( int auth_type )

inline

设置鉴权方式

参数

auth_type

0表示最初的loginToken的校验方式，1表示基于appSecret计算的token鉴权方式，2表示基于第三方回调的token鉴权方式，默认0

返回

void

SetAvatar()

void nim_chatroom::ChatRoomEnterInfo::SetAvatar ( const std::string & avatar )

inline

设置进入聊天室后展示的头像,选填

参数

[in]

avatar

聊天室头像下载地址

返回

void

SetExt()

void nim_chatroom::ChatRoomEnterInfo::SetExt ( const nim_cpp_wrapper_util::Json::Value & ext )

inline

设置聊天室可用的扩展字段,选填

参数

[in]

ext

聊天室可用的扩展字段

返回

void

SetLocation()

void nim_chatroom::ChatRoomEnterInfo::SetLocation ( NIMChatRoomLocation location )

inline

登录聊天室时传递的位置信息

参数

location

位置坐标描述

返回

void

SetLoginExt()

nim_chatroom::ChatRoomEnterInfo::SetLoginExt ( const std::string & login_ext )

inline

登录自定义字段

配置反垃圾相关业务id

参数

login_ext

用于提交给用户的第三方回调服务进行登录检测

返回

void

参数

anti_spam_business_id

用于配置反垃圾相关业务id

返回

void

SetLoginTag()

void nim_chatroom::ChatRoomEnterInfo::SetLoginTag ( const std::list< std::string > & login_tags )

inline

设置登录携带的 tag 列表，允许多个

参数

login_tags

要设置的 tag 列表

返回

void

SetNick()

void nim_chatroom::ChatRoomEnterInfo::SetNick ( const std::string & nick )

inline

设置进入聊天室后展示的昵称,选填

参数

[in]

nick

聊天室昵称

返回

void

SetNotifyExt()

void nim_chatroom::ChatRoomEnterInfo::SetNotifyExt ( const nim_cpp_wrapper_util::Json::Value & notify_ext )

inline

设置进入聊天室通知开发者扩展字段,选填

参数

[in]

notify_ext

进入聊天室通知开发者扩展字段

返回

void

SetNotifyTags()

void nim_chatroom::ChatRoomEnterInfo::SetNotifyTags ( const std::string & expression )

inline

登录时携带的 notify tag 表达式

参数

expression

表达式字符串，如 {"tag": "abc"} or {"tag": "def"}

返回

void

ToJsonString()

std::string nim_chatroom::ChatRoomEnterInfo::ToJsonString ( ) const

inline

组装Json Value字符串

返回

void

类成员变量说明

values_

nim_cpp_wrapper_util::Json::Value nim_chatroom::ChatRoomEnterInfo::values_

---

该结构体的文档由以下文件生成:

• D:/GitLab/builds/wydSYb3b/0/nim-pc/california/nim-cross-platform-sdk/exports/wrapper/nim_chatroom_cpp_wrapper/helper/nim_chatroom_helper.h