DiscordCoreAPI
A Discord bot library written in C++, with custom asynchronous coroutines.
|
Data for responding to an input-event. More...
#include <FoundationEntities.hpp>
Public Member Functions | |
respond_to_input_event_data & | addAllowedMentions (const allowed_mentions_data dataPackage) |
For setting the allowable mentions in a response. More... | |
respond_to_input_event_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... | |
respond_to_input_event_data & | addComponentRow (const action_row_data dataPackage) |
For setting the components in a response. More... | |
respond_to_input_event_data & | addContent (jsonifier::string_view dataPackage) |
For setting the message content in a response. More... | |
respond_to_input_event_data & | addFile (const file &theFile) |
Adds a file to the current collection of files for this message response. More... | |
respond_to_input_event_data & | addMessageEmbed (const embed_data dataPackage) |
For setting the embeds in a response. More... | |
respond_to_input_event_data & | addModal (jsonifier::string_view topTitleNew, jsonifier::string_view topCustomIdNew, jsonifier::string_view titleNew, jsonifier::string_view customIdNew, bool required, uint64_t minLength, uint64_t maxLength, text_input_style inputStyle, jsonifier::string_view label="", jsonifier::string_view placeholder="") |
Adds a modal to the response message_data. More... | |
respond_to_input_event_data & | addSelectMenu (bool disabled, jsonifier::string_view customIdNew, const jsonifier::vector< select_option_data > &options, jsonifier::string_view placeholder, uint64_t maxValues, uint64_t minValues, select_menu_type type, jsonifier::vector< channel_type > channelTypes=jsonifier::vector< channel_type >{}) |
Adds a select-menu to the response message_data. More... | |
respond_to_input_event_data & | setAutoCompleteChoice (discord_core_internal::etf_serializer value, jsonifier::string_view theName, unordered_map< jsonifier::string, jsonifier::string > theNameLocalizations) |
For setting the choices of an autocomplete response. More... | |
respond_to_input_event_data & | setResponseType (input_event_response_type typeNew) |
For setting the type of response to make. More... | |
respond_to_input_event_data & | setTargetUserID (const snowflake targetUserIdNew) |
For setting the direct-message_data user target of a response. More... | |
respond_to_input_event_data & | setTTSStatus (bool enabledTTs) |
For setting the tts status of a response. More... | |
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::addAllowedMentions | ( | const allowed_mentions_data | dataPackage | ) |
dataPackage | an allowed_mentions_data structure. |
Definition at line 858 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_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 = "" |
||
) |
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. |
Definition at line 771 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::addComponentRow | ( | const action_row_data | dataPackage | ) |
dataPackage | an action_row_data structure. |
Definition at line 868 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::addContent | ( | jsonifier::string_view | dataPackage | ) |
dataPackage | a string, containing the content. |
Definition at line 878 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::addFile | ( | const file & | theFile | ) |
theFile | the file to be added. |
Definition at line 853 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::addMessageEmbed | ( | const embed_data | dataPackage | ) |
dataPackage | an embed_data structure. |
Definition at line 873 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::addModal | ( | jsonifier::string_view | topTitleNew, |
jsonifier::string_view | topCustomIdNew, | ||
jsonifier::string_view | titleNew, | ||
jsonifier::string_view | customIdNew, | ||
bool | required, | ||
uint64_t | minLength, | ||
uint64_t | maxLength, | ||
text_input_style | inputStyle, | ||
jsonifier::string_view | label = "" , |
||
jsonifier::string_view | placeholder = "" |
||
) |
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. |
Definition at line 823 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::addSelectMenu | ( | bool | disabled, |
jsonifier::string_view | customIdNew, | ||
const jsonifier::vector< select_option_data > & | options, | ||
jsonifier::string_view | placeholder, | ||
uint64_t | maxValues, | ||
uint64_t | minValues, | ||
select_menu_type | type, | ||
jsonifier::vector< channel_type > | channelTypes = jsonifier::vector<channel_type>{} |
||
) |
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. |
Definition at line 797 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::setAutoCompleteChoice | ( | discord_core_internal::etf_serializer | value, |
jsonifier::string_view | theName, | ||
unordered_map< jsonifier::string, jsonifier::string > | theNameLocalizations | ||
) |
value | an simdjson::ondemand::object value that is either a double, uint64_t or a string. |
theName | a string for the name of the choice. |
theNameLocalizations | a unordered_map<jsonifier::string, jsonifier::string> for the name localizations. |
Definition at line 888 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::setResponseType | ( | input_event_response_type | typeNew | ) |
typeNew | an input_event_response_type. |
Definition at line 863 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::setTargetUserID | ( | const snowflake | targetUserIdNew | ) |
targetUserIdNew | a string, containing the target user_data's id. |
Definition at line 898 of file FoundationEntities.cpp.
respond_to_input_event_data & discord_core_api::respond_to_input_event_data::setTTSStatus | ( | bool | enabledTTs | ) |
enabledTTs | a bool. |
Definition at line 883 of file FoundationEntities.cpp.