A definition of a discord channel. There are one of these for every channel type except threads. Threads are special snowflakes. Get it? A Discord pun. Hahaha. .... I'll get my coat. More...

#include <channel.h>

Inheritance diagram for dpp::channel:

Collaboration diagram for dpp::channel:

Public Member Functions
	channel ()

virtual	~channel ()

channel &	fill_from_json (nlohmann::json *j)

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

std::string	get_mention () const
	Get the mention ping for the channel. 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...

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

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

bool	operator== (const managed &other) const noexcept
	Comparison operator for comparing two managed objects by id. More...

bool	operator!= (const managed &other) const noexcept
	Comparison operator for comparing two managed objects by id. More...

Static Public Member Functions
static std::string	get_mention (const snowflake &id)
	Create a mentionable channel. More...

Public Attributes
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

std::vector< forum_tag >	available_tags

std::variant< std::monostate, snowflake, std::string >	default_reaction
	The emoji to show as the default reaction button on a forum post. 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

snowflake	parent_id

snowflake	guild_id

snowflake	last_message_id

time_t	last_pin_timestamp

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

uint16_t	bitrate

uint16_t	rate_limit_per_user

uint16_t	default_thread_rate_limit_per_user

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

uint16_t	flags

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 channel. There are one of these for every channel type except threads. Threads are special snowflakes. Get it? A Discord pun. Hahaha. .... I'll get my coat.

Constructor & Destructor Documentation

◆ channel()

dpp::channel::channel ( )

Constructor

◆ ~channel()

virtual dpp::channel::~channel ( )

virtual

Destructor

Member Function Documentation

◆ add_flag()

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

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

Parameters

flag	Flag bit to add from dpp::channel_flags

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

