NIM PC Cross Platform SDK
载入中...
搜索中...
未找到
nim::QChatSystemNotification结构体 参考

#include <nim_qchat_system_notification_cpp_def.h>

Public 成员函数

 QChatSystemNotification ()=default
 
 QChatSystemNotification (const NIMQChatSystemNotification &c_param)
 
NIMQChatSystemNotification ToCParam () const
 
void AdaptToType ()
 

Public 属性

uint64_t server_id {0}
 消息所属的server id
 
uint64_t channel_id {0}
 消息所属的channel id
 
std::string msg_id {""}
 消息id
 
NIMQChatSystemNotificationType msg_type {kNIMQChatSystemNotificationTypeUnkonwn}
 系统消息类型
 
std::string msg_body {""}
 消息内容
 
std::string msg_attach {""}
 消息附件
 
std::string msg_ext {""}
 消息扩展字段
 
bool resend_flag {false}
 重发标记,false:不是重发,true:是重发
 
std::vector< std::string > to_accids {}
 通知接受者账号列表
 
bool history_enable {false}
 false 或者 true, 是否存离线,只有 to_accids 不为空,才能设置为存离线,默认 false
 
std::string push_payload {""}
 自定义的推送属性,限制json
 
std::string push_content {""}
 自定义的推送内容
 
bool push_enable {false}
 是否需要推送, false: 不需要, true: 需要, 默认 false
 
bool need_badge {true}
 是否需要消息计数, false: 不需要, true: 需要, 默认 true
 
bool need_push_nick {true}
 是否需要推送昵称, false: 不需要, true: 需要, 默认 true
 
bool route_enable {true}
 是否需要抄送, false: 不需要, true: 需要, 默认 true
 
std::string env {""}
 环境变量,用于指向不同的抄送、第三方回调等配置
 
NIMQChatSystemNotificationToType to_type {kNIMQChatSystemNotificationToTypeUnknown}
 消息通知目标
 
NIMQChatSystemNotificationStatus status {kNIMQChatSystemNotificationNormal}
 消息状态
 
uint64_t msg_server_id {0}
 消息服务器端id
 
std::string from_accid {""}
 消息发送者的accid
 
uint32_t from_client_type {0}
 消息发送者的客户端类型
 
std::string from_device_id {""}
 消息发送者的设备id
 
std::string from_nick {""}
 消息发送者的昵称
 
uint64_t timestamp {0}
 消息发送时间戳
 
uint64_t update_timestamp {0}
 消息更新时间戳
 
std::shared_ptr< QChatSystemNotificationDataBasemsg_data {nullptr}
 消息数据
 
std::string callback_ext {""}
 回调扩展字段
 

Protected 属性

std::string to_accids_json_array
 

构造及析构函数说明

◆ QChatSystemNotification() [1/2]

nim::QChatSystemNotification::QChatSystemNotification ( )
default

◆ QChatSystemNotification() [2/2]

nim::QChatSystemNotification::QChatSystemNotification ( const NIMQChatSystemNotification c_param)
inline

成员函数说明

◆ AdaptToType()

void nim::QChatSystemNotification::AdaptToType ( )
inline

◆ ToCParam()

NIMQChatSystemNotification nim::QChatSystemNotification::ToCParam ( ) const
inline

类成员变量说明

◆ callback_ext

std::string nim::QChatSystemNotification::callback_ext {""}

回调扩展字段

◆ channel_id

uint64_t nim::QChatSystemNotification::channel_id {0}

消息所属的channel id

◆ env

std::string nim::QChatSystemNotification::env {""}

环境变量,用于指向不同的抄送、第三方回调等配置

◆ from_accid

std::string nim::QChatSystemNotification::from_accid {""}

消息发送者的accid

◆ from_client_type

uint32_t nim::QChatSystemNotification::from_client_type {0}

消息发送者的客户端类型

◆ from_device_id

std::string nim::QChatSystemNotification::from_device_id {""}

消息发送者的设备id

◆ from_nick

std::string nim::QChatSystemNotification::from_nick {""}

消息发送者的昵称

◆ history_enable

bool nim::QChatSystemNotification::history_enable {false}

false 或者 true, 是否存离线,只有 to_accids 不为空,才能设置为存离线,默认 false

◆ msg_attach

std::string nim::QChatSystemNotification::msg_attach {""}

消息附件

◆ msg_body

std::string nim::QChatSystemNotification::msg_body {""}

消息内容

◆ msg_data

std::shared_ptr<QChatSystemNotificationDataBase> nim::QChatSystemNotification::msg_data {nullptr}

消息数据

◆ msg_ext

std::string nim::QChatSystemNotification::msg_ext {""}

消息扩展字段

◆ msg_id

std::string nim::QChatSystemNotification::msg_id {""}

消息id

◆ msg_server_id

uint64_t nim::QChatSystemNotification::msg_server_id {0}

消息服务器端id

◆ msg_type

系统消息类型

◆ need_badge

bool nim::QChatSystemNotification::need_badge {true}

是否需要消息计数, false: 不需要, true: 需要, 默认 true

◆ need_push_nick

bool nim::QChatSystemNotification::need_push_nick {true}

是否需要推送昵称, false: 不需要, true: 需要, 默认 true

◆ push_content

std::string nim::QChatSystemNotification::push_content {""}

自定义的推送内容

◆ push_enable

bool nim::QChatSystemNotification::push_enable {false}

是否需要推送, false: 不需要, true: 需要, 默认 false

◆ push_payload

std::string nim::QChatSystemNotification::push_payload {""}

自定义的推送属性,限制json

◆ resend_flag

bool nim::QChatSystemNotification::resend_flag {false}

重发标记,false:不是重发,true:是重发

◆ route_enable

bool nim::QChatSystemNotification::route_enable {true}

是否需要抄送, false: 不需要, true: 需要, 默认 true

◆ server_id

uint64_t nim::QChatSystemNotification::server_id {0}

消息所属的server id

◆ status

消息状态

◆ timestamp

uint64_t nim::QChatSystemNotification::timestamp {0}

消息发送时间戳

◆ to_accids

std::vector<std::string> nim::QChatSystemNotification::to_accids {}

通知接受者账号列表

◆ to_accids_json_array

std::string nim::QChatSystemNotification::to_accids_json_array
mutableprotected

◆ to_type

消息通知目标

◆ update_timestamp

uint64_t nim::QChatSystemNotification::update_timestamp {0}

消息更新时间戳


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