GuildMemberEntities.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
*/
/// GuildMemberEntities.hpp - Header for the GuildMember related classes and
/// structs. May 13, 2021 Chris M.
/// https://discordcoreapi.com
/// \file GuildMemberEntities.hpp
 
#pragma once
 
#ifndef GUILD_MEMBER_ENTITIES
    #define GUILD_MEMBER_ENTITIES
 
    #include <discordcoreapi/FoundationEntities.hpp>
    #include <discordcoreapi/UserEntities.hpp>
    #include <discordcoreapi/Https.hpp>
 
namespace DiscordCoreAPI {
 
    inline Bool operator==(const DiscordCoreAPI::GuildMemberData& lhs, const DiscordCoreAPI::GuildMemberData& rhs) {
        if ((lhs.guildId == rhs.guildId) && (lhs.id == rhs.id)) {
            return true;
        } else {
            return false;
        }
    }
 
    /**
     * \addtogroup foundation_entities
     * @{
     */
 
    /// For getting a GuildMember, from the library's cache or Discord server. \brief For getting a GuildMember, from the library's cache or Discord server.
    struct DiscordCoreAPI_Dll GetGuildMemberData {
        Snowflake guildMemberId{};///< The user id of the desired GuildMember.
        Snowflake guildId{};///< The id of the Guild from which you would like to acquire a member.
    };
 
    /// For listing the GuildMembers of a chosen Guild. \brief For listing the GuildMembers of a chosen Guild.
    struct DiscordCoreAPI_Dll ListGuildMembersData {
        Snowflake guildId{};///< Guild from which to list the GuildMembers.
        Snowflake after{};///< The highest user id in the previous page.
        Int32 limit{ 0 };///< Max number of members to return (1 - 1000).
    };
 
    /// For searching for one or more GuildMembers within a chosen Guild. \brief For searching for one or more GuildMembers within a chosen Guild.
    struct DiscordCoreAPI_Dll SearchGuildMembersData {
        Snowflake guildId{};///< Guild within which to search for the GuildMembers.
        String query{};///< Query String to match userName(s) and nickname(s) against.
        Int32 limit{ 0 };///< Max number of members to return (1 - 1000).
    };
 
    /// For adding a new GuildMember to a chosen Guild. \brief For adding a new GuildMember to a chosen Guild.
    struct DiscordCoreAPI_Dll AddGuildMemberData {
        std::vector<Snowflake> roles{};///< Array of Role ids the member is assigned.
        String accessToken{};///< An oauth2 access token granted with the guilds.join to the bot's application for the user you want to add.
        Snowflake guildId{};///< The Guild to add the new GuildMember to.
        Snowflake userId{};///< The User id of the user you wish to add.
        String nick{};///< Value to set users nickname to.
        Bool mute{};///< Whether the user is muted in voice channels.
        Bool deaf{};///< Whether the user is deafened in voice channels.
 
        operator JsonObject();
    };
 
    /// For modifying the Current GuildMember's values. \brief For modifying the current GuildMember's values.
    struct DiscordCoreAPI_Dll ModifyCurrentGuildMemberData {
        Snowflake guildId{};///< The Guild within which to modify the current user's values.
        String reason{};///< A reason for modifying the current user's values.
        String nick{};///< A new nickname for the current user.
    };
 
    /// For modifying a GuildMember's values. \brief For modifying a GuildMember's values.
    struct DiscordCoreAPI_Dll ModifyGuildMemberData {
        TimeStamp<std::chrono::milliseconds> communicationDisabledUntil{};///< When the user's timeout will expire and the user will be able to communicate in the guild again.
        std::vector<Snowflake> roleIds{};///< A collection of Role id's to be applied to them.
        Snowflake newVoiceChannelId{};///< The new voice Channel to move them into.
        Snowflake currentChannelId{};///< The current voice Channel, if applicaple.
        Snowflake guildMemberId{};///< The user id of the desired Guild memeber.
        Snowflake guildId{};///< The id of the Guild for which you would like to modify a member.
        String reason{};///< Reason for modifying this GuildMember.
        String nick{};///< Their new display/nick name.
        Bool mute{ false };///< Whether or not to mute them in voice.
        Bool deaf{ false };///< Whether or not to deafen them, in voice.
 
        operator JsonObject();
    };
 
    /// For removing a GuildMember from a chosen Guild. \brief For removing a GuildMember from a chosen Guild.
    struct DiscordCoreAPI_Dll RemoveGuildMemberData {
        Snowflake guildMemberId{};///< Id of the chosen GuildMember to kick.
        Snowflake guildId{};///< Guild from which to kick the chosen GuildMember.
        String reason{};///< Reason for kicking the GuildMember.
    };
 
    /// For timing out a GuildMember. \brief For timing out a GuildMember.
    struct DiscordCoreAPI_Dll TimeoutGuildMemberData {
        TimeoutDurations numOfMinutesToTimeoutFor{};///< The number of minutes to time-out the GuildMember for.
        Snowflake guildMemberId{};///< The id of the GuildMember to be timed-out.
        Snowflake guildId{};///< The id of the Guild from which you would like to acquire a member.
        String reason{};///< Reason for timing them out.
    };
 
