StickerEntities.hpp

Go to the documentation of this file.

/*
    MIT License
 
    DiscordCoreAPI, A bot library for Discord, written in C++, and featuring explicit multithreading through the usage of custom, asynchronous C++ CoRoutines.
 
    Copyright 2022, 2023 Chris M. (RealTimeChris)
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in all
    copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    SOFTWARE.
*/
/// StickerEntities.hpp - Header for the sticker related classes and structs.
/// May 13, 2021
/// https://discordcoreapi.com
/// \file StickerEntities.hpp
 
#pragma once
 
#include <discordcoreapi/FoundationEntities.hpp>
#include <discordcoreapi/CoRoutine.hpp>
 
namespace DiscordCoreAPI {
 
    /**
     * \addtogroup foundation_entities
     * @{
     */
 
    /// @brief For getting a StickerData object for the given sticker ID.
    struct GetStickerData {
        Snowflake stickerId{};///< The chosen StickerData's Snowflake.
    };
 
    /// @brief For collecting a list of Stickers from a chosen Guild.
    struct GetGuildStickersData {
        Snowflake guildId{};///< The chosen Guild from which you would like to collect the Stickers from.
    };
 
    /// @brief For creating a single StickerData.
    struct CreateGuildStickerData {
        std::string description{};///< Description of the StickerData.
        std::string reason{};///< The reason for creating the StickerData.
        Snowflake guildId{};///< The Guild within which to create the StickerData.
        std::string file{};///< The sticker file to upload, must be a Png, Apng, or Lottie JSON file, max 500 KB.
        std::string name{};///< Name of the StickerData.
        std::string tags{};///< Autocomplete / suggestion tags for the sticker(max 200 characters).
    };
 
    /// @brief For modifying a single StickerData.
    struct ModifyGuildStickerData {
        std::string description{};///< Description of the StickerData.
        Snowflake stickerId{};///< The StickerData you wish to modify.
        std::string reason{};///< The reason for modifying the StickerData.
        Snowflake guildId{};///< The Guild within which to modify the StickerData.
        std::string name{};///< Name of the StickerData.
        std::string tags{};///< Autocomplete / suggestion tags for the sticker(max 200 characters).
    };
 
    /// @brief For deleting a single StickerData.
    struct DeleteGuildStickerData {
        Snowflake stickerId{};///< The StickerData you wish to delete.
        std::string reason{};///< The reason for deleting the StickerData.
        Snowflake guildId{};///< The Guild within which to delete the StickerData.
    };
 
    /**@}*/
 
    /**
     * \addtogroup main_endpoints
     * @{
     */
 
    /// @brief An interface class for the StickerData related Discord endpoints.
    class DiscordCoreAPI_Dll Stickers {
      public:
        static void initialize(DiscordCoreInternal::HttpsClient*);
 
        /// @brief Gets a single StickerData item.
        /// @param dataPackage A GetStickerData structure.
        /// @return A CoRoutine containing a StickerData.
        static CoRoutine<StickerData> getStickerAsync(GetStickerData dataPackage);
 
        /// @brief Gets a list of nitro-available StickerData packs
        /// @return A CoRoutine containing a StickerPackData
        static CoRoutine<jsonifier::vector<StickerPackData>> getNitroStickerPacksAsync();
 
        /// @brief Gets a list of Stickers from a Guild.
        /// @param dataPackage A GetGuildStickersData structure.
        /// @return A CoRoutine containing a jsonifier::vector<StickerData>.
        static CoRoutine<jsonifier::vector<StickerData>> getGuildStickersAsync(GetGuildStickersData dataPackage);
 
        /// @brief Creates a new StickerData within a chosen Guild.
        /// @param dataPackage A CreateGuildStickerData structure.
        /// @return A CoRoutine containing a StickerData.
        static CoRoutine<StickerData> createGuildStickerAsync(CreateGuildStickerData dataPackage);
 
        /// @brief Modifies a StickerData within a chosen Guild.
        /// @param dataPackage A ModifyGuildStickerData structure.
        /// @return A CoRoutine containing a StickerData.
        static CoRoutine<StickerData> modifyGuildStickerAsync(ModifyGuildStickerData dataPackage);
 
        /// @brief Deletes a StickerData within a chosen Guild.
        /// @param dataPackage A DeleteGuildStickerData structure.
        /// @return A CoRoutine containing void.
        static CoRoutine<void> deleteGuildStickerAsync(DeleteGuildStickerData dataPackage);
 
      protected:
        static DiscordCoreInternal::HttpsClient* httpsClient;
    };
    /**@}*/
};