Mirai::ImageMessageImpl< MessageImpl > 模板类 参考

图片类消息 更多...

#include <ImageMessage.hpp>

类 Mirai::ImageMessageImpl< MessageImpl > 继承关系图:

Mirai::ImageMessageImpl< MessageImpl > 的协作图:

Public 成员函数
	ImageMessageImpl ()=default
	ImageMessageImpl (MiraiImage image)
	ImageMessageImpl (std::string ImageId, std::string url, std::string path, std::string base64)
MiraiImage	GetImage () const
	获取消息中的图片 更多...
MessageImpl &	SetImageId (std::string ImageId)
	设置图片id 更多...
MessageImpl &	SetUrl (std::string url)
	设置图片链接 更多...
MessageImpl &	SetPath (std::string path)
	设置图片路径 更多...
MessageImpl &	SetBase64 (std::string base64)
	设置图片base64编码 更多...
MessageImpl &	SetImage (MiraiImage image)
	由 MiraiImage 设置图片内容 更多...
Public 成员函数 继承自 Mirai::IMessageImpl< MessageImpl >
std::unique_ptr< IMessage >	clone () const override
Public 成员函数 继承自 Mirai::IMessage
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 成员函数
void	clear_ () noexcept
bool	isValid_ () const override
Protected 成员函数 继承自 Mirai::IMessageImpl< MessageImpl >
	IMessageImpl ()=default
MessageTypes	GetType_ () const override
bool	isSendSupported_ () const override
Protected 成员函数 继承自 Mirai::IMessage
	IMessage ()=default
virtual MessageTypes	GetType_ () const =0
virtual bool	isSendSupported_ () const =0
virtual bool	isValid_ () const =0

Protected 属性
MiraiImage	image_ {}

额外继承的成员函数
静态 Public 成员函数 继承自 Mirai::IMessageImpl< MessageImpl >
static constexpr MessageTypes	GetType ()
static constexpr bool	isSendSupported ()

详细描述

template<class MessageImpl>
class Mirai::ImageMessageImpl< MessageImpl >

图片类消息

Middleware for image related messages

在文件 ImageMessage.hpp 第 36 行定义.

构造及析构函数说明

ImageMessageImpl() [1/3]

template<class MessageImpl >

Mirai::ImageMessageImpl< MessageImpl >::ImageMessageImpl ( )

default

ImageMessageImpl() [2/3]

template<class MessageImpl >

Mirai::ImageMessageImpl< MessageImpl >::ImageMessageImpl ( MiraiImage  image )

inline

在文件 ImageMessage.hpp 第 47 行定义.

ImageMessageImpl() [3/3]

template<class MessageImpl >

Mirai::ImageMessageImpl< MessageImpl >::ImageMessageImpl ( std::string  ImageId, std::string  url, std::string  path, std::string  base64  )

inline

在文件 ImageMessage.hpp 第 48 行定义.

成员函数说明

clear_()

template<class MessageImpl >

void Mirai::ImageMessageImpl< MessageImpl >::clear_ ( )

inlineprotectednoexcept

在文件 ImageMessage.hpp 第 41 行定义.

isValid_()

template<class MessageImpl >

bool Mirai::ImageMessageImpl< MessageImpl >::isValid_ ( ) const

inlineoverrideprotectedvirtual

实现了 Mirai::IMessage.

在文件 ImageMessage.hpp 第 43 行定义.

GetImage()

template<class MessageImpl >

MiraiImage Mirai::ImageMessageImpl< MessageImpl >::GetImage ( ) const

inline

获取消息中的图片

返回

MiraiImage

在文件 ImageMessage.hpp 第 58 行定义.

SetImageId()

template<class MessageImpl >

MessageImpl & Mirai::ImageMessageImpl< MessageImpl >::SetImageId ( std::string  ImageId )

inline

设置图片id

发送图片只需要id、链接、路径、base64编码中的一个，因此该方法会清空其它的属性

参数

ImageId

图片id

在文件 ImageMessage.hpp 第 66 行定义.

SetUrl()

template<class MessageImpl >

MessageImpl & Mirai::ImageMessageImpl< MessageImpl >::SetUrl ( std::string  url )

inline

设置图片链接

发送图片只需要id、链接、路径、base64编码中的一个，因此该方法会清空其它的属性

参数

url

图片链接

在文件 ImageMessage.hpp 第 79 行定义.

SetPath()

template<class MessageImpl >

MessageImpl & Mirai::ImageMessageImpl< MessageImpl >::SetPath ( std::string  path )

inline

设置图片路径

发送图片只需要id、链接、路径、base64编码中的一个，因此该方法会清空其它的属性

参数

path

图片路径

在文件 ImageMessage.hpp 第 92 行定义.

SetBase64()

template<class MessageImpl >

MessageImpl & Mirai::ImageMessageImpl< MessageImpl >::SetBase64 ( std::string  base64 )

inline

设置图片base64编码

发送图片只需要id、链接、路径、base64编码中的一个，因此该方法会清空其它的属性

参数

base64

图片base64编码

在文件 ImageMessage.hpp 第 105 行定义.

SetImage()

template<class MessageImpl >

MessageImpl & Mirai::ImageMessageImpl< MessageImpl >::SetImage ( MiraiImage  image )

inline

由 MiraiImage 设置图片内容

在文件 ImageMessage.hpp 第 113 行定义.

类成员变量说明

image_

template<class MessageImpl >

MiraiImage Mirai::ImageMessageImpl< MessageImpl >::image_ {}

protected

在文件 ImageMessage.hpp 第 39 行定义.

---

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

• libmirai/models/libmirai/Messages/ImageMessage.hpp