    /// A single GuildMember. \brief A single GuildMember.
    class DiscordCoreAPI_Dll GuildMember : public GuildMemberData {
      public:
        TimeStamp<std::chrono::milliseconds> communicationDisabledUntil{};///< When the user's timeout will expire and the user will be able to communicate in the guild again.
        String premiumSince{};///< If applicable, when they first boosted the server.
 
        GuildMember() noexcept = default;
 
        GuildMember& operator=(GuildMemberData&&) noexcept;
 
        GuildMember(GuildMemberData&&) noexcept;
 
        GuildMember& operator=(const GuildMemberData&) noexcept;
 
        GuildMember(const GuildMemberData&) noexcept;
 
        GuildMember(simdjson::ondemand::value jsonObjectData);
 
        virtual ~GuildMember() noexcept = default;
    };
 
    class DiscordCoreAPI_Dll GuildMemberVector {
      public:
        GuildMemberVector() noexcept = default;
 
        operator std::vector<GuildMember>();
 
        GuildMemberVector(simdjson::ondemand::value jsonObjectData);
 
        virtual ~GuildMemberVector() noexcept = default;
 
      protected:
        std::vector<GuildMember> theGuildMembers{};
    };
 
    /**@}*/
 
 
    /**
     * \addtogroup main_endpoints
     * @{
     */
    /// An interface class for the GuildMember related Discord endpoints. \brief An interface class for the GuildMember related Discord endpoints.
    class DiscordCoreAPI_Dll GuildMembers {
      public:
        friend class DiscordCoreInternal::WebSocketSSLShard;
        friend class DiscordCoreClient;
        friend class GuildMemberData;
        friend class GuildData;
        friend class Guild;
 
        static void initialize(DiscordCoreInternal::HttpsClient*, ConfigManager* configManagerNew);
 
        /// Collects a GuildMember from the Discord servers. \brief Collects a GuildMember from the Discord servers.
        /// \param dataPackage A GetGuildMemberData structure.
        /// \returns A CoRoutine containing a GuildMember.
        static CoRoutine<GuildMember> getGuildMemberAsync(GetGuildMemberData dataPackage);
 
        /// Collects a GuildMember from the library's cache. \brief Collects a GuildMember from the library's cache.
        /// \param dataPackage A GetGuildMemberData structure.
        /// \returns A CoRoutine containing a GuildMember.
        static CoRoutine<GuildMemberData> getCachedGuildMemberAsync(GetGuildMemberData dataPackage);
 
        /// Lists all of the GuildMembers of a chosen Guild. \brief Lists all of the GuildMembers of a chosen Guild.
        /// \param dataPackage A ListGuildMembersData structure.
        /// \returns A CoRoutine containing a vector<GuildMembers>.
        static CoRoutine<std::vector<GuildMember>> listGuildMembersAsync(ListGuildMembersData dataPackage);
 
        /// Searches for a list of GuildMembers of a chosen Guild. \brief Searches for a list of GuildMembers of a chosen Guild.
        /// \param dataPackage A SearchGuildMembersData structure.
        /// \returns A CoRoutine containing a vector<GuildMembers>.
        static CoRoutine<std::vector<GuildMember>> searchGuildMembersAsync(SearchGuildMembersData dataPackage);
 
        /// Adds a GuildMember to a chosen Guild. \brief Adds a GuildMember to a chosen Guild.
        /// \param dataPackage An AddGuildMemberData structure.
        /// \returns A CoRoutine containing a vector<GuildMembers>.
        static CoRoutine<GuildMember> addGuildMemberAsync(AddGuildMemberData dataPackage);
 
        /// Modifies a GuildMember's properties. \brief Modifies a GuildMember's properties.
        /// \param dataPackage A ModifyGuildMemberData structure.
        /// \returns A CoRoutine containing a GuildMember.
        static CoRoutine<GuildMember> modifyGuildMemberAsync(ModifyGuildMemberData dataPackage);
 
        /// Modifies the current GuildMember's properties. \brief Modifies the current GuildMember's properties.
        /// \param dataPackage A ModifyCurrentGuildMemberData structure.
        /// \returns A CoRoutine containing a GuildMember.
        static CoRoutine<GuildMember> modifyCurrentGuildMemberAsync(ModifyCurrentGuildMemberData dataPackage);
 
        /// Removes a chosen GuildMember from a chosen Guild. \brief Removes a chosen GuildMember from a chosen Guild.
        /// \param dataPackage A RemoveGuildMemberData structure.
        /// \returns A CoRoutine containing void.
        static CoRoutine<void> removeGuildMemberAsync(RemoveGuildMemberData dataPackage);
 
        /// Times-out a chosen GuildMember from a chosen Guild. \brief Times-out a chosen GuildMember from a chosen Guild.
        /// \param dataPackage A TimeoutGuildMemberData structure.
        /// \returns A CoRoutine containing GuildMember.
        static CoRoutine<GuildMember> timeoutGuildMemberAsync(TimeoutGuildMemberData dataPackage);
 
        static void insertGuildMember(GuildMemberData guildMember);
 
        static void removeGuildMember(GuildMemberData guildMemberId);
 
      protected:
        static DiscordCoreInternal::HttpsClient* httpsClient;
        static ObjectCache<GuildMemberData> cache;
        static Bool doWeCacheGuildMembers;
    };
    /**@}*/
};// namespace DiscordCoreAPI
#endif