◆ add_permission_overwrite()

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

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
allowed_permissions	bitmask of allowed permissions (refer to enum dpp::permissions) for this user/role in this channel
denied_permissions	bitmask of denied permissions (refer to enum dpp::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::channel::build_json ( bool with_id = false ) const

virtual

Build json for this channel object.

Parameters

with_id include the ID in the json

Returns: std::string JSON string

Reimplemented from dpp::json_interface< channel >.

Reimplemented in dpp::thread.

◆ fill_from_json()

channel & dpp::channel::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_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_default_forum_layout()

forum_layout_type dpp::channel::get_default_forum_layout ( ) const

Get the default forum layout type used to display posts in forum channels.

Returns: forum_layout_types Forum layout type

◆ get_icon_url()

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

Parameters

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

Returns: std::string icon url or an empty string, if required attributes are missing or an invalid format was passed

◆ get_members()

std::map< snowflake, class guild_member * > dpp::channel::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.

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

Note: If the guild this channel belongs to is not in the cache, the function will always return 0.

◆ get_mention() [1/2]

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

Get the mention ping for the channel.

Returns: std::string mention

◆ get_mention() [2/2]

static std::string dpp::channel::get_mention ( const snowflake & id )

static

Create a mentionable channel.

Parameters

id	The ID of the channel.

Returns: std::string The formatted mention of the channel.

◆ get_type()

channel_type dpp::channel::get_type ( ) const

Get the channel type.

Returns: channel_type Channel type

◆ get_user_permissions() [1/2]

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

Parameters

member The member to resolve the permissions for

Returns: permission Permission overwrites for the member. Made of bits in dpp::permissions.

Note: Requires role cache to be enabled (it's enabled by default).; This is an alias for guild::permission_overwrites and searches for the guild in the cache, so consider using guild::permission_overwrites if you already have the guild object.

◆ get_user_permissions() [2/2]

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

Parameters

user	The user to resolve the permissions for

Returns: permission Permission overwrites for the member. Made of bits in dpp::permissions.

Note: Requires role cache to be enabled (it's enabled by default).; This is an alias for guild::permission_overwrites and searches for the guild in the cache, so consider using guild::permission_overwrites if you already have the guild object.

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.

◆ get_voice_members()

std::map< snowflake, voicestate > dpp::channel::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.

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

◆ is_category()

bool dpp::channel::is_category ( ) const

Returns true if the channel is a category.

Returns: true if a category

◆ is_dm()

bool dpp::channel::is_dm ( ) const

Returns true if the channel is a DM.

Returns: true if is a DM

◆ is_forum()

bool dpp::channel::is_forum ( ) const

Returns true if the channel is a forum.

Returns: true if a forum

◆ is_group_dm()

bool dpp::channel::is_group_dm ( ) const

Returns true if the channel is a group DM channel.

Returns: true if group DM

◆ is_locked_permissions()

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

Returns: true if keeping permissions

◆ is_news_channel()

bool dpp::channel::is_news_channel ( ) const

Returns true if the channel is an announcement channel.

Returns: true if announcement channel

◆ is_nsfw()

bool dpp::channel::is_nsfw ( ) const

Returns true if the channel is NSFW gated.

Returns: true if NSFW

◆ is_pinned_thread()

bool dpp::channel::is_pinned_thread ( ) const

Returns true if channel is a pinned thread in forum.

Returns: true, if channel is a pinned thread in forum

◆ is_stage_channel()

bool dpp::channel::is_stage_channel ( ) const

Returns true if the channel is a stage channel.

Returns: true if stage channel

◆ is_store_channel()

bool dpp::channel::is_store_channel ( ) const

Returns true if the channel is a store channel.

Deprecated:: store channels are deprecated by Discord

Returns: true if store channel

◆ is_tag_required()

bool dpp::channel::is_tag_required ( ) const

Returns true if a tag is required to be specified when creating a thread in a forum channel.

Returns: true, if a tag is required to be specified when creating a thread in a forum channel

◆ is_text_channel()

bool dpp::channel::is_text_channel ( ) const

Returns true if the channel is a text channel.

Returns: true if text channel

◆ is_video_720p()

bool dpp::channel::is_video_720p ( ) const

Returns true if video quality is 720p.

Returns: true if video quality is 720p

◆ is_video_auto()

bool dpp::channel::is_video_auto ( ) const

Returns true if video quality is auto.

Returns: true if video quality is auto

◆ is_voice_channel()

bool dpp::channel::is_voice_channel ( ) const

Returns true if the channel is a voice channel.

Returns: true if voice channel

◆ operator!=()

bool dpp::managed::operator!= ( const managed & other ) const

noexceptinherited

Comparison operator for comparing two managed objects by id.

Parameters

other Other object to compare against

Returns: true objects are not the same id; false objects are the same id

◆ operator==()

bool dpp::managed::operator== ( const managed & other ) const

noexceptinherited

Comparison operator for comparing two managed objects by id.

Parameters

other Other object to compare against

Returns: true objects are the same id; false objects are not the same id

◆ remove_flag()

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

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

Parameters

flag	Flag bit to remove from dpp::channel_flags

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

◆ set_bitrate()

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

Set bitrate of this channel object.

Parameters

bitrate Bitrate to set (in kilobits)

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

◆ set_default_forum_layout()

channel & dpp::channel::set_default_forum_layout ( forum_layout_type layout_type )

Set the default forum layout type for the forum channel.

Parameters

layout_type The layout type

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

◆ set_default_sort_order()

channel & dpp::channel::set_default_sort_order ( default_forum_sort_order_t sort_order )

Set the default forum sort order for the forum channel.

Parameters

sort_order The sort order

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

◆ set_flags()

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

Set flags for this channel object.

Parameters

flags Flag bitmask to set from dpp::channel_flags

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

◆ set_guild_id()

channel & dpp::channel::set_guild_id ( const snowflake guild_id )

Set guild_id of this channel object.

Parameters

guild_id Guild ID to set

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

◆ set_lock_permissions()

channel & dpp::channel::set_lock_permissions ( const bool is_lock_permissions )

Set lock permissions property of this channel object Used only with the reorder channels method.

Parameters

is_lock_permissions true, if we are to inherit permissions from the category

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

◆ set_name()

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

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 )

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 )

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 )

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 )

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 )

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_type()

channel & dpp::channel::set_type ( channel_type type )

