ButtonCollector, for collecting button input from one or more Users. More...

Public Member Functions
	ButtonCollector (InputEventData &dataPackage)
	Constructor.

CoRoutine< std::vector< ButtonResponseData > >	collectButtonData (bool getButtonDataForAllNew, int32_t maxWaitTimeInMsNew, int32_t maxNumberOfPressesNew, CreateInteractionResponseData errorMessageDataNew, Snowflake targetUserId=Snowflake{})
	Used to collect the button inputs from one or more users.

void	collectButtonData (std::function< bool(InteractionData)> triggerFunctionNew, DiscordCoreInternal::TriggerEventDelegate< void, InteractionData > functionNew)
	Used to collect the button inputs from one or more users.

Constructor & Destructor Documentation

◆ ButtonCollector()

DiscordCoreAPI::ButtonCollector::ButtonCollector ( InputEventData & dataPackage )

Parameters

dataPackage An InputEventData structure, from the response that came from the submitted button.

Definition at line 589 of file InteractionEntities.cpp.

Here is the call graph for this function:

CoRoutine< std::vector< ButtonResponseData > > DiscordCoreAPI::ButtonCollector::collectButtonData	(	bool	getButtonDataForAllNew,
		int32_t	maxWaitTimeInMsNew,
		int32_t	maxNumberOfPressesNew,
		CreateInteractionResponseData	errorMessageDataNew,
		Snowflake	targetUserId = `Snowflake{}`
	)

Parameters

getButtonDataForAllNew	Whether or not to collect input from a single target User or all potential users.
maxWaitTimeInMsNew	The maximum amount of time to wait for new inputs, in milliseconds.
maxNumberOfPressesNew	The maximum number of inputs to collect before stopping.
errorMessageDataNew	The message-data for when an individual other than the selected individual attemps to use this interaction.
targetUserId	The id of the single User to collect inputs from, if getButtonDataForAllNew is set to false.

Definition at line 597 of file InteractionEntities.cpp.

void DiscordCoreAPI::ButtonCollector::collectButtonData	(	std::function< bool(InteractionData)>	triggerFunctionNew,
		DiscordCoreInternal::TriggerEventDelegate< void, InteractionData >	functionNew
	)

Parameters

triggerFunctionNew	A std::function<bool(InteractionData)> to decide whether or not to trigger the event's main function.
functionNew	Takes a DiscordCoreInternal::TriggerEventDelegate<void, InteractionData> as a function to be executed upon returning true from the "trigger-function".

Definition at line 615 of file InteractionEntities.cpp.

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