A definition of a discord thread. A thread is a superset of a channel. Not to be confused with std::thread! More...

#include <channel.h>

Inheritance diagram for dpp::thread:

Collaboration diagram for dpp::thread:

Public Member Functions
	thread ()
	Construct a new thread object. More...

bool	is_news_thread () const
	Returns true if the channel is a news thread. More...

bool	is_public_thread () const
	Returns true if the channel is a public thread. More...

bool	is_private_thread () const
	Returns true if the channel is a private thread. More...

thread &	fill_from_json (nlohmann::json *j)

virtual	~thread ()
	Destroy the thread object. More...

virtual std::string	build_json (bool with_id=false) const
	Build json for this thread object. 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_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_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_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 id, const uint8_t type, const uint64_t allowed_permissions, const uint64_t denied_permissions)
	Add a permission_overwrite to this channel object. More...

std::string	get_mention () const
	Get the mention ping for the channel. More...

uint64_t	get_user_permissions (const class user *member) const
	Get the user permissions for a user on this channel. 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_banner_url (uint16_t size=0) const
	Get the channel's banner url if they have one, otherwise returns an empty string. More...

std::string	get_icon_url (uint16_t size=0) const
	Get the channel's icon url (if its a group DM), otherwise returns an empty string. More...

bool	is_nsfw () const
	Returns true if the channel is NSFW gated. 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_news_channel () const
	Returns true if the channel is a news 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...

double	get_creation_time () const
	Get the creation time of this object according to Discord. More...

channel &	parse_from_json (nlohmann::json *j)
	Convert object from nlohmann::json. 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

uint8_t	message_count

uint8_t	member_count

std::string	name

std::string	topic

std::string	rtc_region
	Voice region if set for voice channel, otherwise empty string. More...

std::vector< snowflake >	recipients

std::vector< permission_overwrite >	permission_overwrites

utility::iconhash	icon
	Channel icon (for group DMs) More...

utility::iconhash	banner
	Channel banner (boost level locked) More...

snowflake	owner_id

snowflake	parent_id

snowflake	guild_id

snowflake	last_message_id

time_t	last_pin_timestamp

uint64_t	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	flags

uint16_t	position

uint16_t	bitrate

uint16_t	rate_limit_per_user

uint8_t	user_limit

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...

Detailed Description

A definition of a discord thread. A thread is a superset of a channel. Not to be confused with std::thread!

Constructor & Destructor Documentation

◆ thread()

dpp::thread::thread ( )

Construct a new thread object.

◆ ~thread()

virtual dpp::thread::~thread ( )

virtual

Destroy the thread object.

Member Function Documentation

◆ add_flag()

channel & dpp::channel::add_flag ( const channel_flags flag )

inherited

Add (bitwise OR) a flag to this channel object.

Parameters

flag	Flag bit to set

Returns: Reference to self, so these method calls may be chained

◆ add_permission_overwrite()

channel & dpp::channel::add_permission_overwrite	(	const snowflake	id,
		const uint8_t	type,
		const uint64_t	allowed_permissions,
		const uint64_t	denied_permissions
	)

inherited

Add a permission_overwrite to this channel object.

Parameters

id	ID of the role or the member you want to add overwrite for
type	type of overwrite (0 for role, 1 for member)
allowed_permissions	bitmask of allowed permissions (refer to enum role_permissions) for this user/role in this channel
denied_permissions	bitmask of denied permissions (refer to enum role_permissions) for this user/role in this channel

Returns: Reference to self, so these method calls may be chained

◆ build_json()

virtual std::string dpp::thread::build_json ( bool with_id = false ) const

virtual

Build json for this thread object.

Parameters

with_id include the ID in the json

Returns: std::string JSON string

Reimplemented from dpp::channel.

◆ fill_from_json()

thread & dpp::thread::fill_from_json ( nlohmann::json * j )

Read class values from json object

Parameters

j	A json object to read from

Returns: A reference to self

◆ get_banner_url()

std::string dpp::channel::get_banner_url ( uint16_t size = 0 ) const

inherited

Get the channel's banner url if they have one, otherwise returns an empty string.

Parameters

size	The size of the banner in pixels. It can be any power of two between 16 and 4096. if not specified, the default sized banner is returned.

Returns: std::string banner url or empty string

◆ get_creation_time()

double dpp::managed::get_creation_time ( ) const

inherited

Get the creation time of this object according to Discord.

Returns: double creation time inferred from the snowflake ID. The minimum possible value is the first second of 2015.

◆ get_icon_url()

std::string dpp::channel::get_icon_url ( uint16_t size = 0 ) const

inherited

Get the channel's icon url (if its a group DM), otherwise returns an empty string.

Parameters

size	The size of the icon in pixels. It can be any power of two between 16 and 4096. if not specified, the default sized icon is returned.

