NIM 跨平台 C++ SDK
载入中...
搜索中...
未找到
Public 成员函数 | Public 属性 | 所有成员列表
nim::MessageSetting结构体 参考

消息属性设置 更多...

#include <nim_talk_helper.h>

Public 成员函数

 MessageSetting ()
 
void ToJsonValue (nim_cpp_wrapper_util::Json::Value &message) const
 组装Json Value字符串
 
nim_cpp_wrapper_util::Json::Value ToJsonValue () const
 
void ParseMessageSetting (const nim_cpp_wrapper_util::Json::Value &message)
 从Json Value解析出消息属性设置
 

Public 属性

BoolStatus resend_flag_
 该消息是否为重发状态
 
BoolStatus server_history_saved_
 该消息是否存储云端历史
 
BoolStatus roaming_
 该消息是否支持漫游
 
BoolStatus self_sync_
 该消息是否支持发送者多端同步
 
BoolStatus need_push_
 是否需要推送
 
BoolStatus push_need_badge_
 是否要做消息计数
 
BoolStatus push_need_prefix_
 需要推送昵称
 
BoolStatus routable_
 是否要抄送
 
BoolStatus is_blacklisted_
 是否被拉黑
 
BoolStatus need_offline_
 是否支持离线消息
 
nim_cpp_wrapper_util::Json::Value push_payload_
 第三方自定义的推送属性，长度2048
 
std::string push_content_
 自定义推送文案，长度限制200字节
 
nim_cpp_wrapper_util::Json::Value server_ext_
 第三方扩展字段, 长度限制1024
 
std::string local_ext_
 本地扩展字段, 格式不限，长度限制1024
 
BoolStatus is_force_push_
 群组消息强推开关，强推全员设置true并强推列表为空
 
std::list< std::string > force_push_ids_list_
 群组消息强推列表
 
std::string force_push_content_
 群组消息强推文本
 
BoolStatus anti_spam_enable_
 是否需要过易盾反垃圾
 
std::string anti_spam_content_
 (可选)开发者自定义的反垃圾字段,长度限制5000
 
std::string anti_apam_biz_id_
 (可选)用户配置的对某些单条消息另外的反垃圾的业务ID
 
int anti_apam_using_yidun_
 int, (可选) 单条消息是否使用易盾反垃圾 0:(在开通易盾的情况下)不过易盾反垃圾
 
BoolStatus client_anti_spam_hitting_
 (可选) 是否命中客户端反垃圾
 
BoolStatus team_msg_need_ack_
 群消息是否需要已读业务，0：不需要，1：需要
 
BoolStatus team_msg_ack_sent_
 是否已经发送群消息已读回执
 
int team_msg_unread_count_
 群消息未读数
 
BoolStatus is_update_session_
 (可选) 消息是否需要刷新到session服务，0:否，1:是；只有消息存离线的情况下，才会判断该参数，缺省：1
 
std::string yidun_anti_cheating_
 (可选)String, 易盾反垃圾增强反作弊专属字段, 限制json，长度限制1024
 
std::string env_config_
 (可选)String, 环境变量，用于指向不同的抄送、第三方回调等配置(于8.0.0添加)
 
std::string anti_spam_ext
 (可选)String, 易盾反垃圾扩展字段，限制 json，长度限制 1024
 
std::string anti_spam_res
 String, 易盾反垃圾返回的结果字段
 

详细描述

消息属性设置

构造及析构函数说明

◆ MessageSetting()

nim::MessageSetting::MessageSetting ( )
inline

构造函数

成员函数说明

◆ ParseMessageSetting()

void nim::MessageSetting::ParseMessageSetting ( const nim_cpp_wrapper_util::Json::Value & message)
inline

从Json Value解析出消息属性设置

参数
[in]message消息Json
返回
void

◆ ToJsonValue() [1/2]

nim_cpp_wrapper_util::Json::Value nim::MessageSetting::ToJsonValue ( ) const
inline

◆ ToJsonValue() [2/2]

void nim::MessageSetting::ToJsonValue ( nim_cpp_wrapper_util::Json::Value & message) const
inline

组装Json Value字符串

参数
[out]message消息Json
返回
void

