InputEvents.hpp

Go to the documentation of this file.

/*
    DiscordCoreAPI, A bot library for Discord, written in C++, and featuring explicit multithreading through the usage of custom, asynchronous C++ CoRoutines.
 
    Copyright 2021, 2022 Chris M. (RealTimeChris)
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
    USA
*/
/// InputEvents.hpp - Header for the input-event handler class.
/// Aug 18, 2021
/// https://discordcoreapi.com
/// \file InputEvents.hpp
 
#pragma once
 
#include <discordcoreapi/FoundationEntities.hpp>
#include <discordcoreapi/InteractionEntities.hpp>
#include <discordcoreapi/MessageEntities.hpp>
 
namespace DiscordCoreAPI {
 
    /**
     * \addtogroup main_endpoints
     * @{
     */
    /// \brief For handling User input - Messages or Interactions.
    class DiscordCoreAPI_Dll InputEvents {
      public:
        /// \brief Responds to one of a number of types of "InputEvents".
        /// \param dataPackage A RespondToInputEventData structure.
        /// \returns An std::unique_ptr containing an InputEventData structure.
        static CoRoutine<InputEventData> respondToInputEventAsync(RespondToInputEventData dataPackage);
 
        /// \brief Deletes a previously sent "input-event-response".
        /// \param dataPackage A std::unique_ptr containing an InputEventData structure.
        /// \param timeDelayNew An int32_t representing the desired delay until the message is deleted, in Milliseconds.
        /// \returns A CoRoutine containing void.
        static CoRoutine<void> deleteInputEventResponseAsync(InputEventData& dataPackage, int32_t timeDelayNew = 0);
 
      protected:
        static InputEventData respondToInputEvent(CreateEphemeralInteractionResponseData& dataPackage);
 
        static InputEventData respondToInputEvent(CreateDeferredInteractionResponseData& dataPackage);
 
        static InputEventData respondToInputEvent(CreateEphemeralFollowUpMessageData& dataPackage);
 
        static InputEventData respondToInputEvent(CreateInteractionResponseData& dataPackage);
 
        static InputEventData respondToInputEvent(EditInteractionResponseData& dataPackage);
 
        static InputEventData respondToInputEvent(CreateFollowUpMessageData& dataPackage);
 
        static InputEventData respondToInputEvent(EditFollowUpMessageData& dataPackage);
 
        static InputEventData respondToInputEvent(CreateMessageData& dataPackage);
 
        static InputEventData respondToInputEvent(EditMessageData& dataPackage);
    };
    /**@}*/
}// namespace DiscordCoreAPI