Set type of this channel object.

Parameters

type	Channel type to set

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

◆ set_user_limit()

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

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

◆ available_tags

std::vector<forum_tag> dpp::channel::available_tags

A set of tags that can be used in a forum channel

◆ bitrate

uint16_t dpp::channel::bitrate

the bitrate (in kilobits) of the voice channel

◆ default_auto_archive_duration

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

◆ default_reaction

std::variant<std::monostate, snowflake, std::string> dpp::channel::default_reaction

The emoji to show as the default reaction button on a forum post. Contains either nothing, the id of a guild's custom emoji or the unicode character of the emoji.

◆ default_sort_order

default_forum_sort_order_t dpp::channel::default_sort_order

the default sort order type used to order posts in forum channels

◆ default_thread_rate_limit_per_user

uint16_t dpp::channel::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

◆ flags

uint16_t dpp::channel::flags

Flags bitmap (dpp::channel_flags)

◆ guild_id

snowflake dpp::channel::guild_id

Guild id of the guild that owns the channel

◆ icon

utility::iconhash dpp::channel::icon

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

ID of last message to be sent to the channel (may not point to an existing or valid message or thread)

◆ last_pin_timestamp

time_t dpp::channel::last_pin_timestamp

Timestamp of last pinned message

◆ name

std::string dpp::channel::name

Channel name (1-100 characters)

◆ owner_id

snowflake dpp::channel::owner_id

User ID of the creator for group DMs or threads

◆ parent_id

snowflake dpp::channel::parent_id

Parent ID (for guild channels: id of the parent category, for threads: id of the text channel this thread was created)

◆ permission_overwrites

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

Permission overwrites to apply to base permissions

◆ permissions

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

◆ position

uint16_t dpp::channel::position

Sorting position, lower number means higher up the list

◆ rate_limit_per_user

uint16_t dpp::channel::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

◆ recipients

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

DM recipients

◆ rtc_region

std::string dpp::channel::rtc_region

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

◆ topic

std::string dpp::channel::topic

Channel topic (0-4096 characters for forum channels, 0-1024 characters for all others)

◆ user_limit

uint8_t dpp::channel::user_limit

Maximum user limit for voice channels (0-99)

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ channel()

◆ ~channel()

Member Function Documentation

◆ add_flag()

◆ add_permission_overwrite()

◆ build_json()

◆ fill_from_json()

◆ get_creation_time()

◆ get_default_forum_layout()

◆ get_icon_url()

◆ get_members()

◆ get_mention() [1/2]

◆ get_mention() [2/2]

◆ get_type()

◆ get_user_permissions() [1/2]

◆ get_user_permissions() [2/2]

◆ get_voice_members()

◆ is_category()

◆ is_dm()

◆ is_forum()

◆ is_group_dm()

◆ is_locked_permissions()

◆ is_news_channel()

◆ is_nsfw()

◆ is_pinned_thread()

◆ is_stage_channel()

◆ is_store_channel()

◆ is_tag_required()

◆ is_text_channel()

◆ is_video_720p()

◆ is_video_auto()

◆ is_voice_channel()

◆ operator!=()

◆ operator==()

◆ remove_flag()

◆ set_bitrate()

◆ set_default_forum_layout()

◆ set_default_sort_order()

◆ set_flags()

◆ set_guild_id()

◆ set_lock_permissions()

◆ set_name()

◆ set_nsfw()

◆ set_parent_id()

◆ set_position()

◆ set_rate_limit_per_user()

◆ set_topic()

◆ set_type()

◆ set_user_limit()

Member Data Documentation

◆ available_tags

◆ bitrate

◆ default_auto_archive_duration

◆ default_reaction

◆ default_sort_order

◆ default_thread_rate_limit_per_user

◆ flags

◆ guild_id

◆ icon

◆ id

◆ last_message_id

◆ last_pin_timestamp

◆ name

◆ owner_id

◆ parent_id

◆ permission_overwrites

◆ permissions

◆ position

◆ rate_limit_per_user

◆ recipients

◆ rtc_region

◆ topic

◆ user_limit