cpp-mirai-client  v2.6.1
cpp client for mirai-api-http
Mirai::MusicShareMessage类 参考final

音乐分享卡片消息 更多...

#include <MusicShareMessage.hpp>

类 Mirai::MusicShareMessage 继承关系图:
[图例]
Mirai::MusicShareMessage 的协作图:
[图例]

Public 成员函数

 MusicShareMessage ()=default
 
 MusicShareMessage (MusicShareType kind, std::string title, std::string summary, std::string JumpUrl, std::string PictureUrl, std::string MusicUrl, std::string brief)
 
MusicShareType GetKind () const
 获取分享种类 更多...
 
std::string GetTitle () const
 获取标题 更多...
 
std::string GetSummary () const
 获取介绍 更多...
 
std::string GetJumpUrl () const
 获取转跳链接 更多...
 
std::string GetPictureUrl () const
 获取封面图片连接 更多...
 
std::string GetMusicUrl () const
 获取音乐链接 更多...
 
std::string GetBrief () const
 获取简介 更多...
 
MusicShareMessageSetKind (MusicShareType kind)
 设置分享种类 更多...
 
MusicShareMessageSetTitle (std::string title)
 设置标题 更多...
 
MusicShareMessageSetSummary (std::string summary)
 设置介绍 更多...
 
MusicShareMessageSetJumpUrl (std::string JumpUrl)
 设置转跳链接 更多...
 
MusicShareMessageSetPictureUrl (std::string PictureUrl)
 设置封面图片连接 更多...
 
MusicShareMessageSetMusicUrl (std::string MusicUrl)
 设置音乐链接 更多...
 
MusicShareMessageSetBrief (std::string brief)
 设置简介 更多...
 
- Public 成员函数 继承自 Mirai::IMessageImpl< MusicShareMessage >
std::unique_ptr< IMessageclone () const override
 
- Public 成员函数 继承自 Mirai::IMessage
virtual ~IMessage ()=default
 
virtual std::unique_ptr< IMessageclone () const =0
 
MessageTypes type () const
 Return the type of the class 更多...
 
bool allowSend () const
 检查消息是否可以用于发送 更多...
 
bool valid () const
 检查消息是否有效 更多...
 

Protected 成员函数

bool isValid_ () const final
 
- Protected 成员函数 继承自 Mirai::IMessageImpl< MusicShareMessage >
 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 属性

MusicShareType kind_ = MusicShareType::ENUM_END
 
std::string title_ {}
 
std::string summary_ {}
 
std::string JumpUrl_ {}
 
std::string PictureUrl_ {}
 
std::string MusicUrl_ {}
 
std::string brief_ {}
 

静态 Protected 属性

static constexpr MessageTypes TYPE_ = MessageTypes::MUSIC_SHARE
 
static constexpr bool SUPPORT_SEND_ = true
 

额外继承的成员函数

- 静态 Public 成员函数 继承自 Mirai::IMessageImpl< MusicShareMessage >
static constexpr MessageTypes GetType ()
 
static constexpr bool isSendSupported ()
 

详细描述

构造及析构函数说明

◆ MusicShareMessage() [1/2]

Mirai::MusicShareMessage::MusicShareMessage ( )
default

◆ MusicShareMessage() [2/2]

Mirai::MusicShareMessage::MusicShareMessage ( MusicShareType  kind,
std::string  title,
std::string  summary,
std::string  JumpUrl,
std::string  PictureUrl,
std::string  MusicUrl,
std::string  brief 
)
inline

在文件 MusicShareMessage.hpp69 行定义.

成员函数说明

◆ isValid_()

bool Mirai::MusicShareMessage::isValid_ ( ) const
inlinefinalprotectedvirtual

实现了 Mirai::IMessage.

在文件 MusicShareMessage.hpp59 行定义.

◆ GetKind()

MusicShareType Mirai::MusicShareMessage::GetKind ( ) const
inline

获取分享种类

在文件 MusicShareMessage.hpp82 行定义.

◆ GetTitle()

std::string Mirai::MusicShareMessage::GetTitle ( ) const
inline

获取标题