Returns: std::string icon url or empty string

◆ get_members()

std::map< snowflake, class guild_member * > dpp::channel::get_members ( )

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.

Returns: A map of guild members keyed by user id.

◆ get_mention()

std::string dpp::channel::get_mention ( ) const

inherited

Get the mention ping for the channel.

Returns: std::string mention

◆ get_user_permissions()

uint64_t dpp::channel::get_user_permissions ( const class user * member ) const

inherited

Get the user permissions for a user on this channel.

Parameters

member The user to return permissions for

Returns: uint64_t Permissions bitmask made of bits in role_permissions. Note that if the user is not on the channel or the guild is not in the cache, the function will always return 0.

◆ get_voice_members()

std::map< snowflake, voicestate > dpp::channel::get_voice_members ( )

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.

Returns: std::map<snowflake, voicestate> The voice members of the channel

◆ is_category()

bool dpp::channel::is_category ( ) const

inherited

Returns true if the channel is a category.

Returns: true if a category

◆ is_dm()

bool dpp::channel::is_dm ( ) const

inherited

Returns true if the channel is a DM.

Returns: true if is a DM

◆ is_group_dm()

bool dpp::channel::is_group_dm ( ) const

inherited

Returns true if the channel is a group DM channel.

Returns: true if group DM

◆ is_news_channel()

bool dpp::channel::is_news_channel ( ) const

inherited

Returns true if the channel is a news channel.

Returns: true if news channel

◆ is_news_thread()

bool dpp::thread::is_news_thread ( ) const

Returns true if the channel is a news thread.

Returns: true if news thread

◆ is_nsfw()

bool dpp::channel::is_nsfw ( ) const

inherited

Returns true if the channel is NSFW gated.

Returns: true if NSFW

◆ is_private_thread()

bool dpp::thread::is_private_thread ( ) const

Returns true if the channel is a private thread.

Returns: true if private thread

◆ is_public_thread()

bool dpp::thread::is_public_thread ( ) const

Returns true if the channel is a public thread.

Returns: true if public thread

◆ is_stage_channel()

bool dpp::channel::is_stage_channel ( ) const

inherited

Returns true if the channel is a stage channel.

Returns: true if stage channel

◆ is_store_channel()

bool dpp::channel::is_store_channel ( ) const

inherited

Returns true if the channel is a store channel.

Deprecated:: store channels are deprecated by Discord

Returns: true if store channel

◆ is_text_channel()

bool dpp::channel::is_text_channel ( ) const

inherited

Returns true if the channel is a text channel.

Returns: true if text channel

◆ is_video_720p()

bool dpp::channel::is_video_720p ( ) const

inherited

Returns true if video quality is 720p.

Returns: true if video quality is 720p

◆ is_video_auto()

bool dpp::channel::is_video_auto ( ) const

inherited

Returns true if video quality is auto.

Returns: true if video quality is auto

◆ is_voice_channel()

bool dpp::channel::is_voice_channel ( ) const

inherited

Returns true if the channel is a voice channel.

Returns: true if voice channel

◆ parse_from_json()

channel & dpp::json_interface< channel >::parse_from_json ( nlohmann::json * j )

inlineinherited

Convert object from nlohmann::json.

Parameters

j	nlohmann::json object

Returns: T& Reference to self for fluent calling

◆ remove_flag()

channel & dpp::channel::remove_flag ( const channel_flags flag )

inherited

Remove (bitwise NOT AND) a flag from this channel object.

Parameters

flag	Flag bit to set

Returns: Reference to self, so these method calls may be chained

◆ set_bitrate()

channel & dpp::channel::set_bitrate ( const uint16_t bitrate )

inherited

Set bitrate of this channel object.

Parameters

bitrate Bitrate to set

Returns: Reference to self, so these method calls may be chained

◆ set_flags()

channel & dpp::channel::set_flags ( const uint16_t flags )

inherited

Set flags for this channel object.

Parameters

flags Flag bitmask to set

Returns: Reference to self, so these method calls may be chained

◆ set_name()

channel & dpp::channel::set_name ( const std::string & name )

inherited

Set name of this channel object.

Parameters

name	Name to set

Returns: Reference to self, so these method calls may be chained

Note: name will be truncated to 100 chars, if longer

Exceptions

dpp::length_exception if length < 1

◆ set_nsfw()

channel & dpp::channel::set_nsfw ( const bool is_nsfw )

inherited

Set nsfw property of this channel object.

Parameters

is_nsfw true, if channel is nsfw

Returns: Reference to self, so these method calls may be chained

◆ set_parent_id()

channel & dpp::channel::set_parent_id ( const snowflake parent_id )

inherited

Set parent_id of this channel object.

Parameters

