![]() |
D++ (DPP)
C++ Discord API Bot Library
|
A definition of a discord thread. A thread is a superset of a channel. Not to be confused with std::thread
!
More...
#include <thread.h>
Public Member Functions | |
constexpr bool | is_news_thread () const noexcept |
Returns true if the thread is within an announcement channel. More... | |
constexpr bool | is_public_thread () const noexcept |
Returns true if the channel is a public thread. More... | |
constexpr bool | is_private_thread () const noexcept |
Returns true if the channel is a private thread. More... | |
std::string | get_mention () const |
Get the mention ping for the channel. More... | |
channel & | set_name (const std::string &name) |
Set name of this channel object. More... | |
channel & | set_topic (const std::string &topic) |
Set topic of this channel object. More... | |
channel & | set_type (channel_type type) |
Set type of this channel object. More... | |
channel & | set_default_forum_layout (forum_layout_type layout_type) |
Set the default forum layout type for the forum channel. More... | |
channel & | set_default_sort_order (default_forum_sort_order_t sort_order) |
Set the default forum sort order for the forum channel. More... | |
channel & | set_flags (const uint16_t flags) |
Set flags for this channel object. More... | |
channel & | add_flag (const channel_flags flag) |
Add (bitwise OR) a flag to this channel object. More... | |
channel & | remove_flag (const channel_flags flag) |
Remove (bitwise NOT AND) a flag from this channel object. More... | |
channel & | set_position (const uint16_t position) |
Set position of this channel object. More... | |
channel & | set_guild_id (const snowflake guild_id) |
Set guild_id of this channel object. More... | |
channel & | set_parent_id (const snowflake parent_id) |
Set parent_id of this channel object. More... | |
channel & | set_user_limit (const uint8_t user_limit) |
Set user_limit of this channel object. More... | |
channel & | set_bitrate (const uint16_t bitrate) |
Set bitrate of this channel object. More... | |
channel & | set_nsfw (const bool is_nsfw) |
Set nsfw property of this channel object. More... | |
channel & | set_lock_permissions (const bool is_lock_permissions) |
Set lock permissions property of this channel object Used only with the reorder channels method. More... | |
channel & | set_rate_limit_per_user (const uint16_t rate_limit_per_user) |
Set rate_limit_per_user of this channel object. More... | |
channel & | add_permission_overwrite (const snowflake target, const overwrite_type type, const uint64_t allowed_permissions, const uint64_t denied_permissions) |
Add permission overwrites for a user or role. If the channel already has permission overwrites for the passed target, the existing ones will be adjusted by the passed permissions. More... | |
channel & | set_permission_overwrite (const snowflake target, const overwrite_type type, const uint64_t allowed_permissions, const uint64_t denied_permissions) |
Set permission overwrites for a user or role on this channel object. Old permission overwrites for the target will be overwritten. More... | |
channel & | remove_permission_overwrite (const snowflake target, const overwrite_type type) |
Remove channel specific permission overwrites of a user or role. More... | |
channel_type | get_type () const |
Get the channel type. More... | |
forum_layout_type | get_default_forum_layout () const |
Get the default forum layout type used to display posts in forum channels. More... | |
permission | get_user_permissions (const class user *user) const |
Get the overall permissions for a member in this channel, including channel overwrites, role permissions and admin privileges. More... | |
permission | get_user_permissions (const class guild_member &member) const |
Get the overall permissions for a member in this channel, including channel overwrites, role permissions and admin privileges. More... | |
std::map< snowflake, class guild_member * > | get_members () |
Return a map of members on the channel, built from the guild's member list based on which members have the VIEW_CHANNEL permission. Does not return reliable information for voice channels, use dpp::channel::get_voice_members() instead for this. More... | |
std::map< snowflake, voicestate > | get_voice_members () |
Get a map of members in this channel, if it is a voice channel. The map is keyed by snowflake id of the user. More... | |
std::string | get_icon_url (uint16_t size=0, const image_type format=i_png) const |
Get the channel's icon url (if its a group DM), otherwise returns an empty string. More... | |
std::string | get_url () const |
Returns string of URL to channel. More... | |
bool | is_nsfw () const |
Returns true if the channel is NSFW gated. More... | |
bool | is_locked_permissions () const |
Returns true if the permissions are to be synced with the category it is in. Used only and set manually when using the reorder channels method. More... | |
bool | is_text_channel () const |
Returns true if the channel is a text channel. More... | |
bool | is_dm () const |
Returns true if the channel is a DM. More... | |
bool | is_voice_channel () const |
Returns true if the channel is a voice channel. More... | |
bool | is_group_dm () const |
Returns true if the channel is a group DM channel. More... | |
bool | is_category () const |
Returns true if the channel is a category. More... | |
bool | is_forum () const |
Returns true if the channel is a forum. More... | |
bool | is_media_channel () const |
Returns true if the channel is a media channel. More... | |
bool | is_news_channel () const |
Returns true if the channel is an announcement channel. More... | |
bool | is_store_channel () const |
Returns true if the channel is a store channel. More... | |
bool | is_stage_channel () const |
Returns true if the channel is a stage channel. More... | |
bool | is_video_auto () const |
Returns true if video quality is auto. More... | |
bool | is_video_720p () const |
Returns true if video quality is 720p. More... | |
bool | is_pinned_thread () const |
Returns true if channel is a pinned thread in forum. More... | |
bool | is_tag_required () const |
Returns true if a tag is required to be specified when creating a thread in a forum channel. More... | |
bool | is_download_options_hidden () const |
Returns true if embedded media download options are hidden in a media channel. More... | |
constexpr double | get_creation_time () const noexcept |
Get the creation time of this object according to Discord. More... | |
constexpr bool | operator== (const managed &other) const noexcept |
Comparison operator for comparing two managed objects by id. More... | |
constexpr bool | operator!= (const managed &other) const noexcept |
Comparison operator for comparing two managed objects by id. More... | |
channel & | fill_from_json (nlohmann::json *j) |
Convert object from nlohmann::json. More... | |
auto | to_json (bool with_id=false) const |
Convert object to nlohmann::json. More... | |
std::string | build_json (bool with_id=false) const |
Convert object to json string. More... | |
thread & | fill_from_json (nlohmann::json *j) |
Convert object from nlohmann::json. More... | |
auto | to_json (bool with_id=false) const |
Convert object to nlohmann::json. More... | |
std::string | build_json (bool with_id=false) const |
Convert object to json string. More... | |
Static Public Member Functions | |
static std::string | get_mention (const snowflake &id) |
Create a mentionable channel. More... | |
Public Attributes | |
thread_member | member = {} |
Thread member of current user if joined to the thread. Note this is only set by certain api calls otherwise contains default data. More... | |
thread_metadata | metadata = {} |
Thread metadata (threads) More... | |
message | msg = {} |
Created message. Only filled within the cluster::thread_create_in_forum() method. More... | |
std::vector< snowflake > | applied_tags = {} |
A list of dpp::forum_tag IDs that have been applied to a thread in a forum or media channel. More... | |
uint32_t | total_messages_sent = 0 |
Number of messages ever sent in the thread. It's similar to thread::message_count on message creation, but will not decrement the number when a message is deleted. More... | |
uint8_t | message_count = 0 |
Number of messages (not including the initial message or deleted messages) of the thread. For threads created before July 1, 2022, the message count is inaccurate when it's greater than 50. More... | |
uint8_t | member_count = 0 |
Approximate count of members in a thread (stops counting at 50) More... | |
std::string | name |
Channel name (1-100 characters). More... | |
std::string | topic |
Channel topic (0-4096 characters for forum and media channels, 0-1024 characters for all others). More... | |
std::string | rtc_region |
Voice region if set for voice channel, otherwise empty string. More... | |
std::vector< snowflake > | recipients |
DM recipients. More... | |
std::vector< permission_overwrite > | permission_overwrites |
Permission overwrites to apply to base permissions. More... | |
std::vector< forum_tag > | available_tags |
A set of tags that can be used in a forum or media channel. More... | |
std::variant< std::monostate, snowflake, std::string > | default_reaction |
The emoji to show as the default reaction button on a thread in a forum or media channel. Contains either nothing, the id of a guild's custom emoji or the unicode character of the emoji. More... | |
utility::iconhash | icon |
Channel icon (for group DMs). More... | |
snowflake | owner_id |
User ID of the creator for group DMs or threads. More... | |
snowflake | parent_id |
Parent ID (for guild channels: id of the parent category, for threads: id of the text channel this thread was created). More... | |
snowflake | guild_id |
Guild id of the guild that owns the channel. More... | |
snowflake | last_message_id |
ID of last message to be sent to the channel. More... | |
time_t | last_pin_timestamp |
Timestamp of last pinned message. More... | |
permission | permissions |
This is only filled when the channel is part of the resolved set sent within an interaction. Any other time it contains zero. When filled, it contains the calculated permission bitmask of the user issuing the command within this channel. More... | |
uint16_t | position |
Sorting position, lower number means higher up the list. More... | |
uint16_t | bitrate |
The bitrate (in kilobits) of the voice channel. More... | |
uint16_t | rate_limit_per_user |
Amount of seconds a user has to wait before sending another message (0-21600). Bots, as well as users with the permission manage_messages or manage_channel, are unaffected. More... | |
uint16_t | default_thread_rate_limit_per_user |
The initial rate_limit_per_user to set on newly created threads in a channel. This field is copied to the thread at creation time and does not live update. More... | |
auto_archive_duration_t | default_auto_archive_duration |
Default duration, copied onto newly created threads. Used by the clients, not the API. Threads will stop showing in the channel list after the specified period of inactivity. Defaults to dpp::arc_1_day. More... | |
default_forum_sort_order_t | default_sort_order |
The default sort order type used to order posts in forum and media channels. More... | |
uint16_t | flags |
Flags bitmap (dpp::channel_flags) More... | |
uint8_t | user_limit |
Maximum user limit for voice channels (0-99) More... | |
snowflake | id = {} |
Unique ID of object set by Discord. This value contains a timestamp, worker ID, internal server ID, and an incrementing value. Only the timestamp is relevant to us as useful metadata. More... | |
Protected Member Functions | |
thread & | fill_from_json_impl (nlohmann::json *j) |
json | to_json_impl (bool with_id=false) const override |
Build json for this thread object. More... | |
Static Protected Attributes | |
static constexpr uint16_t | CHANNEL_TYPE_MASK = 0b0000000000001111 |
Friends | |
struct | json_interface< thread > |
A definition of a discord thread. A thread is a superset of a channel. Not to be confused with std::thread
!
|
inherited |
Add (bitwise OR) a flag to this channel object.
flag | Flag bit to add from dpp::channel_flags |
|
inherited |
Add permission overwrites for a user or role. If the channel already has permission overwrites for the passed target, the existing ones will be adjusted by the passed permissions.
target | ID of the role or the member you want to adjust overwrites for |
type | type of overwrite |
allowed_permissions | bitmask of dpp::permissions you want to allow for this user/role in this channel. Note: You can use the dpp::permission class |
denied_permissions | bitmask of dpp::permissions you want to deny for this user/role in this channel. Note: You can use the dpp::permission class |
|
inlineinherited |
Convert object to json string.
with_id | Whether to include the ID or not |
|
inlineinherited |
Convert object to json string.
with_id | Whether to include the ID or not |
|
inlineinherited |
Convert object from nlohmann::json.
j | nlohmann::json object |
|
inlineinherited |
Convert object from nlohmann::json.
j | nlohmann::json object |
|
protected |
Read class values from json object
j | A json object to read from |
|
inlineconstexprnoexceptinherited |
Get the creation time of this object according to Discord.
|
inherited |
Get the default forum layout type used to display posts in forum channels.
|
inherited |
Get the channel's icon url (if its a group DM), otherwise returns an empty string.
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. |
format | The format to use for the avatar. It can be one of i_webp , i_jpg or i_png . |
|
inherited |
Return a map of members on the channel, built from the guild's member list based on which members have the VIEW_CHANNEL permission. Does not return reliable information for voice channels, use dpp::channel::get_voice_members() instead for this.
|
inherited |
Get the mention ping for the channel.
|
staticinherited |
Create a mentionable channel.
id | The ID of the channel. |
|
inherited |
Get the channel type.
|
inherited |
Returns string of URL to channel.
|
inherited |
Get the overall permissions for a member in this channel, including channel overwrites, role permissions and admin privileges.
member | The member to resolve the permissions for |
|
inherited |
Get the overall permissions for a member in this channel, including channel overwrites, role permissions and admin privileges.
user | The user to resolve the permissions for |
|
inherited |
Get a map of members in this channel, if it is a voice channel. The map is keyed by snowflake id of the user.
|
inherited |
Returns true if the channel is a category.
|
inherited |
Returns true if the channel is a DM.
|
inherited |
Returns true if embedded media download options are hidden in a media channel.
|
inherited |
Returns true if the channel is a forum.
|
inherited |
Returns true if the channel is a group DM channel.
|
inherited |
Returns true if the permissions are to be synced with the category it is in. Used only and set manually when using the reorder channels method.
|
inherited |
Returns true if the channel is a media channel.
|
inherited |
Returns true if the channel is an announcement channel.
|
inlineconstexprnoexcept |
Returns true if the thread is within an announcement channel.
|
inherited |
Returns true if the channel is NSFW gated.
|
inherited |
Returns true if channel is a pinned thread in forum.
|
inlineconstexprnoexcept |
Returns true if the channel is a private thread.
|
inlineconstexprnoexcept |
Returns true if the channel is a public thread.
|
inherited |
Returns true if the channel is a stage channel.
|
inherited |
Returns true if the channel is a store channel.
|
inherited |
Returns true if a tag is required to be specified when creating a thread in a forum channel.
|
inherited |
Returns true if the channel is a text channel.
|
inherited |
Returns true if video quality is 720p.
|
inherited |
Returns true if video quality is auto.
|
inherited |
Returns true if the channel is a voice channel.
|
inlineconstexprnoexceptinherited |
Comparison operator for comparing two managed objects by id.
other | Other object to compare against |
|
inlineconstexprnoexceptinherited |
Comparison operator for comparing two managed objects by id.
other | Other object to compare against |
|
inherited |
Remove (bitwise NOT AND) a flag from this channel object.
flag | Flag bit to remove from dpp::channel_flags |
|
inherited |
Remove channel specific permission overwrites of a user or role.
target | ID of the role or the member you want to remove permission overwrites of |
type | type of overwrite |
|
inherited |
Set bitrate of this channel object.
bitrate | Bitrate to set (in kilobits) |
|
inherited |
Set the default forum layout type for the forum channel.
layout_type | The layout type |
|
inherited |
Set the default forum sort order for the forum channel.
sort_order | The sort order |
|
inherited |
Set flags for this channel object.
flags | Flag bitmask to set from dpp::channel_flags |
Set guild_id of this channel object.
guild_id | Guild ID to set |
|
inherited |
Set lock permissions property of this channel object Used only with the reorder channels method.
is_lock_permissions | true, if we are to inherit permissions from the category |
|
inherited |
Set name of this channel object.
name | Name to set |
dpp::length_exception | if length < 1 |
|
inherited |
Set nsfw property of this channel object.
is_nsfw | true, if channel is nsfw |
Set parent_id of this channel object.
parent_id | Parent ID to set |
|
inherited |
Set permission overwrites for a user or role on this channel object. Old permission overwrites for the target will be overwritten.
target | ID of the role or the member you want to set overwrites for |
type | type of overwrite |
allowed_permissions | bitmask of allowed dpp::permissions for this user/role in this channel. Note: You can use the dpp::permission class |
denied_permissions | bitmask of denied dpp::permissions for this user/role in this channel. Note: You can use the dpp::permission class |
allowed_permissions
and denied_permissions
parameters are 0, the permission overwrite for the target will be removed
|
inherited |
Set position of this channel object.
position | Position to set |
|
inherited |
Set rate_limit_per_user of this channel object.
rate_limit_per_user | rate_limit_per_user (slowmode in sec) to set |
|
inherited |
Set topic of this channel object.
topic | Topic to set |
|
inherited |
Set type of this channel object.
type | Channel type to set |
|
inherited |
Set user_limit of this channel object.
user_limit | Limit to set |
|
inlineinherited |
Convert object to nlohmann::json.
with_id | Whether to include the ID or not |
|
inlineinherited |
Convert object to nlohmann::json.
with_id | Whether to include the ID or not |
|
overrideprotectedvirtual |
Build json for this thread object.
with_id | include the ID in the json |
Reimplemented from dpp::channel.
|
friend |
std::vector<snowflake> dpp::thread::applied_tags = {} |
A list of dpp::forum_tag IDs that have been applied to a thread in a forum or media channel.
|
inherited |
A set of tags that can be used in a forum or media channel.
|
inherited |
The bitrate (in kilobits) of the voice channel.
|
staticconstexprprotectedinherited |
|
inherited |
Default duration, copied onto newly created threads. Used by the clients, not the API. Threads will stop showing in the channel list after the specified period of inactivity. Defaults to dpp::arc_1_day.
|
inherited |
The emoji to show as the default reaction button on a thread in a forum or media channel. Contains either nothing, the id of a guild's custom emoji or the unicode character of the emoji.
|
inherited |
The default sort order type used to order posts in forum and media channels.
|
inherited |
The initial rate_limit_per_user
to set on newly created threads in a channel. This field is copied to the thread at creation time and does not live update.
|
inherited |
Flags bitmap (dpp::channel_flags)
|
inherited |
Guild id of the guild that owns the channel.
|
inherited |
Channel icon (for group DMs).
|
inherited |
Unique ID of object set by Discord. This value contains a timestamp, worker ID, internal server ID, and an incrementing value. Only the timestamp is relevant to us as useful metadata.
|
inherited |
ID of last message to be sent to the channel.
|
inherited |
Timestamp of last pinned message.
thread_member dpp::thread::member = {} |
Thread member of current user if joined to the thread. Note this is only set by certain api calls otherwise contains default data.
uint8_t dpp::thread::member_count = 0 |
Approximate count of members in a thread (stops counting at 50)
uint8_t dpp::thread::message_count = 0 |
Number of messages (not including the initial message or deleted messages) of the thread. For threads created before July 1, 2022, the message count is inaccurate when it's greater than 50.
thread_metadata dpp::thread::metadata = {} |
Thread metadata (threads)
message dpp::thread::msg = {} |
Created message. Only filled within the cluster::thread_create_in_forum() method.
|
inherited |
Channel name (1-100 characters).
|
inherited |
User ID of the creator for group DMs or threads.
|
inherited |
Parent ID (for guild channels: id of the parent category, for threads: id of the text channel this thread was created).
|
inherited |
Permission overwrites to apply to base permissions.
|
inherited |
This is only filled when the channel is part of the resolved
set sent within an interaction. Any other time it contains zero. When filled, it contains the calculated permission bitmask of the user issuing the command within this channel.
|
inherited |
Sorting position, lower number means higher up the list.
|
inherited |
Amount of seconds a user has to wait before sending another message (0-21600). Bots, as well as users with the permission manage_messages or manage_channel, are unaffected.
|
inherited |
DM recipients.
|
inherited |
Voice region if set for voice channel, otherwise empty string.
|
inherited |
Channel topic (0-4096 characters for forum and media channels, 0-1024 characters for all others).
uint32_t dpp::thread::total_messages_sent = 0 |
Number of messages ever sent in the thread. It's similar to thread::message_count on message creation, but will not decrement the number when a message is deleted.
|
inherited |
Maximum user limit for voice channels (0-99)