For executing a web_hook. More...

#include <WebHookEntities.hpp>

Inheritance diagram for discord_core_api::execute_web_hook_data:

Public Member Functions
execute_web_hook_data &	addAllowedMentions (const allowed_mentions_data dataPackage)
	For setting the allowable mentions in a response. More...

execute_web_hook_data &	addButton (bool disabled, jsonifier::string_view customIdNew, jsonifier::string_view buttonLabel, button_style buttonStyle, jsonifier::string_view emojiName="", snowflake emojiId=snowflake{}, jsonifier::string_view url="")
	Adds a button to the response message_data. More...

execute_web_hook_data &	addComponentRow (const action_row_data dataPackage)
	For setting the components in a response. More...

execute_web_hook_data &	addContent (jsonifier::string_view dataPackage)
	For setting the content in a response. More...

execute_web_hook_data &	addFile (const file &theFile)
	Adds a file to the current collection of files for this message response. More...

execute_web_hook_data &	addMessageEmbed (const embed_data dataPackage)
	For setting the embeds in a response. More...

execute_web_hook_data &	addModal (jsonifier::string_view topTitleNew, jsonifier::string_view topCustomIdNew, jsonifier::string_view titleNew, jsonifier::string_view customIdNew, bool required, int32_t minLength, int32_t maxLength, text_input_style inputStyle, jsonifier::string_view label="", jsonifier::string_view placeholder="")
	Adds a modal to the response message_data. More...

execute_web_hook_data &	addSelectMenu (bool disabled, jsonifier::string_view customIdNew, const jsonifier::vector< select_option_data > &options, jsonifier::string_view placeholder, int32_t maxValues, int32_t minValues, select_menu_type type, const jsonifier::vector< channel_type > &channelTypes=jsonifier::vector< channel_type >{})
	Adds a select-menu to the response message_data. More...

execute_web_hook_data &	setTTSStatus (bool enabledTTs)
	For setting the tts status of a response. More...

Public Data Members
snowflake	threadId {}
	Send a message to the specified thread within a webhook's channel_data. the thread will automatically be unarchived.

bool	wait {}
	Waits for server confirmation of message send before response, and returns the created message body.

Member Function Documentation

◆ addAllowedMentions()

execute_web_hook_data & discord_core_api::execute_web_hook_data::addAllowedMentions ( const allowed_mentions_data dataPackage )

Parameters

dataPackage an allowed_mentions_data structure.

Returns: message_response_base& a reference to this data structure.

Definition at line 168 of file WebHookEntities.cpp.

◆ addButton()

execute_web_hook_data & discord_core_api::execute_web_hook_data::addButton	(	bool	disabled,
		jsonifier::string_view	customIdNew,
		jsonifier::string_view	buttonLabel,
		button_style	buttonStyle,
		jsonifier::string_view	emojiName = `""`,
		snowflake	emojiId = `snowflake{}`,
		jsonifier::string_view	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: respond_to_input_event_data& a reference to this data structure.

Definition at line 81 of file WebHookEntities.cpp.

◆ addComponentRow()

execute_web_hook_data & discord_core_api::execute_web_hook_data::addComponentRow ( const action_row_data dataPackage )

Parameters

dataPackage an action_row_data structure.

Returns: message_response_base& a reference to this data structure.

Definition at line 173 of file WebHookEntities.cpp.

◆ addContent()

execute_web_hook_data & discord_core_api::execute_web_hook_data::addContent ( jsonifier::string_view dataPackage )

Parameters

dataPackage a string, containing the content.

Returns: message_response_base& a reference to this data structure.

Definition at line 183 of file WebHookEntities.cpp.

◆ addFile()

execute_web_hook_data & discord_core_api::execute_web_hook_data::addFile ( const file & theFile )

Parameters

theFile the file to be added.

Returns: message_response_base& a reference to this data structure.

Definition at line 163 of file WebHookEntities.cpp.

◆ addMessageEmbed()

execute_web_hook_data & discord_core_api::execute_web_hook_data::addMessageEmbed ( const embed_data dataPackage )

Parameters

dataPackage an embed_data structure.

Returns: message_response_base& a reference to this data structure.

Definition at line 178 of file WebHookEntities.cpp.

◆ addModal()

execute_web_hook_data & discord_core_api::execute_web_hook_data::addModal	(	jsonifier::string_view	topTitleNew,
		jsonifier::string_view	topCustomIdNew,
		jsonifier::string_view	titleNew,
		jsonifier::string_view	customIdNew,
		bool	required,
		int32_t	minLength,
		int32_t	maxLength,
		text_input_style	inputStyle,
		jsonifier::string_view	label = `""`,
		jsonifier::string_view	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: respond_to_input_event_data& a reference to this data structure.

Definition at line 133 of file WebHookEntities.cpp.

◆ addSelectMenu()

execute_web_hook_data & discord_core_api::execute_web_hook_data::addSelectMenu	(	bool	disabled,
		jsonifier::string_view	customIdNew,
		const jsonifier::vector< select_option_data > &	options,
		jsonifier::string_view	placeholder,
		int32_t	maxValues,
		int32_t	minValues,
		select_menu_type	type,
		const jsonifier::vector< channel_type > &	channelTypes = `jsonifier::vector<channel_type>{}`
	)

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 channel_type.

Returns: respond_to_input_event_data& a reference to this data structure.

Definition at line 107 of file WebHookEntities.cpp.

◆ setTTSStatus()

execute_web_hook_data & discord_core_api::execute_web_hook_data::setTTSStatus ( bool enabledTTs )

Parameters

enabledTTs a bool.

Returns: message_response_base& a reference to this data structure.

Definition at line 188 of file WebHookEntities.cpp.

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

Public Member Functions

Public Data Members

Member Function Documentation

◆ addAllowedMentions()

◆ addButton()

◆ addComponentRow()

◆ addContent()

◆ addFile()

◆ addMessageEmbed()

◆ addModal()

◆ addSelectMenu()

◆ setTTSStatus()