Mirai::IMessage类 参考

Common interface for all message types 更多...

#include <IMessage.hpp>

类 Mirai::IMessage 继承关系图:

Public 成员函数
virtual	~IMessage ()=default
virtual std::unique_ptr< IMessage >	clone () const =0
MessageTypes	type () const
	Return the type of the class 更多...
bool	allowSend () const
	检查消息是否可以用于发送 更多...
bool	valid () const
	检查消息是否有效 更多...

Protected 成员函数
	IMessage ()=default
virtual MessageTypes	GetType_ () const =0
virtual bool	isSendSupported_ () const =0
virtual bool	isValid_ () const =0

详细描述

Common interface for all message types

在文件 IMessage.hpp 第 33 行定义.

构造及析构函数说明

IMessage()

Mirai::IMessage::IMessage ( )

protecteddefault

~IMessage()

virtual Mirai::IMessage::~IMessage ( )

virtualdefault

成员函数说明

GetType_()

virtual MessageTypes Mirai::IMessage::GetType_ ( ) const

protectedpure virtual

在 Mirai::IMessageImpl< Message >, Mirai::IMessageImpl< AppMessage >, Mirai::IMessageImpl< AtAllMessage >, Mirai::IMessageImpl< AtMessage >, Mirai::IMessageImpl< AudioMessage >, Mirai::IMessageImpl< DiceMessage >, Mirai::IMessageImpl< FaceMessage >, Mirai::IMessageImpl< FileMessage >, Mirai::IMessageImpl< FlashImageMessage >, Mirai::IMessageImpl< ForwardMessage >, Mirai::IMessageImpl< ImageMessage >, Mirai::IMessageImpl< MessageImpl >, Mirai::IMessageImpl< JsonMessage >, Mirai::IMessageImpl< MarketFaceMessage >, Mirai::IMessageImpl< MiraiCodeMessage >, Mirai::IMessageImpl< MusicShareMessage >, Mirai::IMessageImpl< PlainMessage >, Mirai::IMessageImpl< PokeMessage >, Mirai::IMessageImpl< QuoteMessage >, Mirai::IMessageImpl< SourceMessage > , 以及 Mirai::IMessageImpl< XmlMessage > 内被实现.

isSendSupported_()

virtual bool Mirai::IMessage::isSendSupported_ ( ) const

protectedpure virtual

在 Mirai::IMessageImpl< Message >, Mirai::IMessageImpl< AppMessage >, Mirai::IMessageImpl< AtAllMessage >, Mirai::IMessageImpl< AtMessage >, Mirai::IMessageImpl< AudioMessage >, Mirai::IMessageImpl< DiceMessage >, Mirai::IMessageImpl< FaceMessage >, Mirai::IMessageImpl< FileMessage >, Mirai::IMessageImpl< FlashImageMessage >, Mirai::IMessageImpl< ForwardMessage >, Mirai::IMessageImpl< ImageMessage >, Mirai::IMessageImpl< MessageImpl >, Mirai::IMessageImpl< JsonMessage >, Mirai::IMessageImpl< MarketFaceMessage >, Mirai::IMessageImpl< MiraiCodeMessage >, Mirai::IMessageImpl< MusicShareMessage >, Mirai::IMessageImpl< PlainMessage >, Mirai::IMessageImpl< PokeMessage >, Mirai::IMessageImpl< QuoteMessage >, Mirai::IMessageImpl< SourceMessage > , 以及 Mirai::IMessageImpl< XmlMessage > 内被实现.

isValid_()

virtual bool Mirai::IMessage::isValid_ ( ) const

protectedpure virtual

在 Mirai::DiceMessage, Mirai::MarketFaceMessage, Mirai::FileMessage, Mirai::ForwardMessage, Mirai::JsonMessage, Mirai::MiraiCodeMessage, Mirai::MusicShareMessage, Mirai::PlainMessage, Mirai::PokeMessage, Mirai::QuoteMessage, Mirai::SourceMessage, Mirai::XmlMessage, Mirai::FaceMessageImpl< Message >, Mirai::FaceMessageImpl< FaceMessage >, Mirai::FaceMessageImpl< MarketFaceMessage >, Mirai::ImageMessageImpl< MessageImpl >, Mirai::ImageMessageImpl< FlashImageMessage > , 以及 Mirai::ImageMessageImpl< ImageMessage > 内被实现.

clone()

virtual std::unique_ptr< IMessage > Mirai::IMessage::clone ( ) const

pure virtual

在 Mirai::IMessageImpl< Message >, Mirai::IMessageImpl< AppMessage >, Mirai::IMessageImpl< AtAllMessage >, Mirai::IMessageImpl< AtMessage >, Mirai::IMessageImpl< AudioMessage >, Mirai::IMessageImpl< DiceMessage >, Mirai::IMessageImpl< FaceMessage >, Mirai::IMessageImpl< FileMessage >, Mirai::IMessageImpl< FlashImageMessage >, Mirai::IMessageImpl< ForwardMessage >, Mirai::IMessageImpl< ImageMessage >, Mirai::IMessageImpl< MessageImpl >, Mirai::IMessageImpl< JsonMessage >, Mirai::IMessageImpl< MarketFaceMessage >, Mirai::IMessageImpl< MiraiCodeMessage >, Mirai::IMessageImpl< MusicShareMessage >, Mirai::IMessageImpl< PlainMessage >, Mirai::IMessageImpl< PokeMessage >, Mirai::IMessageImpl< QuoteMessage >, Mirai::IMessageImpl< SourceMessage > , 以及 Mirai::IMessageImpl< XmlMessage > 内被实现.

type()

MessageTypes Mirai::IMessage::type ( ) const

inline

Return the type of the class

返回

MessageTypes

在文件 IMessage.hpp 第 52 行定义.

allowSend()

bool Mirai::IMessage::allowSend ( ) const

inline

检查消息是否可以用于发送

部分消息仅支持接收

返回

bool

在文件 IMessage.hpp 第 60 行定义.

valid()

bool Mirai::IMessage::valid ( ) const

inline

检查消息是否有效

发送无效消息( valid() = false )会导致mirai-api-http返回400或500错误，并抛出异常。 检测的内容靠测试经验和mirai-api-http源码确定， valid() = true 不保证一定能发送成功。

返回

bool

在文件 IMessage.hpp 第 69 行定义.

---

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

• libmirai/models/libmirai/Messages/IMessage.hpp