在文件 MusicShareMessage.hpp84 行定义.

◆ GetSummary()

std::string Mirai::MusicShareMessage::GetSummary ( ) const
inline

获取介绍

在文件 MusicShareMessage.hpp86 行定义.

◆ GetJumpUrl()

std::string Mirai::MusicShareMessage::GetJumpUrl ( ) const
inline

获取转跳链接

在文件 MusicShareMessage.hpp88 行定义.

◆ GetPictureUrl()

std::string Mirai::MusicShareMessage::GetPictureUrl ( ) const
inline

获取封面图片连接

在文件 MusicShareMessage.hpp90 行定义.

◆ GetMusicUrl()

std::string Mirai::MusicShareMessage::GetMusicUrl ( ) const
inline

获取音乐链接

在文件 MusicShareMessage.hpp92 行定义.

◆ GetBrief()

std::string Mirai::MusicShareMessage::GetBrief ( ) const
inline

获取简介

简介为未打开会话窗口时显示的简要文字消息

在文件 MusicShareMessage.hpp98 行定义.

◆ SetKind()

MusicShareMessage & Mirai::MusicShareMessage::SetKind ( MusicShareType  kind)
inline

设置分享种类

在文件 MusicShareMessage.hpp101 行定义.

◆ SetTitle()

MusicShareMessage & Mirai::MusicShareMessage::SetTitle ( std::string  title)
inline

设置标题

在文件 MusicShareMessage.hpp107 行定义.

◆ SetSummary()

MusicShareMessage & Mirai::MusicShareMessage::SetSummary ( std::string  summary)
inline

设置介绍

在文件 MusicShareMessage.hpp113 行定义.

◆ SetJumpUrl()

MusicShareMessage & Mirai::MusicShareMessage::SetJumpUrl ( std::string  JumpUrl)
inline

设置转跳链接

在文件 MusicShareMessage.hpp119 行定义.

◆ SetPictureUrl()

MusicShareMessage & Mirai::MusicShareMessage::SetPictureUrl ( std::string  PictureUrl)
inline

设置封面图片连接

在文件 MusicShareMessage.hpp125 行定义.

◆ SetMusicUrl()

MusicShareMessage & Mirai::MusicShareMessage::SetMusicUrl ( std::string  MusicUrl)
inline

设置音乐链接

在文件 MusicShareMessage.hpp131 行定义.

◆ SetBrief()

MusicShareMessage & Mirai::MusicShareMessage::SetBrief ( std::string  brief)
inline

设置简介

在文件 MusicShareMessage.hpp137 行定义.

类成员变量说明

◆ kind_

MusicShareType Mirai::MusicShareMessage::kind_ = MusicShareType::ENUM_END
protected

在文件 MusicShareMessage.hpp48 行定义.

◆ title_

std::string Mirai::MusicShareMessage::title_ {}
protected

在文件 MusicShareMessage.hpp49 行定义.

◆ summary_

std::string Mirai::MusicShareMessage::summary_ {}
protected

在文件 MusicShareMessage.hpp50 行定义.

◆ JumpUrl_

std::string Mirai::MusicShareMessage::JumpUrl_ {}
protected

在文件 MusicShareMessage.hpp51 行定义.

◆ PictureUrl_

std::string Mirai::MusicShareMessage::PictureUrl_ {}
protected

在文件 MusicShareMessage.hpp52 行定义.

◆ MusicUrl_

std::string Mirai::MusicShareMessage::MusicUrl_ {}
protected

在文件 MusicShareMessage.hpp53 行定义.

◆ brief_

std::string Mirai::MusicShareMessage::brief_ {}
protected

在文件 MusicShareMessage.hpp54 行定义.

◆ TYPE_

constexpr MessageTypes Mirai::MusicShareMessage::TYPE_ = MessageTypes::MUSIC_SHARE
staticconstexprprotected

在文件 MusicShareMessage.hpp56 行定义.

◆ SUPPORT_SEND_

constexpr bool Mirai::MusicShareMessage::SUPPORT_SEND_ = true
staticconstexprprotected

在文件 MusicShareMessage.hpp57 行定义.


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