cpp-mirai-client  v2.6.1
cpp client for mirai-api-http
Mirai::ForwardMessage::Node类 参考

转发消息节点,代表一条转发消息 更多...

#include <ForwardMessageNode.hpp>

Mirai::ForwardMessage::Node 的协作图:
[图例]

struct  MessageRef
 

Public 成员函数

 Node ()=default
 
 ~Node ()=default
 
bool valid () const
 
QQ_t GetSenderId () const
 获取发送者QQ 更多...
 
std::time_t GetTimestamp () const
 获取发送时间 更多...
 
std::string GetSenderName () const
 获取发送者名称 更多...
 
MessageChain GetMessageChain () const
 获取消息链 更多...
 
bool hasMessageId () const
 是否含有消息id 更多...
 
std::optional< MessageId_tGetMessageId () const
 获取消息id 更多...
 
NodeSetSenderId (QQ_t SenderId)
 设置发送者 更多...
 
NodeSetTimestamp (std::time_t time)
 设置发送时间戳 更多...
 
NodeSetSenderName (const std::string &SenderName)
 设置发送者名称 更多...
 
NodeSetMessageChain (const MessageChain &message)
 设置消息内容 更多...
 
NodeSetMessageChain (MessageChain &&message)
 设置消息内容 更多...
 
NodeSetMessageId (MessageId_t MessageId)
 设置消息id,限定为当前会话内的消息 更多...
 
NodeSetMessageRef (MessageId_t MessageId, UID_t target)
 设置消息来源,需要指定消息上下文 更多...
 

Protected 属性

QQ_t SenderId_ {}
 
std::time_t time_ = 0
 
std::string SenderName_ {}
 
MessageChain message_ {}
 
std::optional< MessageId_tMessageId_ = std::nullopt
 
std::optional< MessageRefref_ = std::nullopt
 

详细描述

转发消息节点,代表一条转发消息

接收消息时会传入 MessageChain,消息id一般为 null。 发送时可以选择使用消息链手动构造转发消息或传入消息id自动引用历史消息, 优先级为 MessageId > MessageChain

Member Variable Default Value
Node::SenderId_ 0_qq
Node::time_ 0
Node::SenderName_ ""
Node::message_ MessageChain{}
Node::MessageId_ std::nullopt
Node::ref_ std::nullopt

在文件 ForwardMessageNode.hpp42 行定义.

构造及析构函数说明

◆ Node()

Mirai::ForwardMessage::Node::Node ( )
default

◆ ~Node()

Mirai::ForwardMessage::Node::~Node ( )
default

成员函数说明

◆ valid()

bool Mirai::ForwardMessage::Node::valid ( ) const
inline

在文件 ForwardMessageNode.hpp62 行定义.

◆ GetSenderId()

QQ_t Mirai::ForwardMessage::Node::GetSenderId ( ) const
inline

获取发送者QQ

在文件 ForwardMessageNode.hpp68 行定义.

◆ GetTimestamp()

std::time_t Mirai::ForwardMessage::Node::GetTimestamp ( ) const
inline

获取发送时间

在文件 ForwardMessageNode.hpp70 行定义.

◆ GetSenderName()

std::string Mirai::ForwardMessage::Node::GetSenderName ( ) const
inline

获取发送者名称

在文件 ForwardMessageNode.hpp72 行定义.

◆ GetMessageChain()

MessageChain Mirai::ForwardMessage::Node::GetMessageChain ( ) const
inline

获取消息链

在文件 ForwardMessageNode.hpp74 行定义.

◆ hasMessageId()

bool Mirai::ForwardMessage::Node::hasMessageId ( ) const
inline

是否含有消息id

在文件 ForwardMessageNode.hpp76 行定义.

◆ GetMessageId()

std::optional< MessageId_t > Mirai::ForwardMessage::Node::GetMessageId ( ) const
inline

获取消息id

在文件 ForwardMessageNode.hpp79 行定义.

◆ SetSenderId()

Node & Mirai::ForwardMessage::Node::SetSenderId ( QQ_t  SenderId)
inline

设置发送者

在文件 ForwardMessageNode.hpp85 行定义.

◆ SetTimestamp()

Node & Mirai::ForwardMessage::Node::SetTimestamp ( std::time_t  time)
inline

设置发送时间戳

在文件 ForwardMessageNode.hpp91 行定义.

◆ SetSenderName()

Node & Mirai::ForwardMessage::Node::SetSenderName ( const std::string &  SenderName)
inline

设置发送者名称

在文件 ForwardMessageNode.hpp97 行定义.

◆ SetMessageChain() [1/2]

Node & Mirai::ForwardMessage::Node::SetMessageChain ( const MessageChain message)
inline

设置消息内容

在文件 ForwardMessageNode.hpp103 行定义.

◆ SetMessageChain() [2/2]

Node & Mirai::ForwardMessage::Node::SetMessageChain ( MessageChain &&  message)
inline

设置消息内容

在文件 ForwardMessageNode.hpp110 行定义.

◆ SetMessageId()

Node & Mirai::ForwardMessage::Node::SetMessageId ( MessageId_t  MessageId)
inline

设置消息id,限定为当前会话内的消息

在文件 ForwardMessageNode.hpp117 行定义.

◆ SetMessageRef()

Node & Mirai::ForwardMessage::Node::SetMessageRef ( MessageId_t  MessageId,
UID_t  target 
)
inline

设置消息来源,需要指定消息上下文

在文件 ForwardMessageNode.hpp123 行定义.

类成员变量说明

◆ SenderId_

QQ_t Mirai::ForwardMessage::Node::SenderId_ {}
protected

在文件 ForwardMessageNode.hpp45 行定义.

◆ time_

std::time_t Mirai::ForwardMessage::Node::time_ = 0
protected

在文件 ForwardMessageNode.hpp46 行定义.

◆ SenderName_

std::string Mirai::ForwardMessage::Node::SenderName_ {}
protected

在文件 ForwardMessageNode.hpp47 行定义.

◆ message_

MessageChain Mirai::ForwardMessage::Node::message_ {}
protected

在文件 ForwardMessageNode.hpp48 行定义.

◆ MessageId_

std::optional<MessageId_t> Mirai::ForwardMessage::Node::MessageId_ = std::nullopt
protected

在文件 ForwardMessageNode.hpp49 行定义.

◆ ref_

std::optional<MessageRef> Mirai::ForwardMessage::Node::ref_ = std::nullopt
protected

在文件 ForwardMessageNode.hpp56 行定义.


该类的文档由以下文件生成: