DiscordCoreAPI::MessageResponseBase Class Reference

Message response base, for responding to messages. More...

#include <FoundationEntities.hpp>

Inheritance diagram for DiscordCoreAPI::MessageResponseBase:

Public Member Functions
MessageResponseBase &	addAllowedMentions (AllowedMentionsData dataPackage)
	For setting the allowable mentions in a response.
MessageResponseBase &	addButton (bool disabled, const std::string &customIdNew, const std::string &buttonLabel, ButtonStyle buttonStyle, const std::string &emojiName="", Snowflake emojiId=Snowflake{}, const std::string &url="")
	Adds a button to the response Message.
MessageResponseBase &	addComponentRow (ActionRowData dataPackage)
	For setting the components in a response.
MessageResponseBase &	addContent (const std::string &dataPackage)
	For setting the Message content in a response.
MessageResponseBase &	addFile (File theFile)
	Adds a file to the current collection of files for this message response.
MessageResponseBase &	addMessageEmbed (EmbedData dataPackage)
	For setting the embeds in a response.
MessageResponseBase &	addModal (const std::string &topTitleNew, const std::string &topCustomIdNew, const std::string &titleNew, const std::string &customIdNew, bool required, int32_t minLength, int32_t maxLength, TextInputStyle inputStyle, const std::string &label="", const std::string &placeholder="")
	Adds a modal to the response Message.
MessageResponseBase &	addSelectMenu (bool disabled, const std::string &customIdNew, std::vector< SelectOptionData > options, const std::string &placeholder, int32_t maxValues, int32_t minValues, SelectMenuType type, std::vector< ChannelType > channelTypes=std::vector< ChannelType >{})
	Adds a select-menu to the response Message.
MessageResponseBase &	setTTSStatus (bool enabledTTs)
	For setting the tts status of a response.

Member Function Documentation

addAllowedMentions()

MessageResponseBase & DiscordCoreAPI::MessageResponseBase::addAllowedMentions

(

AllowedMentionsData

dataPackage

)

Parameters

dataPackage

An AllowedMentionsData structure.

Returns

MessageResponseBase& A reference to this data structure.

Definition at line 3863 of file FoundationEntities.cpp.

addButton()

MessageResponseBase & DiscordCoreAPI::MessageResponseBase::addButton	(	bool	disabled,
		const std::string &	customIdNew,
		const std::string &	buttonLabel,
		ButtonStyle	buttonStyle,
		const std::string &	emojiName = "",
		Snowflake	emojiId = Snowflake{},
		const std::string &	url = ""
	)

Parameters

disabled	Whether the button is active or not.
customIdNew	A custom id to give for identifying the button.
buttonLabel	A visible label for the button.
buttonStyle	The style of the button.
emojiName	An emoji name, if desired.
emojiId	An emoji id, if desired.
url	A url, if applicable.

Returns

MessageResponseBase& A reference to this data structure.

Definition at line 3775 of file FoundationEntities.cpp.

addComponentRow()

MessageResponseBase & DiscordCoreAPI::MessageResponseBase::addComponentRow

(

ActionRowData

dataPackage

)

Parameters

dataPackage

An ActionRowData structure.

Returns

MessageResponseBase& A reference to this data structure.

Definition at line 3868 of file FoundationEntities.cpp.

addContent()

MessageResponseBase & DiscordCoreAPI::MessageResponseBase::addContent

(

const std::string &

dataPackage

)

Parameters

dataPackage

A string, containing the content.

Returns

MessageResponseBase& A reference to this data structure.

Definition at line 3878 of file FoundationEntities.cpp.

addFile()

MessageResponseBase & DiscordCoreAPI::MessageResponseBase::addFile

(

File

theFile

)

Parameters

theFile

The file to be added.

Returns

MessageResponseBase& A reference to this data structure.

Definition at line 3858 of file FoundationEntities.cpp.

addMessageEmbed()

MessageResponseBase & DiscordCoreAPI::MessageResponseBase::addMessageEmbed

(

EmbedData

dataPackage

)

Parameters

dataPackage

An EmbedData structure.

Returns

MessageResponseBase& A reference to this data structure.

Definition at line 3873 of file FoundationEntities.cpp.

addModal()

MessageResponseBase & DiscordCoreAPI::MessageResponseBase::addModal	(	const std::string &	topTitleNew,
		const std::string &	topCustomIdNew,
		const std::string &	titleNew,
		const std::string &	customIdNew,
		bool	required,
		int32_t	minLength,
		int32_t	maxLength,
		TextInputStyle	inputStyle,
		const std::string &	label = "",
		const std::string &	placeholder = ""
	)

Parameters

topTitleNew	A title for the modal.
topCustomIdNew	A custom id to give for the modal.
titleNew	A title for the modal's individual input.
customIdNew	A custom id to give for the modal's individual input.
required	Is it a required response?
minLength	Minimum length.
maxLength	Maximum length.
inputStyle	The input style.
label	A label for the modal.
placeholder	A placeholder for the modal.

Returns

MessageResponseBase& A reference to this data structure.

Definition at line 3828 of file FoundationEntities.cpp.

addSelectMenu()

MessageResponseBase & DiscordCoreAPI::MessageResponseBase::addSelectMenu	(	bool	disabled,
		const std::string &	customIdNew,
		std::vector< SelectOptionData >	options,
		const std::string &	placeholder,
		int32_t	maxValues,
		int32_t	minValues,
		SelectMenuType	type,
		std::vector< ChannelType >	channelTypes = std::vector<ChannelType>{}
	)

Parameters

disabled	Whether the select-menu is active or not.
customIdNew	A custom id to give for identifying the select-menu.
options	A vector of select-menu-options to offer.
placeholder	Custom placeholder text if nothing is selected, max 100 characters.
maxValues	Maximum number of selections that are possible.
minValues	Minimum required number of selections that are required.
type	The type of select-menu that this is.
channelTypes	Types of channels that can be accepted if this is of the type ChannelType.

Returns

RespondToInputEventData& A reference to this data structure.

Definition at line 3801 of file FoundationEntities.cpp.

setTTSStatus()

MessageResponseBase & DiscordCoreAPI::MessageResponseBase::setTTSStatus

(

bool

enabledTTs

)

Parameters

enabledTTs

A bool.

Returns

MessageResponseBase& A reference to this data structure.

Definition at line 3883 of file FoundationEntities.cpp.

---

The documentation for this class was generated from the following files:

• FoundationEntities.hpp
• FoundationEntities.cpp