类成员变量说明

◆ anti_apam_biz_id_

std::string nim::MessageSetting::anti_apam_biz_id_

(可选)用户配置的对某些单条消息另外的反垃圾的业务ID

◆ anti_apam_using_yidun_

int nim::MessageSetting::anti_apam_using_yidun_

int, (可选) 单条消息是否使用易盾反垃圾 0:(在开通易盾的情况下)不过易盾反垃圾

◆ anti_spam_content_

std::string nim::MessageSetting::anti_spam_content_

(可选)开发者自定义的反垃圾字段,长度限制5000

◆ anti_spam_enable_

BoolStatus nim::MessageSetting::anti_spam_enable_

是否需要过易盾反垃圾

◆ anti_spam_ext

std::string nim::MessageSetting::anti_spam_ext

(可选)String, 易盾反垃圾扩展字段，限制 json，长度限制 1024

◆ anti_spam_res

std::string nim::MessageSetting::anti_spam_res

String, 易盾反垃圾返回的结果字段

◆ client_anti_spam_hitting_

BoolStatus nim::MessageSetting::client_anti_spam_hitting_

(可选) 是否命中客户端反垃圾

◆ env_config_

std::string nim::MessageSetting::env_config_

(可选)String, 环境变量，用于指向不同的抄送、第三方回调等配置(于8.0.0添加)

◆ force_push_content_

std::string nim::MessageSetting::force_push_content_

群组消息强推文本

◆ force_push_ids_list_

std::list<std::string> nim::MessageSetting::force_push_ids_list_

群组消息强推列表

◆ is_blacklisted_

BoolStatus nim::MessageSetting::is_blacklisted_

是否被拉黑

◆ is_force_push_

BoolStatus nim::MessageSetting::is_force_push_

群组消息强推开关，强推全员设置true并强推列表为空

◆ is_update_session_

BoolStatus nim::MessageSetting::is_update_session_

(可选) 消息是否需要刷新到session服务，0:否，1:是；只有消息存离线的情况下，才会判断该参数，缺省：1

◆ local_ext_

std::string nim::MessageSetting::local_ext_

本地扩展字段, 格式不限，长度限制1024

◆ need_offline_

BoolStatus nim::MessageSetting::need_offline_

是否支持离线消息

◆ need_push_

BoolStatus nim::MessageSetting::need_push_

是否需要推送

◆ push_content_

std::string nim::MessageSetting::push_content_

自定义推送文案，长度限制200字节

◆ push_need_badge_

BoolStatus nim::MessageSetting::push_need_badge_

是否要做消息计数

◆ push_need_prefix_

BoolStatus nim::MessageSetting::push_need_prefix_

需要推送昵称

◆ push_payload_

nim_cpp_wrapper_util::Json::Value nim::MessageSetting::push_payload_

第三方自定义的推送属性，长度2048

◆ resend_flag_

BoolStatus nim::MessageSetting::resend_flag_

该消息是否为重发状态

◆ roaming_

BoolStatus nim::MessageSetting::roaming_

该消息是否支持漫游

◆ routable_

BoolStatus nim::MessageSetting::routable_

是否要抄送

◆ self_sync_

BoolStatus nim::MessageSetting::self_sync_

该消息是否支持发送者多端同步

◆ server_ext_

nim_cpp_wrapper_util::Json::Value nim::MessageSetting::server_ext_

第三方扩展字段, 长度限制1024

◆ server_history_saved_

BoolStatus nim::MessageSetting::server_history_saved_

该消息是否存储云端历史

◆ team_msg_ack_sent_

BoolStatus nim::MessageSetting::team_msg_ack_sent_

是否已经发送群消息已读回执

◆ team_msg_need_ack_

BoolStatus nim::MessageSetting::team_msg_need_ack_

群消息是否需要已读业务，0：不需要，1：需要

◆ team_msg_unread_count_

int nim::MessageSetting::team_msg_unread_count_

群消息未读数

◆ yidun_anti_cheating_

std::string nim::MessageSetting::yidun_anti_cheating_

(可选)String, 易盾反垃圾增强反作弊专属字段, 限制json，长度限制1024

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