parent_id Parent ID to set

Returns: Reference to self, so these method calls may be chained

◆ set_position()

channel & dpp::channel::set_position ( const uint16_t position )

inherited

Set position of this channel object.

Parameters

position Position to set

Returns: Reference to self, so these method calls may be chained

◆ set_rate_limit_per_user()

channel & dpp::channel::set_rate_limit_per_user ( const uint16_t rate_limit_per_user )

inherited

Set rate_limit_per_user of this channel object.

Parameters

rate_limit_per_user rate_limit_per_user (slowmode in sec) to set

Returns: Reference to self, so these method calls may be chained

◆ set_topic()

channel & dpp::channel::set_topic ( const std::string & topic )

inherited

Set topic of this channel object.

Parameters

topic Topic to set

Returns: Reference to self, so these method calls may be chained

Note: topic will be truncated to 1024 chars, if longer

◆ set_user_limit()

channel & dpp::channel::set_user_limit ( const uint8_t user_limit )

inherited

Set user_limit of this channel object.

Parameters

user_limit Limit to set

Returns: Reference to self, so these method calls may be chained

Member Data Documentation

◆ banner

utility::iconhash dpp::channel::banner

inherited

Channel banner (boost level locked)

◆ bitrate

uint16_t dpp::channel::bitrate

inherited

the bitrate (in bits) of the voice channel

◆ flags

uint16_t dpp::channel::flags

inherited

Flags bitmap

◆ guild_id

snowflake dpp::channel::guild_id

inherited

Guild id of the guild that owns the channel

◆ icon

utility::iconhash dpp::channel::icon

inherited

Channel icon (for group DMs)

◆ id

snowflake dpp::managed::id

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.

◆ last_message_id

snowflake dpp::channel::last_message_id

inherited

ID of last message to be sent to the channel

◆ last_pin_timestamp

time_t dpp::channel::last_pin_timestamp

inherited

Timestamp of last pinned message

◆ member

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.

◆ member_count

uint8_t dpp::thread::member_count

Approximate count of members in a thread (threads)

◆ message_count

uint8_t dpp::thread::message_count

Approximate count of messages in a thread (threads)

◆ metadata

thread_metadata dpp::thread::metadata

Thread metadata (threads)

◆ name

std::string dpp::channel::name

inherited

Channel name

◆ owner_id

snowflake dpp::channel::owner_id

inherited

User ID of owner for group DMs

◆ parent_id

snowflake dpp::channel::parent_id

inherited

Parent ID (category)

◆ permission_overwrites

std::vector<permission_overwrite> dpp::channel::permission_overwrites

inherited

Permission overwrites to apply to base permissions

◆ permissions

uint64_t dpp::channel::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.

◆ position

uint16_t dpp::channel::position

inherited

Sorting position, lower number means higher up the list

◆ rate_limit_per_user

uint16_t dpp::channel::rate_limit_per_user

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

◆ recipients

std::vector<snowflake> dpp::channel::recipients

inherited

DM recipients

◆ rtc_region

std::string dpp::channel::rtc_region

inherited

Voice region if set for voice channel, otherwise empty string.

◆ topic

std::string dpp::channel::topic

inherited

Channel topic

◆ user_limit

uint8_t dpp::channel::user_limit

inherited

Maximum user limit for voice channels (0-99)

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ thread()

◆ ~thread()

Member Function Documentation

◆ add_flag()

◆ add_permission_overwrite()

◆ build_json()

◆ fill_from_json()

◆ get_banner_url()

◆ get_creation_time()

◆ get_icon_url()

◆ get_members()

◆ get_mention()

◆ get_user_permissions()

◆ get_voice_members()

◆ is_category()

◆ is_dm()

◆ is_group_dm()

◆ is_news_channel()

◆ is_news_thread()

◆ is_nsfw()

◆ is_private_thread()

◆ is_public_thread()

◆ is_stage_channel()

◆ is_store_channel()

◆ is_text_channel()

◆ is_video_720p()

◆ is_video_auto()

◆ is_voice_channel()

◆ parse_from_json()

◆ remove_flag()

◆ set_bitrate()

◆ set_flags()

◆ set_name()

◆ set_nsfw()

◆ set_parent_id()

◆ set_position()

◆ set_rate_limit_per_user()

◆ set_topic()

◆ set_user_limit()

Member Data Documentation

◆ banner

◆ bitrate

◆ flags

◆ guild_id

◆ icon

◆ id

◆ last_message_id

◆ last_pin_timestamp

◆ member

◆ member_count

◆ message_count

◆ metadata

◆ name

◆ owner_id

◆ parent_id

◆ permission_overwrites

◆ permissions

◆ position

◆ rate_limit_per_user

◆ recipients

◆ rtc_region

◆ topic

◆ user_limit