tri11paragon
/
discord-bot
mirror of https://github.com/tri11paragon/discord-bot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
discord-bot/libs/DPP-10.0.29/include/dpp/guild.h

2042 lines
51 KiB
C++
Raw Normal View History

init
2024-02-22 16:09:56 -05:00
/************************************************************************************
*
* D++, A Lightweight C++ library for Discord
*
* Copyright 2021 Craig Edwards and D++ contributors
* (https://github.com/brainboxdotcc/DPP/graphs/contributors)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
************************************************************************************/
#pragma once
#include <dpp/export.h>
#include <dpp/user.h>
#include <dpp/emoji.h>
#include <dpp/snowflake.h>
#include <dpp/managed.h>
#include <dpp/utility.h>
#include <dpp/voicestate.h>
#include <dpp/permissions.h>
#include <string>
#include <unordered_map>
#include <dpp/json_interface.h>
namespace dpp {
class channel;
/* Note from Archie: I'd like to move this soon (dpp::guild::region) and allow users to use a region enum.
* This would make it easier for people to be able to alter a channel region without having to get the text right.
*/
/**
* @brief Represents voice regions for guilds and channels.
* @deprecated Deprecated in favour of per-channel regions.
* Please use dpp::channel::rtc_region instead.
*/
enum region : uint8_t {
/**
* @brief Brazil
*/
r_brazil,
/**
* @brief Central Europe
*/
r_central_europe,
/**
* @brief Hong Kong
*/
r_hong_kong,
/**
* @brief India
*/
r_india,
/**
* @brief Japan
*/
r_japan,
/**
* @brief Russia
*/
r_russia,
/**
* @brief Singapore
*/
r_singapore,
/**
* @brief South Africa
*/
r_south_africa,
/**
* @brief Sydney
*/
r_sydney,
/**
* @brief US Central
*/
r_us_central,
/**
* @brief US East Coast
*/
r_us_east,
/**
* @brief US South
*/
r_us_south,
/**
* @brief US West Coast
*/
r_us_west,
/**
* @brief Western Europe
*/
r_western_europe
};
/**
* @brief The various flags that represent the status of a dpp::guild object
*/
enum guild_flags : uint32_t {
/**
* @brief Large guild
*/
g_large = 0b00000000000000000000000000000001,
/**
* @brief Unavailable guild (inaccessible due to an outage)
*/
g_unavailable = 0b00000000000000000000000000000010,
/**
* @brief Guild has widget enabled
*/
g_widget_enabled = 0b00000000000000000000000000000100,
/**
* @brief Guild can have an invite splash image
*/
g_invite_splash = 0b00000000000000000000000000001000,
/**
* @brief Guild can have VIP regions
*/
g_vip_regions = 0b00000000000000000000000000010000,
/**
* @brief Guild can have a vanity url
*/
g_vanity_url = 0b00000000000000000000000000100000,
/**
* @brief Guild is verified
*/
g_verified = 0b00000000000000000000000001000000,
/**
* @brief Guild is partnered
*/
g_partnered = 0b00000000000000000000000010000000,
/**
* @brief Community features enabled
*/
g_community = 0b00000000000000000000000100000000,
/**
* @brief Guild has enabled role subscriptions
*/
g_role_subscription_enabled = 0b00000000000000000000001000000000,
/**
* @brief Guild has access to create announcement channels
*/
g_news = 0b00000000000000000000010000000000,
/**
* @brief Guild is discoverable in discovery
*/
g_discoverable = 0b00000000000000000000100000000000,
/**
* @brief Guild is featureable
*/
g_featureable = 0b00000000000000000001000000000000,
/**
* @brief Guild can have an animated icon (doesn't mean it actually has one though)
*/
g_animated_icon = 0b00000000000000000010000000000000,
/**
* @brief Guild can have a banner image
*/
g_banner = 0b00000000000000000100000000000000,
/**
* @brief Guild has a welcome screen
*/
g_welcome_screen_enabled = 0b00000000000000001000000000000000,
/**
* @brief Guild has a member verification gate
*/
g_member_verification_gate = 0b00000000000000010000000000000000,
/**
* @brief Guild has a preview
*/
g_preview_enabled = 0b00000000000000100000000000000000,
/**
* @brief Guild join notifications are off
*/
g_no_join_notifications = 0b00000000000001000000000000000000,
/**
* @brief Guild boost notifications are off
*/
g_no_boost_notifications = 0b00000000000010000000000000000000,
/**
* @brief Guild has an actual animated icon (set by the icon hash starting with 'a_')
*/
g_has_animated_icon = 0b00000000000100000000000000000000,
/**
* @brief Guild has an actual animated banner (set by the icon hash starting with 'a_')
*/
g_has_animated_banner = 0b00000000001000000000000000000000,
/**
* @brief Guild setup tips are off
*/
g_no_setup_tips = 0b00000000010000000000000000000000,
/**
* @brief "Wave to say hi" sticker prompt buttons are off
*/
g_no_sticker_greeting = 0b00000000100000000000000000000000,
/**
* @brief Guild has enabled monetization
*/
g_monetization_enabled = 0b00000001000000000000000000000000,
/**
* @brief Guild has increased custom sticker slots
*/
g_more_stickers = 0b00000010000000000000000000000000,
/**
* @brief Guild has enabled the role subscription promo page
*/
g_creator_store_page_enabled = 0b00000100000000000000000000000000,
/**
* @brief Guild is able to set role icons
*/
g_role_icons = 0b00001000000000000000000000000000,
/**
* @brief Guild has access to the seven day archive time for threads
* @deprecated Removed by Discord
*/
g_seven_day_thread_archive = 0b00010000000000000000000000000000,
/**
* @brief Guild has access to the three day archive time for threads
* @deprecated Removed by Discord
*/
g_three_day_thread_archive = 0b00100000000000000000000000000000,
/**
* @brief Guild has enabled ticketed events
*/
g_ticketed_events = 0b01000000000000000000000000000000,
/**
* @brief Guild can have channel banners
* @deprecated Removed by Discord
*/
g_channel_banners = 0b10000000000000000000000000000000,
};
/**
* @brief Additional boolean flag values for guild, as guild_flags is full
*/
enum guild_flags_extra : uint16_t {
/**
* @brief Guild has premium progress bar enabled
*/
g_premium_progress_bar_enabled = 0b0000000000000001,
/**
* @brief Guild can have an animated banner (doesn't mean it actually has one though)
*/
g_animated_banner = 0b0000000000000010,
/**
* @brief Guild has auto moderation
*/
g_auto_moderation = 0b0000000000000100,
/**
* @brief Guild has paused invites, preventing new users from joining
*/
g_invites_disabled = 0b0000000000001000,
/**
* @brief Guild has been set as support server of an app in the App Directory
*/
g_developer_support_server = 0b0000000000010000,
/**
* @brief Guild role subscription purchase and renewal notifications are off
*/
g_no_role_subscription_notifications = 0b0000000000100000,
/**
* @brief Guild role subscription sticker reply buttons are off
*/
g_no_role_subscription_notification_replies = 0b0000000001000000,
/**
* @brief Guild has role subscriptions that can be purchased
*/
g_role_subscriptions_available_for_purchase = 0b0000000010000000,
/**
* @brief Guild has disabled alerts for join raids in the configured safety alerts channel
*/
g_raid_alerts_disabled = 0b0000000100000000,
};
/**
* @brief Various flags that can be used to indicate the status of a guild member.
* @note Use the setter functions in dpp::guild_member and do not toggle the bits yourself.
*/
enum guild_member_flags : uint16_t {
/**
* @brief Member deafened in voice channel
*/
gm_deaf = 0b0000000000000001,
/**
* @brief Member muted in voice channels
*/
gm_mute = 0b0000000000000010,
/**
* @brief Member pending verification by membership screening
*/
gm_pending = 0b0000000000000100,
/**
* @brief Member has animated guild-specific avatar
*/
gm_animated_avatar = 0b0000000000001000,
/**
* @brief gm_deaf or gm_mute has been toggled
*/
gm_voice_action = 0b0000000000010000,
/**
* @brief Member has left and rejoined the guild
*/
gm_did_rejoin = 0b0000000000100000,
/**
* @brief Member has completed onboarding
*/
gm_completed_onboarding = 0b0000000001000000,
/**
* @brief Member is exempt from guild verification requirements
*/
gm_bypasses_verification = 0b0000000010000000,
/**
* @brief Member has started onboarding
*/
gm_started_onboarding = 0b0000000100000000,
/**
* @brief Should change roles on next call to edit guild_member?
* @warning This is set by dpp::guild_member::add_role, dpp::guild_member::remove_role, and dpp::guild_member::set_roles.
* You should only ever use this value if you know what you're doing, otherwise stick to the three functions listed.
*/
gm_roles_action = 0b0000001000000000,
/**
* @brief Should nicknames on next call to edit guild_member?
* @warning This is set by dpp::guild_member::set_nickname.
* You should only ever use this value if you know what you're doing, otherwise stick to the function listed.
*/
gm_nickname_action = 0b0000010000000000,
};
/**
* @brief Represents dpp::user membership upon a dpp::guild.
* This contains the user's nickname, guild roles, and any other guild-specific flags.
*/
class DPP_EXPORT guild_member : public json_interface<guild_member> {
protected:
friend struct json_interface<guild_member>;
/**
* @brief Build json for the member object
*
* @param with_id Add ID to output
* @return json JSON object
*/
json to_json_impl(bool with_id = false) const;
protected:
/**
* @brief Nickname.
*
* @note Empty string if they don't have a nickname on this guild
*/
std::string nickname;
/**
* @brief List of roles this user has on this guild
*/
std::vector<snowflake> roles;
/**
* @brief A set of flags built from the bitmask defined by dpp::guild_member_flags
*/
uint16_t flags;
friend void from_json(const nlohmann::json& j, guild_member& gm);
public:
/**
* @brief Guild id
*/
snowflake guild_id;
/**
* @brief User id
*/
snowflake user_id;
/**
* @brief User avatar.
*
* @note Per-server avatar is a nitro only feature.
*/
utility::iconhash avatar;
/**
* @brief Timestamp of when the time out will be removed; until then, they cannot interact with the guild
*/
time_t communication_disabled_until;
/**
* @brief Date and time the user joined the guild.
*/
time_t joined_at;
/**
* @brief The Date and time the user started boosting.
*/
time_t premium_since;
/** Default constructor */
guild_member();
/**
* @brief Fill this object from a json object.
* @param j The json object to get data from
* @param g_id The guild id to associate the member with
* @param u_id The user id to associate the member with
* @return Reference to self for call chaining
*/
guild_member& fill_from_json(nlohmann::json* j, snowflake g_id, snowflake u_id);
/**
* @brief Returns true if the user is in time-out (communication disabled)
*
* @return true user is in time-out
* @return false user is not in time-out
*/
bool is_communication_disabled() const;
/**
* @brief Returns true if the user is deafened
*
* @return true user is deafened
* @return false user is not deafened
*/
bool is_deaf() const;
/**
* @brief Returns true if the user is muted
*
* @return true user muted
* @return false user not muted
*/
bool is_muted() const;
/**
* @brief Returns true if pending verification by membership screening
*
* @return true user has completed membership screening
* @return false user has not completed membership screening
*/
bool is_pending() const;
/**
* @brief Returns true if the user has left and rejoined the guild
*
* @return true user has left and rejoined the guild
* @return false user has not rejoined
*/
bool has_rejoined() const;
/**
* @brief Returns true if the user has completed onboarding
*
* @return true user has completed onboarding
* @return false user has not completed onboarding
*/
bool has_completed_onboarding() const;
/**
* @brief Returns true if the user has started onboarding
*
* @return true user has started onboarding
* @return false user has not started onboarding yet
*/
bool has_started_onboarding() const;
/**
* @brief Returns true if the user is exempt from guild verification requirements
*
* @return true user bypasses verification
* @return false user doesn't bypass verification
*/
bool has_bypasses_verification() const;
/**
* @brief Returns true if the user's per-guild custom avatar is animated
*
* @return true user's custom avatar is animated
* @return false user's custom avatar is not animated
*/
bool has_animated_guild_avatar() const;
/**
* @brief Returns the member's per guild avatar url if they have one, otherwise returns an empty string.
*
* @note per-server avatar is a nitro only feature so it might be not set. If you need the user avatar, use user::get_avatar_url.
*
* @param size The size of the avatar in pixels. It can be any power of two between 16 and 4096,
* otherwise the default sized avatar is returned.
* @param format The format to use for the avatar. It can be one of `i_webp`, `i_jpg`, `i_png` or `i_gif`.
* When passing `i_gif`, it returns an empty string for non-animated images. Consider using the `prefer_animated` parameter instead.
* @param prefer_animated Whether you prefer gif format.
* If true, it'll return gif format whenever the image is available as animated.
* @return std::string avatar url or an empty string, if required attributes are missing or an invalid format was passed
*/
std::string get_avatar_url(uint16_t size = 0, const image_type format = i_png, bool prefer_animated = true) const;
/**
* @brief Set the nickname
*
* @param nick Nickname to set
*
* @return guild_member& reference to self
*/
guild_member& set_nickname(const std::string& nick);
/**
* @brief Get the nickname
*
* @return std::string nickname
*/
std::string get_nickname() const;
/**
* @brief Get the roles
*
* @return std::vector<dpp::snowflake> roles
*/
const std::vector<dpp::snowflake>& get_roles() const;
/**
* @brief Find the dpp::user object for this member. This is an alias for dpp::find_user
* @return dpp::user* Pointer to the user object. If not in cache, it returns nullptr
*/
user* get_user() const;
/**
* @brief Check if this member is equal to another member object.
* @param other_member other member object to compare
* @return true if their user ids are equal, false otherwise.
*/
bool operator == (guild_member const& other_member) const;
/**
* @brief Set whether the user is exempt from guild verification requirements
*
* @param is_bypassing_verification value to set
*
* @return guild_member& reference to self
*/
guild_member& set_bypasses_verification(const bool is_bypassing_verification);
/**
* @brief Set whether the user is muted in voice channels
*
* @param is_muted value to set, true if mute in voice channels
*
* @return guild_member& reference to self
*/
guild_member& set_mute(const bool is_muted);
/**
* @brief Set whether the user is deafened in voice channels
*
* @param is_deafened value to set, true if deaf in voice channels
*
* @return guild_member& reference to self
*/
guild_member& set_deaf(const bool is_deafened);
/**
* @brief Set communication_disabled_until
*
* @param timestamp timestamp until communication is disabled
*
* @return guild_member& reference to self
*/
guild_member& set_communication_disabled_until(const time_t timestamp);
/**
* @brief Return a ping/mention for the user by nickname
*
* @return std::string mention
*/
std::string get_mention() const;
/**
* @brief Add a role to this member
* @note This call sets the role change bit, which causes the new role
* list to be sent if this is passed to dpp::cluster::guild_edit_member
* or dpp::cluster::guild_add_member
*
* @param role_id Role ID to add
* @return guild_member& Reference to self
*/
guild_member& add_role(dpp::snowflake role_id);
/**
* @brief Remove a role from this member
* @note This call sets the role change bit, which causes the new role
* list to be sent if this is passed to dpp::cluster::guild_edit_member
* or dpp::cluster::guild_add_member
*
* @param role_id Role ID to remove
* @return guild_member& Reference to self
*/
guild_member& remove_role(dpp::snowflake role_id);
/**
* @brief Set a new role list for this member
* @note This call sets the role change bit, which causes the new role
* list to be sent if this is passed to dpp::cluster::guild_edit_member
* or dpp::cluster::guild_add_member
*
* @param role_ids Roles to set
* @return guild_member& Reference to self
*/
guild_member& set_roles(const std::vector<dpp::snowflake> &role_ids);
};
/**
* @brief Defines a channel on a server's welcome screen
*/
struct DPP_EXPORT welcome_channel : public json_interface<welcome_channel> {
protected:
friend struct json_interface<welcome_channel>;
/**
* @brief Read class values from json object
*
* @param j A json object to read from
* @return A reference to self
*/
welcome_channel& fill_from_json_impl(nlohmann::json* j);
/**
* @brief Build the json for this object
*
* @param with_id include the id in the JSON
* @return json JSON data
*/
json to_json_impl(bool with_id = false) const;
public:
/**
* @brief The description shown for the channel.
*/
std::string description;
/**
* @brief The emoji name.
*
* @note name if custom, the unicode character if standard, or null if no emoji is set.
*/
std::string emoji_name;
/**
* @brief The channel's id.
*/
snowflake channel_id;
/**
* @brief The emoji id, if the emoji is custom.
*/
snowflake emoji_id;
/**
* @brief Construct a new welcome channel object
*/
welcome_channel();
/**
* @brief Destroy the welcome channel object
*/
virtual ~welcome_channel() = default;
/**
* @brief Set the channel ID of this welcome channel object
*
* @param _channel_id The channel ID to set
* @return Reference to self, so these method calls may be chained
*/
welcome_channel& set_channel_id(const snowflake _channel_id);
/**
* @brief Set the description of this welcome channel object
*
* @param _description The description to set
* @return Reference to self, so these method calls may be chained
*/
welcome_channel& set_description(const std::string& _description);
};
/**
* @brief Defines a server's welcome screen
*/
struct DPP_EXPORT welcome_screen : public json_interface<welcome_screen> {
protected:
friend struct json_interface<welcome_screen>;
/**
* @brief Read class values from json object
*
* @param j A json object to read from
* @return A reference to self
*/
welcome_screen& fill_from_json_impl(nlohmann::json* j);
/**
* @brief Build the json for this object
*
* @param with_id include the id in the JSON
* @return std::string json data
*/
json to_json_impl(bool with_id = false) const;
public:
/**
* @brief The server description shown in the welcome screen
*/
std::string description;
/**
* @brief The channels shown in the welcome screen (max 5)
*/
std::vector<welcome_channel> welcome_channels;
/**
* @brief Construct a new welcome screen object
*/
welcome_screen() = default;
/**
* @brief Destroy the welcome screen object
*/
virtual ~welcome_screen() = default;
/**
* @brief Set the server description for this welcome screen object shown in the welcome screen
*
* @param s string The server description
* @return Reference to self, so these method calls may be chained
*/
welcome_screen& set_description(const std::string& s);
};
/**
* @brief Guild NSFW level.
* Used to represent just how naughty this guild is. Naughty guild, go sit in the corner.
* @note This is set by Discord, and cannot be set by any bot or user on the guild.
*/
enum guild_nsfw_level_t : uint8_t {
/**
* @brief Default setting, not configured
*/
nsfw_default = 0,
/**
* @brief Explicit content may be in this guild
*/
nsfw_explicit = 1,
/**
* @brief Safe for work content only
*/
nsfw_safe = 2,
/**
* @brief Age restricted, 18+
*/
nsfw_age_restricted = 3
};
/**
* @brief explicit content filter level.
* This is set by a guild admin, but can be forced to a setting if the server is verified,
* partnered, official etc.
*/
enum guild_explicit_content_t : uint8_t {
/**
* @brief Media content will not be scanned.
*/
expl_disabled = 0,
/**
* @brief Media content sent by members without roles will be scanned.
*/
expl_members_without_roles = 1,
/**
* @brief Media content sent by all members will be scanned.
*/
expl_all_members = 2
};
/**
* @brief MFA level for server.
* If set to elevated all moderators need MFA to perform specific actions such as kick or ban.
*/
enum mfa_level_t : uint8_t {
/**
* @brief MFA not elevated
*/
mfa_none = 0,
/**
* @brief MFA elevated.
*/
mfa_elevated = 1
};
/**
* @brief Guild verification level
*/
enum verification_level_t : uint8_t {
/**
* @brief Unrestricted.
*/
ver_none = 0,
/**
* @brief Must have verified email on account.
*/
ver_low = 1,
/**
* @brief Must be registered on Discord for longer than 5 minutes.
*/
ver_medium = 2,
/**
* @brief Must be a member of the server for longer than 10 minutes.
*/
ver_high = 3,
/**
* @brief Must have a verified phone number.
*/
ver_very_high = 4,
};
/**
* @brief Default message notification level
*/
enum default_message_notification_t : uint8_t {
/**
* @brief Members will receive notifications for all messages by default.
*/
dmn_all = 0,
/**
* @brief Members will receive notifications only for messages that \@mention them by default.
*/
dmn_only_mentions = 1,
};
/**
* @brief The guild's premium tier.
*/
enum guild_premium_tier_t : uint8_t {
/**
* @brief Guild has not unlocked any Server Boost perks.
*/
tier_none = 0,
/**
* @brief Guild has unlocked Server Boost level 1 perks.
*/
tier_1 = 1,
/**
* @brief Guild has unlocked Server Boost level 2 perks.
*/
tier_2 = 2,
/**
* @brief Guild has unlocked Server Boost level 3 perks.
*/
tier_3 = 3,
};
/**
* @brief Voice AFK timeout values for guild::afk_timeout
*/
enum guild_afk_timeout_t : uint8_t {
/**
* @brief AFK timeout disabled
*/
afk_off,
/**
* @brief AFK timeout of 1 Minute
*/
afk_60,
/**
* @brief AFK timeout of 5 Minutes
*/
afk_300,
/**
* @brief AFK timeout of 15 Minutes
*/
afk_900,
/**
* @brief AFK timeout of 30 Minutes
*/
afk_1800,
/**
* @brief AFK timeout of 1 Hour
*/
afk_3600,
};
/**
* @brief Guild members container
*/
typedef std::unordered_map<snowflake, guild_member> members_container;
/**
* @brief Represents a guild on Discord (AKA a server)
*/
class DPP_EXPORT guild : public managed, public json_interface<guild> {
protected:
friend struct json_interface<guild>;
/** Read class values from json object
* @param j A json object to read from
* @return A reference to self
*/
guild& fill_from_json_impl(nlohmann::json* j);
/** Build a JSON from this object.
* @param with_id True if an ID is to be included in the JSON
* @return JSON
*/
json to_json_impl(bool with_id = false) const;
public:
using json_interface<guild>::fill_from_json;
/**
* @brief Guild name
*/
std::string name;
/**
* @brief Server description
*/
std::string description;
/**
* @brief Vanity url code for verified or partnered servers and boost level 3
* @note This field cannot be set from the API. Attempts to change this value will be
* silently ignored even if the correct number of boosts or verified/partnered status exist.
* See: https://github.com/discord/discord-api-docs/issues/519
*/
std::string vanity_url_code;
/**
* @brief Roles defined on this server
*/
std::vector<snowflake> roles;
/**
* @brief List of channels on this server
*/
std::vector<snowflake> channels;
/**
* @brief List of threads on this server
*/
std::vector<snowflake> threads;
/**
* @brief List of emojis
*/
std::vector<snowflake> emojis;
/**
* @brief List of members in voice channels in the guild.
*/
std::map<snowflake, voicestate> voice_members;
/**
* @brief List of guild members.
*
* @note When you first receive the guild create event,
* this may be empty or near empty. This depends upon your
* dpp::intents and the size of your bot.
* It will be filled by guild member chunk requests.
*/
members_container members;
/**
* @brief Welcome screen
*/
dpp::welcome_screen welcome_screen;
/**
* @brief Guild icon
*/
utility::icon icon;
/**
* @brief Guild splash
*/
utility::icon splash;
/**
* @brief Guild discovery splash
*/
utility::icon discovery_splash;
/**
* @brief Server banner
*/
utility::icon banner;
/**
* @brief Snowflake id of guild owner
*/
snowflake owner_id;
/**
* @brief Snowflake ID of AFK voice channel or 0
*/
snowflake afk_channel_id;
/**
* @brief ID of creating application, if any, or 0
*/
snowflake application_id;
/**
* @brief ID of system channel where discord update messages are sent
*/
snowflake system_channel_id;
/**
* @brief ID of rules channel for communities
*/
snowflake rules_channel_id;
/**
* @brief Public updates channel id or 0
*/
snowflake public_updates_channel_id;
/**
* @brief Snowflake ID of widget channel, or 0
*/
snowflake widget_channel_id;
/**
* @brief The id of the channel where admins and moderators of Community guilds receive safety alerts from Discord
*/
snowflake safety_alerts_channel_id;
/**
* @brief Approximate member count. May be sent as zero
*/
uint32_t member_count;
/**
* @brief Flags bitmask as defined by values within dpp::guild_flags
*/
uint32_t flags;
/**
* @brief the maximum number of presences for the guild.
* @note Generally Discord always fills this with 0, apart from for the largest of guilds
*/
uint32_t max_presences;
/**
* @brief the maximum number of members for the guild
*/
uint32_t max_members;
/**
* @brief Additional flags (values from dpp::guild_flags_extra)
*/
uint16_t flags_extra;
/**
* @brief Shard ID of the guild
*/
uint16_t shard_id;
/**
* @brief Number of boosters
*/
uint16_t premium_subscription_count;
/**
* @brief Voice AFK timeout before moving users to AFK channel
*/
guild_afk_timeout_t afk_timeout;
/**
* @brief Maximum users in a video channel, or 0
*/
uint8_t max_video_channel_users;
/**
* @brief Setting for how notifications are to be delivered to users
*/
default_message_notification_t default_message_notifications;
/**
* @brief Boost level
*/
guild_premium_tier_t premium_tier;
/**
* @brief Verification level of server
*/
verification_level_t verification_level;
/**
* @brief Whether or not explicit content filtering is enable and what setting it is
*/
guild_explicit_content_t explicit_content_filter;
/**
* @brief If multi factor authentication is required for moderators or not
*/
mfa_level_t mfa_level;
/**
* @brief Guild NSFW level
*/
guild_nsfw_level_t nsfw_level;
/** Default constructor, zeroes all values */
guild();
/**
* @brief Destroy the guild object
*/
virtual ~guild() = default;
/** Read class values from json object
* @param shard originating shard
* @param j A json object to read from
* @return A reference to self
*/
guild& fill_from_json(class discord_client* shard, nlohmann::json* j);
/**
* @brief Compute the base permissions for a member on this guild,
* before channel overwrites are applied.
* This method takes into consideration the following cases:
* - Guild owner
* - Guild roles including \@everyone
*
* @param user User to get permissions for
* @return permission permissions bitmask. If the member has administrator privileges, the bitmask returns with all flags set
* @note Requires role cache to be enabled (it's enabled by default).
*
* @warning The method will search for the guild member in the cache by the users id.
* If the guild member is not in cache, the method will always return 0.
*/
permission base_permissions(const class user* user) const;
/**
* @brief Compute the base permissions for a member on this guild,
* before channel overwrites are applied.
* This method takes into consideration the following cases:
* - Guild owner
* - Guild roles including \@everyone
*
* @param member member to get permissions for
* @return permission permissions bitmask. If the member has administrator privileges, the bitmask returns with all flags set
* @note Requires role cache to be enabled (it's enabled by default).
*/
permission base_permissions(const guild_member &member) const;
/**
* @brief Get the overall permissions for a member in this channel, including channel overwrites, role permissions and admin privileges.
*
* @param base_permissions base permissions before overwrites,
* from guild::base_permissions
* @param user The user to resolve the permissions for
* @param channel Channel to compute permission overwrites for
* @return permission Permission overwrites for the member. Made of bits in dpp::permissions.
* @note Requires role cache to be enabled (it's enabled by default).
*
* @warning The method will search for the guild member in the cache by the users id.
* If the guild member is not in cache, the method will always return 0.
*/
permission permission_overwrites(const uint64_t base_permissions, const user* user, const channel* channel) const;
/**
* @brief Get the overall permissions for a member in this channel, including channel overwrites, role permissions and admin privileges.
*
* @param member The member to resolve the permissions for
* @param channel Channel to compute permission overwrites for
* @return permission Permission overwrites for the member. Made of bits in dpp::permissions.
* @note Requires role cache to be enabled (it's enabled by default).
*/
permission permission_overwrites(const guild_member &member, const channel &channel) const;
/**
* @brief Rehash members map
*/
void rehash_members();
/**
* @brief Connect to a voice channel another guild member is in
*
* @param user_id User id to join
* @param self_mute True if the bot should mute itself
* @param self_deaf True if the bot should deafen itself
* @return True if the user specified is in a vc, false if they aren't
* @note This is NOT a synchronous blocking call! The bot isn't instantly ready to send or listen for audio,
* as we have to wait for the connection to the voice server to be established!
* e.g. wait for dpp::cluster::on_voice_ready event, and then send the audio within that event.
*/
bool connect_member_voice(snowflake user_id, bool self_mute = false, bool self_deaf = false);
/**
* @brief Get the banner url of the guild if it have one, otherwise returns an empty string
*
* @param size The size of the banner in pixels. It can be any power of two between 16 and 4096,
* otherwise the default sized banner is returned.
* @param format The format to use for the avatar. It can be one of `i_webp`, `i_jpg`, `i_png` or `i_gif`.
* Passing `i_gif` might result in an invalid url for non-animated images. Consider using the `prefer_animated` parameter instead.
* @param prefer_animated Whether you prefer gif format.
* If true, it'll return gif format whenever the image is available as animated.
* @return std::string banner url or an empty string, if required attributes are missing or an invalid format was passed
*/
std::string get_banner_url(uint16_t size = 0, const image_type format = i_png, bool prefer_animated = true) const;
/**
* @brief Get the discovery splash url of the guild if it have one, otherwise returns an empty string
*
* @param size The size of the discovery splash in pixels. It can be any power of two between 16 and 4096,
* otherwise the default sized discovery splash is returned.
* @param format The format to use for the avatar. It can be one of `i_webp`, `i_jpg` or `i_png`.
* @return std::string discovery splash url or an empty string, if required attributes are missing or an invalid format was passed
*/
std::string get_discovery_splash_url(uint16_t size = 0, const image_type format = i_png) const;
/**
* @brief Get the icon url of the guild if it have one, otherwise returns an empty string
*
* @param size The size of the icon in pixels. It can be any power of two between 16 and 4096,
* otherwise the default sized icon is returned.
* @param format The format to use for the avatar. It can be one of `i_webp`, `i_jpg`, `i_png` or `i_gif`.
* When passing `i_gif`, it returns an empty string for non-animated images. Consider using the `prefer_animated` parameter instead.
* @param prefer_animated Whether you prefer gif format.
* If true, it'll return gif format whenever the image is available as animated.
* @return std::string icon url or an empty string, if required attributes are missing or an invalid format was passed
*/
std::string get_icon_url(uint16_t size = 0, const image_type format = i_png, bool prefer_animated = true) const;
/**
* @brief Get the splash url of the guild if it have one, otherwise returns an empty string
*
* @param size The size of the splash in pixels. It can be any power of two between 16 and 4096,
* otherwise the default sized splash is returned.
* @param format The format to use for the avatar. It can be one of `i_webp`, `i_jpg` or `i_png`.
* @return std::string splash url or an empty string, if required attributes are missing or an invalid format was passed
*/
std::string get_splash_url(uint16_t size = 0, const image_type format = i_png) const;
/**
* @brief Set the name of the guild in the object
* Min length: 2, Max length: 100 (not including leading/trailing spaces)
* @param n Guild name
* @return guild& reference to self
* @throw dpp::length_exception if guild name is too short
*/
guild& set_name(const std::string& n);
/**
* @brief Remove the guild banner.
* @return guild& Reference to self for chaining
*/
guild& remove_banner();
/**
* @brief Set the guild banner image. Server needs banner feature.
* Must be 16:9, and depending on nitro level, must be png or jpeg.
* Animated gif needs the animated banner server feature.
* @param format Image format.
* @param data Image data in bytes
* @return guild& Reference to self for chaining
*/
guild& set_banner(image_type format, std::string_view data);
/**
* @brief Set the guild banner image. Server needs banner feature.
* Must be 16:9, and depending on nitro level, must be png or jpeg.
* Animated gif needs the animated banner server feature.
* @param format Image format.
* @param data Image data in bytes
* @param size Size of the data in bytes
* @return guild& Reference to self for chaining
*/
guild& set_banner(image_type format, const std::byte* data, uint32_t size);
/**
* @brief Remove the guild discovery splash.
* @return guild& Reference to self for chaining
*/
guild& remove_discovery_splash();
/**
* @brief Set the guild discovery splash image. Server needs discoverable feature.
* Must be 16:9 and png or jpeg.
* @param format Image format.
* @param data Image data in bytes
* @return guild& Reference to self for chaining
*/
guild& set_discovery_splash(image_type format, std::string_view data);
/**
* @brief Set the guild discovery splash image. Server needs discoverable feature.
* Must be 16:9 and png or jpeg.
* @param format Image format.
* @param data Image data in bytes
* @param size Size of the data in bytes
* @return guild& Reference to self for chaining
*/
guild& set_discovery_splash(image_type format, const std::byte* data, uint32_t size);
/**
* @brief Remove the guild invite splash.
* @return guild& Reference to self for chaining
*/
guild& remove_splash();
/**
* @brief Set the guild invite splash image. Server needs invite splash feature.
* Must be 16:9 and png or jpeg.
* @param format Image format.
* @param data Image data in bytes
* @return guild& Reference to self for chaining
*/
guild& set_splash(image_type format, std::string_view data);
/**
* @brief Set the guild invite splash image. Server needs invite splash feature.
* Must be 16:9 and png or jpeg.
* @param format Image format.
* @param data Image data in bytes
* @param size Size of the data in bytes
* @return guild& Reference to self for chaining
*/
guild& set_splash(image_type format, const std::byte* data, uint32_t size);
/**
* @brief Remove the guild icon.
* @return guild& Reference to self for chaining
*/
guild& remove_icon();
/**
* @brief Set the guild icon image.
* Must be 1024x1024 and png or jpeg. Gif allowed only if the server has animated icon.
* @param format Image format.
* @param data Image data in bytes
* @return guild& Reference to self for chaining
*/
guild& set_icon(image_type format, std::string_view data);
/**
* @brief Set the 1024x1024 guild icon image.
* Must be png or jpeg. Gif allowed only if the server has animated icon.
* @param format Image format.
* @param data Image data in bytes
* @param size Size of the data in bytes
* @return guild& Reference to self for chaining
*/
guild& set_icon(image_type format, const std::byte* data, uint32_t size);
/**
* @brief Is a large server (>250 users)
* @return bool is a large guild
*/
bool is_large() const;
/**
* @brief Is unavailable due to outage (most other fields will be blank or outdated
* @return bool is unavailable
*/
bool is_unavailable() const;
/**
* @brief Widget is enabled for this server
* @return bool widget enabled
*/
bool widget_enabled() const;
/**
* @brief Guild has access to set an invite splash background
* @return bool can have an invite splash
*/
bool has_invite_splash() const;
/**
* @brief Guild has access to set 384kbps bitrate in voice
* @return bool can have VIP voice regions
*/
bool has_vip_regions() const;
/**
* @brief Guild has access to set a vanity URL
* @return bool can have vanity url
*/
bool has_vanity_url() const;
/**
* @brief Guild is a verified server
* @return bool is verified
*/
bool is_verified() const;
/**
* @brief Guild is a discord partnered server
* @return bool is discord partnered
*/
bool is_partnered() const;
/**
* @brief Has enabled community
* @return bool has enabled community
*/
bool is_community() const;
/**
* @brief Has enabled role subscriptions
* @return bool has enabled role subscriptions
*/
bool has_role_subscriptions() const;
/**
* @brief Guild has access to create announcement channels
* @return bool has announcement channels features enabled
*/
bool has_news() const;
/**
* @brief Guild is discoverable
* @return bool is discoverable
*/
bool is_discoverable() const;
/**
* @brief Guild is featurable
* @return bool is featurable
*/
bool is_featureable() const;
/**
* @brief Guild has access to set an animated guild banner image
* @return bool can have animated banner image
*/
bool has_animated_banner() const;
/**
* @brief Guild has auto moderation features
* @return bool has auto moderation features
*/
bool has_auto_moderation() const;
/**
* @brief Guild has been set as a support server on the App Directory
* @return bool has been set as a support server of an app in the app directory
*/
bool has_support_server() const;
/**
* @brief Guild has role subscriptions that can be purchased
* @return bool has role subscriptions that can be purchased
*/
bool has_role_subscriptions_available_for_purchase() const;
/**
* @brief Guild has disabled alerts for join raids in the configured safety alerts channel
* @return bool dpp::g_raid_alerts_disabled flag is set
*/
bool has_raid_alerts_disabled() const;
/**
* @brief Guild has access to set an animated guild icon
* @return bool can have animated icon
*/
bool has_animated_icon() const;
/**
* @brief Guild has access to set a guild banner image
* @return bool can have banner image
*/
bool has_banner() const;
/**
* @brief Guild has enabled the welcome screen
* @return bool enabled welcome screen
*/
bool is_welcome_screen_enabled() const;
/**
* @brief Guild has enabled membership screening
* @return bool has membership screening
*/
bool has_member_verification_gate() const;
/**
* @brief Guild has preview enabled
* @return bool has preview
*/
bool is_preview_enabled() const;
/**
* @brief Guild icon is actually an animated gif
* @return bool is animated gif
*/
bool has_animated_icon_hash() const;
/**
* @brief Guild banner is actually an animated gif
* @return bool is animated gif
*/
bool has_animated_banner_hash() const;
/**
* @brief guild has access to monetization features
* @return bool
*/
bool has_monetization_enabled() const;
/**
* @brief guild has increased custom sticker slots
* @return bool has more stickers
*/
bool has_more_stickers() const;
/**
* @brief guild has enabled the role subscription promo page
* @return bool has role subscription promo page enabled
*/
bool has_creator_store_page() const;
/**
* @brief guild is able to set role icons
* @return bool has role icons
*/
bool has_role_icons() const;
/**
* @brief guild has access to the seven day archive time for threads
* @return bool has seven day thread archive
* @deprecated Removed by Discord
*/
bool has_seven_day_thread_archive() const;
/**
* @brief guild has access to the three day archive time for threads
* @return bool has three day thread archive
* @deprecated Removed by Discord
*/
bool has_three_day_thread_archive() const;
/**
* @brief guild has enabled ticketed events
* @return bool has ticketed events
*/
bool has_ticketed_events() const;
/**
* @brief guild has access to channel banners feature
* @return bool has channel banners
* @deprecated Removed by Discord
*/
bool has_channel_banners() const;
/**
* @brief True if the premium progress bar is enabled
* @return bool has progress bar enabled
*/
bool has_premium_progress_bar_enabled() const;
/**
* @brief True if has paused invites, preventing new users from joining
* @return bool has paused invites
*/
bool has_invites_disabled() const;
};
/**
* @brief A container of guilds
*/
typedef std::unordered_map<snowflake, guild> guild_map;
/**
* @brief Represents a guild widget, simple web widget of member list
*/
class DPP_EXPORT guild_widget : public json_interface<guild_widget> {
protected:
friend struct json_interface<guild_widget>;
/**
* @brief Build a guild widget from json
*
* @param j json to build from
* @return guild_widget& reference to self
*/
guild_widget& fill_from_json_impl(nlohmann::json* j);
/**
* @brief Build json for a guild widget
*
* @param with_id Add ID to output
* @return std::string guild widget stringified json
*/
json to_json_impl(bool with_id = false) const;
public:
/**
* @brief Channel widget points to
*/
snowflake channel_id;
/**
* @brief True if enabled
*/
bool enabled;
/**
* @brief Construct a new guild widget object
*/
guild_widget();
};
/**
* @brief The onboarding mode for the dpp::onboarding object. Defines the criteria used to satisfy Onboarding constraints that are required for enabling.
*/
enum onboarding_mode : uint8_t {
/**
* @brief Counts only Default Channels towards constraints.
*/
gom_default = 0,
/**
* @brief Counts Default Channels and Questions towards constraints.
*/
gom_advanced = 1,
};
/**
* @brief The various types of dpp::onboarding_prompt
*/
enum onboarding_prompt_type : uint8_t {
/**
* @brief Multiple choice.
*/
opt_multiple_choice = 0,
/**
* @brief Dropdown.
*/
opt_dropdown = 1,
};
/**
* @brief Various flags for dpp::onboarding_prompt
*/
enum onboarding_prompt_flags : uint8_t {
/**
* @brief Indicates whether users are limited to selecting one option for the prompt.
*/
opf_single_select = 1 << 0,
/**
* @brief Indicates whether the prompt is required before a user completes the onboarding flow.
*/
opf_required = 1 << 1,
/**
* @brief Indicates whether the prompt is present in the onboarding flow.
* If set, the prompt will only appear in the Channels & Roles tab
*/
opf_in_onboarding = 1 << 2,
};
/**
* @brief Represents an onboarding prompt option
*/
struct DPP_EXPORT onboarding_prompt_option : public managed, public json_interface<onboarding_prompt_option> {
protected:
friend struct json_interface<onboarding_prompt_option>;
/**
* @brief Read class values from json object
*
* @param j A json object to read from
* @return A reference to self
*/
onboarding_prompt_option& fill_from_json_impl(nlohmann::json* j);
/**
* @brief Build the json for this object
*
* @param with_id include the id in the JSON
* @return json data
*/
json to_json_impl(bool with_id = false) const;
public:
/**
* @brief IDs for channels a member is added to when the option is selected.
*/
std::vector<snowflake> channel_ids;
/**
* @brief IDs for roles assigned to a member when the option is selected
*/
std::vector<snowflake> role_ids;
/**
* @brief Emoji of the option
*/
dpp::emoji emoji;
/**
* @brief Title of the option
*/
std::string title;
/**
* @brief Description of the option
*/
std::string description;
/**
* @brief Construct a new onboarding prompt option object
*/
onboarding_prompt_option();
/**
* @brief Destroy the onboarding prompt option object
*/
virtual ~onboarding_prompt_option() = default;
/**
* @brief Set the emoji of this onboarding prompt option object
*
* @param _emoji The emoji to set
* @return Reference to self, so these method calls may be chained
*/
onboarding_prompt_option& set_emoji(const dpp::emoji& _emoji);
/**
* @brief Set the title of this onboarding prompt option object
*
* @param _title The title to set
* @return Reference to self, so these method calls may be chained
*/
onboarding_prompt_option& set_title(const std::string& _title);
/**
* @brief Set the description of this onboarding prompt option object
*
* @param _description The description to set
* @return Reference to self, so these method calls may be chained
*/
onboarding_prompt_option& set_description(const std::string& _description);
};
/**
* @brief Represents an onboarding prompt
*/
struct DPP_EXPORT onboarding_prompt : public managed, public json_interface<onboarding_prompt> {
protected:
friend struct json_interface<onboarding_prompt>;
/**
* @brief Read class values from json object
*
* @param j A json object to read from
* @return A reference to self
*/
onboarding_prompt& fill_from_json_impl(nlohmann::json* j);
/**
* @brief Build the json for this object
*
* @param with_id include the id in the JSON
* @return json data
*/
json to_json_impl(bool with_id = false) const;
public:
/**
* @brief Type of prompt (defaults to dpp::opt_multiple_choice).
*/
onboarding_prompt_type type;
/**
* @brief Options available within the prompt
*/
std::vector<onboarding_prompt_option> options;
/**
* @brief Title of the prompt.
*/
std::string title;
/**
* @brief A set of flags built from the bitmask defined by dpp::onboarding_prompt_flags
*/
uint8_t flags;
/**
* @brief Construct a new onboarding prompt object
*/
onboarding_prompt();
/**
* @brief Destroy the onboarding prompt object
*/
virtual ~onboarding_prompt() = default;
/**
* @brief Set the type of this onboarding prompt object
*
* @param _type The prompt type to set
* @return Reference to self, so these method calls may be chained
*/
onboarding_prompt& set_type(const onboarding_prompt_type _type);
/**
* @brief Set the title of this onboarding prompt object
*
* @param _title The title to set
* @return Reference to self, so these method calls may be chained
*/
onboarding_prompt& set_title(const std::string& _title);
/**
* @brief Indicates whether users are limited to selecting one option for the prompt
* @return bool True if the users are limited to selecting one option for the prompt
*/
bool is_single_select() const;
/**
* @brief Indicates whether the prompt is required before a user completes the onboarding flow
* @return bool True if the prompt is required before a user completes the onboarding flow
*/
bool is_required() const;
/**
* @brief Indicates whether the prompt is present in the onboarding flow
* @return bool True if the prompt is present in the onboarding flow. False if the prompt will only appear in the Channels & Roles tab
*/
bool is_in_onboarding() const;
};
/**
* @brief Represents a guild's onboarding flow
*/
struct DPP_EXPORT onboarding : public json_interface<onboarding> {
protected:
friend struct json_interface<onboarding>;
/**
* @brief Read class values from json object
*
* @param j A json object to read from
* @return A reference to self
*/
onboarding& fill_from_json_impl(nlohmann::json* j);
/**
* @brief Build the json for this object
*
* @param with_id include the id in the JSON
* @return json data
*/
json to_json_impl(bool with_id = false) const;
public:
/**
* @brief ID of the guild this onboarding is part of.
*/
snowflake guild_id;
/**
* @brief Prompts shown during onboarding and in customize community.
*/
std::vector<onboarding_prompt> prompts;
/**
* @brief Channel IDs that members get opted into automatically
*/
std::vector<snowflake> default_channel_ids;
/**
* @brief Current mode of onboarding (defaults to dpp::gom_default)
*/
onboarding_mode mode;
/**
* @brief Whether onboarding is enabled in the guild
*/
bool enabled;
/**
* @brief Construct a new onboarding object
*/
onboarding();
/**
* @brief Destroy the onboarding object
*/
virtual ~onboarding() = default;
/**
* @brief Set guild_id of this onboarding object
*
* @param guild_id Guild ID to set
* @return Reference to self, so these method calls may be chained
*/
onboarding& set_guild_id(const snowflake id);
/**
* @brief Set the mode of this onboarding object
*
* @param m onboarding_mode Mode to set
* @return Reference to self, so these method calls may be chained
*/
onboarding& set_mode(const onboarding_mode m);
/**
* @brief Set the enabling of this onboarding object
*
* @param is_enabled bool Whether onboarding is enabled in the guild
* @return Reference to self, so these method calls may be chained
*/
onboarding& set_enabled(const bool is_enabled);
};
/**
* @brief helper function to deserialize a guild_member from json
*
* @see https://github.com/nlohmann/json#arbitrary-types-conversions
*
* @param j output json object
* @param gm guild_member to be deserialized
*/
void from_json(const nlohmann::json& j, guild_member& gm);
/**
* @brief A container of guild members
*/
typedef std::unordered_map<snowflake, guild_member> guild_member_map;
/**
* @brief Get the guild_member from cache of given IDs
*
* @param guild_id ID of the guild to find guild_member for
* @param user_id ID of the user to find guild_member for
*
* @throw dpp::cache_exception if the guild or guild_member is not found in the cache
* @return guild_member the cached object, if found
*/
guild_member DPP_EXPORT find_guild_member(const snowflake guild_id, const snowflake user_id);
} // namespace dpp